Golang 数据库作业调度插件库 cdule 使用指南

cdule 是一个基于 Golang 的轻量级数据库作业调度库，它支持将作业信息存储在数据库中，并提供调度执行功能。下面我将介绍 cdule 的基本使用方法和示例代码。

安装 cdule

首先使用 go get 安装 cdule：

go get github.com/rohanthewiz/cdule

基本使用示例

1. 初始化 cdule

package main

import (
	"log"
	"github.com/rohanthewiz/cdule"
	"github.com/rohanthewiz/cdule/repository"
	"gorm.io/driver/postgres"
	"gorm.io/gorm"
)

func main() {
	// 初始化数据库连接
	dsn := "host=localhost user=postgres password=postgres dbname=cdule port=5432 sslmode=disable"
	db, err := gorm.Open(postgres.Open(dsn), &gorm.Config{})
	if err != nil {
		log.Fatalf("Failed to connect to database: %v", err)
	}

	// 初始化 cdule 存储库
	repo, err := repository.NewCduleRepository(db)
	if err != nil {
		log.Fatalf("Failed to initialize cdule repository: %v", err)
	}

	// 创建 cdule 实例
	cduleInstance := cdule.NewCdule(repo)
	
	// 启动 cdule
	err = cduleInstance.Run()
	if err != nil {
		log.Fatalf("Failed to start cdule: %v", err)
	}
	
	// 在这里可以添加作业和调度...
}

2. 定义和注册作业

首先定义一个作业处理器：

type MyJob struct {
	Name string
}

func (j *MyJob) Execute() error {
	log.Printf("Executing job: %s", j.Name)
	// 这里实现你的作业逻辑
	return nil
}

然后注册作业：

// 注册作业处理器
cduleInstance.RegisterJob("my_job_type", func() (cdule.Job, error) {
	return &MyJob{Name: "Example Job"}, nil
})

// 创建作业
job := &model.Job{
	Name:        "example_job",
	JobType:     "my_job_type",
	Description: "This is an example job",
}

// 创建调度
schedule := &model.Schedule{
	JobName:      "example_job",
	CronSchedule: "*/5 * * * *", // 每5分钟执行一次
}

// 将作业和调度添加到 cdule
err = cduleInstance.AddJob(job)
if err != nil {
	log.Printf("Failed to add job: %v", err)
}

err = cduleInstance.AddSchedule(schedule)
if err != nil {
	log.Printf("Failed to add schedule: %v", err)
}

3. 完整示例

package main

import (
	"log"
	"time"
	
	"github.com/rohanthewiz/cdule"
	"github.com/rohanthewiz/cdule/model"
	"github.com/rohanthewiz/cdule/repository"
	"gorm.io/driver/postgres"
	"gorm.io/gorm"
)

// 定义作业处理器
type EmailJob struct {
	Recipient string
	Subject   string
}

func (j *EmailJob) Execute() error {
	log.Printf("Sending email to %s with subject: %s", j.Recipient, j.Subject)
	// 这里实现发送邮件的逻辑
	return nil
}

func main() {
	// 初始化数据库连接
	dsn := "host=localhost user=postgres password=postgres dbname=cdule port=5432 sslmode=disable"
	db, err := gorm.Open(postgres.Open(dsn), &gorm.Config{})
	if err != nil {
		log.Fatalf("Failed to connect to database: %v", err)
	}

	// 自动迁移表结构
	err = db.AutoMigrate(&model.Job{}, &model.Schedule{})
	if err != nil {
		log.Fatalf("Failed to migrate tables: %v", err)
	}

	// 初始化 cdule 存储库
	repo, err := repository.NewCduleRepository(db)
	if err != nil {
		log.Fatalf("Failed to initialize cdule repository: %v", err)
	}

	// 创建 cdule 实例
	cduleInstance := cdule.NewCdule(repo)
	
	// 注册作业处理器
	cduleInstance.RegisterJob("email_job", func() (cdule.Job, error) {
		return &EmailJob{
			Recipient: "user@example.com",
			Subject:   "Daily Report",
		}, nil
	})

	// 创建作业
	job := &model.Job{
		Name:        "daily_email_report",
		JobType:     "email_job",
		Description: "Send daily report email",
	}

	// 创建调度
	schedule := &model.Schedule{
		JobName:      "daily_email_report",
		CronSchedule: "0 9 * * *", // 每天上午9点执行
	}

	// 添加作业和调度
	err = cduleInstance.AddJob(job)
	if err != nil {
		log.Printf("Failed to add job: %v", err)
	}

	err = cduleInstance.AddSchedule(schedule)
	if err != nil {
		log.Printf("Failed to add schedule: %v", err)
	}

	// 启动 cdule
	err = cduleInstance.Run()
	if err != nil {
		log.Fatalf("Failed to start cdule: %v", err)
	}

	// 保持程序运行
	select {}
}

主要功能

1. 基于数据库的作业存储：所有作业和调度信息都存储在数据库中
2. Cron 表达式支持：使用标准的 cron 表达式定义调度
3. 自定义作业类型：可以注册任意类型的作业处理器
4. 并发安全：支持并发作业执行

注意事项

1. 确保数据库连接正常
2. 作业处理器需要实现 cdule.Job 接口
3. 调度使用标准 cron 表达式格式
4. 生产环境中需要考虑错误处理和作业重试机制

cdule 是一个轻量级的解决方案，适合需要将调度信息持久化到数据库的简单场景。对于更复杂的企业级调度需求，可以考虑使用更成熟的解决方案如 Apache Airflow 等。