Leprechaun - Golang任务调度插件使用指南

Leprechaun是一个轻量级的Golang任务调度库，支持Webhook、Cron定时任务和经典调度。下面我将详细介绍它的使用方法。

安装Leprechaun

go get github.com/kilgaloon/leprechaun

基本使用示例

1. 创建调度器实例

package main

import (
	"github.com/kilgaloon/leprechaun/daemon"
	"github.com/kilgaloon/leprechaun/worker"
)

func main() {
	// 创建配置
	cfg := daemon.NewConfig(".")
	
	// 创建调度器实例
	scheduler := worker.New(cfg)
	
	// 启动调度器
	scheduler.Start()
	
	// 保持程序运行
	select {}
}

Webhook任务调度

2. 注册Webhook任务

func setupWebhookTasks(scheduler *worker.Worker) {
	// 定义一个简单的Webhook处理器
	handler := func(ctx *worker.Context) {
		// 获取请求参数
		name := ctx.GetRequest().GetFormValue("name")
		
		// 处理逻辑
		ctx.GetResponse().SetBody(fmt.Sprintf("Hello, %s!", name))
		
		// 记录日志
		ctx.GetLogger().Info("Webhook任务执行完成")
	}
	
	// 注册Webhook路由
	scheduler.RegisterWebhook("greet", "/greet", handler)
}

Cron定时任务

3. 注册Cron任务

func setupCronTasks(scheduler *worker.Worker) {
	// 定义一个Cron任务
	task := func() {
		scheduler.GetLogger().Info("Cron任务执行: 每30秒一次")
	}
	
	// 添加Cron任务
	err := scheduler.AddCronJob("example_cron", "*/30 * * * * *", task)
	if err != nil {
		scheduler.GetLogger().Errorf("添加Cron任务失败: %v", err)
	}
}

经典调度任务

4. 注册经典调度任务

func setupClassicTasks(scheduler *worker.Worker) {
	// 定义一个经典任务
	task := func() {
		scheduler.GetLogger().Info("经典任务执行")
	}
	
	// 添加立即执行的任务
	scheduler.AddJob("immediate_job", task)
	
	// 添加延迟执行的任务(5秒后)
	scheduler.AddJobWithDelay("delayed_job", 5*time.Second, task)
	
	// 添加周期性任务(每10秒执行一次)
	scheduler.AddRecurringJob("recurring_job", 10*time.Second, task)
}

完整示例

package main

import (
	"fmt"
	"time"
	
	"github.com/kilgaloon/leprechaun/daemon"
	"github.com/kilgaloon/leprechaun/worker"
)

func main() {
	// 1. 创建配置和调度器
	cfg := daemon.NewConfig(".")
	scheduler := worker.New(cfg)
	
	// 2. 设置各种任务
	setupWebhookTasks(scheduler)
	setupCronTasks(scheduler)
	setupClassicTasks(scheduler)
	
	// 3. 启动调度器
	scheduler.Start()
	
	// 4. 保持程序运行
	select {}
}

func setupWebhookTasks(s *worker.Worker) {
	handler := func(ctx *worker.Context) {
		name := ctx.GetRequest().GetFormValue("name")
		ctx.GetResponse().SetBody(fmt.Sprintf("Hello, %s!", name))
		ctx.GetLogger().Info("Webhook任务执行完成")
	}
	s.RegisterWebhook("greet", "/greet", handler)
}

func setupCronTasks(s *worker.Worker) {
	task := func() {
		s.GetLogger().Info("Cron任务执行: 每30秒一次")
	}
	if err := s.AddCronJob("example_cron", "*/30 * * * * *", task); err != nil {
		s.GetLogger().Errorf("添加Cron任务失败: %v", err)
	}
}

func setupClassicTasks(s *worker.Worker) {
	task := func() {
		s.GetLogger().Info("经典任务执行")
	}
	s.AddJob("immediate_job", task)
	s.AddJobWithDelay("delayed_job", 5*time.Second, task)
	s.AddRecurringJob("recurring_job", 10*time.Second, task)
}

高级功能

5. 配置文件

Leprechaun支持通过配置文件进行配置。创建configs/configuration.ini文件：

[server]
host = 127.0.0.1
port = 8080
workers = 10

[settings]
debug = true

6. 任务监控

// 获取所有任务状态
jobs := scheduler.GetJobs()
for name, job := range jobs {
	fmt.Printf("任务名称: %s, 状态: %s\n", name, job.GetStatus())
}

// 停止特定任务
scheduler.StopJob("recurring_job")

// 重新启动任务
scheduler.StartJob("recurring_job")

注意事项

1. Leprechaun的Cron表达式支持秒级精度(6位)，格式为: 秒 分 时 日 月 周
2. Webhook默认监听在8080端口，可在配置中修改
3. 任务执行日志会自动记录
4. 对于长时间运行的任务，建议使用context处理取消逻辑

希望这个指南能帮助你快速上手Leprechaun任务调度插件！