SchedulerX Go SDK 使用教程

SchedulerX Go SDK 使用教程

schedulerx-worker-goschedulerx-worker-go is the Golang SDK of SchedulerX项目地址:https://gitcode.com/gh_mirrors/sc/schedulerx-worker-go

项目介绍

SchedulerX 是阿里云提供的分布式任务调度服务，兼容开源的 XXL-JOB、ElasticJob、K8s Job 和 Spring Schedule。它支持 Cron 定时、一次性任务、任务编排和分布式数据处理，具有高可用、可视化、可运维和低延时等能力。schedulerx-worker-go 是 SchedulerX 的 Go 版本 SDK，由高德贡献，支持单机任务和广播任务。

项目快速启动

安装 SDK

首先，使用以下命令安装 schedulerx-worker-go SDK：

go get github.com/alibaba/schedulerx-worker-go@latest

编写业务代码

实现 Processor 接口，编写业务逻辑代码。以下是一个简单的示例：

package main

import (
    "fmt"
    "github.com/alibaba/schedulerx-worker-go/processor"
    "github.com/alibaba/schedulerx-worker-go/processor/jobcontext"
    "strconv"
)

type TestJob struct{}

func (tj *TestJob) Process(jobCtx *jobcontext.JobContext) (*processor.ProcessResult, error) {
    num, err := strconv.Atoi(jobCtx.JobParameters())
    if err != nil {
        return nil, err
    }
    fmt.Println("Processing job with parameter:", num)
    return &processor.ProcessResult{Status: processor.Success}, nil
}

func main() {
    processor.RegisterJobProcessor("testJob", &TestJob{})
    processor.Start()
}

运行应用

编译并运行你的 Go 应用：

go run main.go

应用案例和最佳实践

单机任务

单机任务适用于不需要分布式处理的场景，例如定时清理日志文件。以下是一个单机任务的示例：

type LogCleaner struct{}

func (lc *LogCleaner) Process(jobCtx *jobcontext.JobContext) (*processor.ProcessResult, error) {
    fmt.Println("Cleaning log files...")
    // 实现日志清理逻辑
    return &processor.ProcessResult{Status: processor.Success}, nil
}

广播任务

广播任务适用于需要在所有节点上执行的场景，例如全局配置更新。以下是一个广播任务的示例：

type ConfigUpdater struct{}

func (cu *ConfigUpdater) Process(jobCtx *jobcontext.JobContext) (*processor.ProcessResult, error) {
    fmt.Println("Updating global configuration...")
    // 实现配置更新逻辑
    return &processor.ProcessResult{Status: processor.Success}, nil
}

典型生态项目

与 Kubernetes 集成

SchedulerX 可以与 Kubernetes 集成，实现更复杂的任务调度和管理。以下是一个简单的集成示例：

apiVersion: batch/v1
kind: Job
metadata:
  name: schedulerx-job
spec:
  template:
    spec:
      containers:
      - name: schedulerx-worker
        image: your-schedulerx-worker-image
        command: ["/app/schedulerx-worker"]
      restartPolicy: OnFailure

与 Spring Boot 集成

SchedulerX 也可以与 Spring Boot 集成，实现 Java 和 Go 应用的统一任务调度。以下是一个简单的集成示例：

@SpringBootApplication
public class SchedulerxApplication {
    public static void main(String[] args) {
        SpringApplication.run(SchedulerxApplication.class, args);
    }
}

@Component
public class SchedulerxConfig {
    @Bean
    public SchedulerxClient schedulerxClient() {
        SchedulerxClient client = new SchedulerxClient();
        client.setEndpoint("your-schedulerx-endpoint");
        client.setNamespace("your-namespace");
        client.setGroupId("your-group-id");
        client.setAppKey("your-app-key");
        return client;
    }
}

通过以上步骤，你可以快速启动并使用 schedulerx-worker-go SDK，实现高效的分布式任务调度。

schedulerx-worker-goschedulerx-worker-go is the Golang SDK of SchedulerX项目地址:https://gitcode.com/gh_mirrors/sc/schedulerx-worker-go