Microservices Engine:Connect through an SDK (Java/Go/Python applications)

Java

Golang

1. Environment configuration: Run the following command to pull the Go version of the XXL-JOB software development kit (SDK) using the latest tag. For the specific version, see xxl-job-executor-go.

   go get github.com/xxl-job/xxl-job-executor-go@{latest_tag}

2. Write the code to initialize the executor.

   package main
   
   import (
       "context"
       "fmt"
       xxl "github.com/xxl-job/xxl-job-executor-go"
       "github.com/xxl-job/xxl-job-executor-go/example/task"
       "log"
   )
   
   func main() {
       exec := xxl.NewExecutor(
           xxl.ServerAddr("xxxxxx"),       // Request address. Obtain this from the connection configuration in the console.
           xxl.AccessToken("xxxxxxx"),     // Request token. Obtain this from the connection configuration in the console.
           xxl.ExecutorPort("9999"),       // Default is 9999. This parameter is optional.
           xxl.RegistryKey("golang-jobs"), // Executor name
           xxl.SetLogger(&logger{}),       // Custom logger
       )
       exec.Init()
       exec.Use(customMiddleware)
       // Set the log view handler
       exec.LogHandler(customLogHandle)
       // Register the task handler
       exec.RegTask("task.test", task.Test)
       exec.RegTask("task.shardingTest", task.ShardingTest)
       log.Fatal(exec.Run())
   }
   
   // Custom log handler
   func customLogHandle(req *xxl.LogReq) *xxl.LogRes {
       return &xxl.LogRes{Code: xxl.SuccessCode, Msg: "", Content: xxl.LogResContent{
           FromLineNum: req.FromLineNum,
           ToLineNum:   2,
           LogContent:  "This is a custom log handler",
           IsEnd:       true,
       }}
   }
   
   // Implementation of the xxl.Logger interface
   type logger struct{}
   
   func (l *logger) Info(format string, a ...interface{}) {
       fmt.Println(fmt.Sprintf("Custom log - "+format, a...))
   }
   
   func (l *logger) Error(format string, a ...interface{}) {
       log.Println(fmt.Sprintf("Custom log - "+format, a...))
   }
   
   // Custom middleware
   func customMiddleware(tf xxl.TaskFunc) xxl.TaskFunc {
       return func(cxt context.Context, param *xxl.RunReq) string {
           log.Println("I am a middleware start")
           res := tf(cxt, param)
           log.Println("I am a middleware end")
           return res
       }
   }

3. Write the task execution code.

   package task
   
   import (
   	"context"
   	"fmt"
   	xxl "github.com/xxl-job/xxl-job-executor-go"
   )
   
   func Test(cxt context.Context, param *xxl.RunReq) (msg string) {
   	fmt.Println("test one task" + param.ExecutorHandler + " param: " + param.ExecutorParams + " log_id:" + xxl.Int64ToStr(param.LogID))
   	return "test done"
   }
   
   func ShardingTest(cxt context.Context, param *xxl.RunReq) (msg string) {
   	fmt.Println("shardingId:" + xxl.Int64ToStr(param.BroadcastIndex) + ", shardingTotal:" + xxl.Int64ToStr(param.BroadcastTotal))
   	return "ShardingTest done"
   }

Python

1. Pull the dependencies. For the specific version, see xxl-job-executor-python.

   pip install pyxxl
   
   # If logs need to be written to Redis
   pip install "pyxxl[redis]"
   
   # To load configurations from .env
   pip install "pyxxl[dotenv]"
   
   # Install all features
   pip install "pyxxl[all]"

2. Write the task execution code.

   import asyncio
   import time
   
   from pyxxl import ExecutorConfig, PyxxlRunner
   from pyxxl.ctx import g
   
   config = ExecutorConfig(
       xxl_admin_baseurl="http://xxljob-1b3fd81****.schedulerx.mse.aliyuncs.com/api/",
       executor_app_name="xueren-test",
       access_token="default_token",
       # If xxl-admin can directly connect to the executor's IP, you do not need to specify executor_listen_host.
   )
   
   app = PyxxlRunner(config)
   
   
   @app.register(name="demoJobHandler")
   async def test_task():
       # you can get task params with "g"
       g.logger.info("get executor params: %s" % g.xxl_run_data.executorParams)
       for i in range(10):
           g.logger.warning("test logger %s" % i)
       await asyncio.sleep(5)
       return "Success..."
   
   @app.register(name="sync_func")
   def test_task4():
       # To view execution logs on xxl-admin, you must use g.logger for logging. By default, only logs of level INFO and higher are printed.
       n = 1
       g.logger.info("Job %s get executor params: %s" % (g.xxl_run_data.jobId, g.xxl_run_data.executorParams))
       # If a sync task contains a loop, you must check g.cancel_event in each iteration to support the cancel operation.
       while n <= 10 and not g.cancel_event.is_set():
           # If you do not need to view logs from xxl-admin, you can use your own logger.
           g.logger.info(
               "log to {} logger test_task4.{},params:{}".format(
                   g.xxl_run_data.jobId,
                   n,
                   g.xxl_run_data.executorParams,
               )
           )
           time.sleep(2)
           n += 1
       return "Success3"
   
   
   if __name__ == "__main__":
       app.run_executor()