init

.gitignore

@@ -0,0 +1,2 @@
+
+go.sum

README.md

@@ -1,2 +1,46 @@
-# xxl-job-executor
-与xxl-job-executor的集成
+# xxl-job-executor的gin中间件
+## 背景
+xxl-job-executor-go是xxl-job的golang执行器，可以独立运行，有时候我们要与项目或者框架（如:gin框架）集成起来合并为一个服务，本项目因此而生。
+## 执行器项目地址
+https://github.com/xxl-job/xxl-job-executor-go
+## 与gin集成示例
+```go
+package main
+
+import (
+	"github.com/gin-gonic/gin"
+	"github.com/gin-middleware/xxl-job-executor"
+	"github.com/xxl-job/xxl-job-executor-go"
+	"github.com/xxl-job/xxl-job-executor-go/example/task"
+	"log"
+)
+
+const Port = "9999"
+
+func main() {
+	//初始化执行器
+	exec := xxl.NewExecutor(
+		xxl.ServerAddr("http://127.0.0.1/xxl-job-admin"),
+		xxl.AccessToken(""),            //请求令牌(默认为空)
+		xxl.ExecutorIp("127.0.0.1"),    //可自动获取
+		xxl.ExecutorPort(Port),         //默认9999（此处要与gin服务启动port必需一至）
+		xxl.RegistryKey("golang-jobs"), //执行器名称
+	)
+	exec.Init()
+	//添加到gin路由
+	r := gin.Default()
+	xxl_job_executor_gin.XxlJobMux(r, exec)
+
+	//注册gin的handler
+	r.GET("ping", func(cxt *gin.Context) {
+		cxt.JSON(200, "pong")
+	})
+
+	//注册任务handler
+	exec.RegTask("task.test", task.Test)
+	exec.RegTask("task.test2", task.Test2)
+	exec.RegTask("task.panic", task.Panic)
+
+	log.Fatal(r.Run(":" + Port))
+}
+```

example/main.go

@@ -0,0 +1,38 @@
+package main
+
+import (
+	"github.com/gin-gonic/gin"
+	"github.com/gin-middleware/xxl-job-executor"
+	"github.com/xxl-job/xxl-job-executor-go"
+	"github.com/xxl-job/xxl-job-executor-go/example/task"
+	"log"
+)
+
+const Port = "9999"
+
+func main() {
+	//初始化执行器
+	exec := xxl.NewExecutor(
+		xxl.ServerAddr("http://127.0.0.1/xxl-job-admin"),
+		xxl.AccessToken(""),            //请求令牌(默认为空)
+		xxl.ExecutorIp("127.0.0.1"),    //可自动获取
+		xxl.ExecutorPort(Port),         //默认9999（此处要与gin服务启动port必需一至）
+		xxl.RegistryKey("golang-jobs"), //执行器名称
+	)
+	exec.Init()
+	//添加到gin路由
+	r := gin.Default()
+	xxl_job_executor_gin.XxlJobMux(r, exec)
+
+	//注册gin的handler
+	r.GET("ping", func(cxt *gin.Context) {
+		cxt.JSON(200, "pong")
+	})
+
+	//注册任务handler
+	exec.RegTask("task.test", task.Test)
+	exec.RegTask("task.test2", task.Test2)
+	exec.RegTask("task.panic", task.Panic)
+
+	log.Fatal(r.Run(":" + Port))
+}

go.mod

@@ -0,0 +1,8 @@
+module github.com/gin-middleware/xxl-job-executor
+
+go 1.14
+
+require (
+	github.com/gin-gonic/gin v1.6.3
+	github.com/xxl-job/xxl-job-executor-go v0.4.0
+)

middleware.go

@@ -0,0 +1,13 @@
+package xxl_job_executor_gin
+
+import (
+	"github.com/gin-gonic/gin"
+	"github.com/xxl-job/xxl-job-executor-go"
+)
+
+func XxlJobMux(e *gin.Engine, exec xxl.Executor) {
+	//注册的gin的路由
+	e.POST("run", gin.WrapF(exec.RunTask))
+	e.POST("kill", gin.WrapF(exec.KillTask))
+	e.POST("log", gin.WrapF(exec.TaskLog))
+}