Golang 定时任务执行插件库 cronticker 使用指南

cronticker 是一个轻量级的 Golang 定时任务调度库，它提供了类似 cron 表达式的定时任务执行功能。下面我将详细介绍如何使用这个库。

安装 cronticker

首先需要安装 cronticker 库：

go get github.com/robfig/cron/v3

基本使用方法

1. 创建定时任务

package main

import (
	"fmt"
	"time"
	
	"github.com/robfig/cron/v3"
)

func main() {
	// 创建一个新的cron实例
	c := cron.New()

	// 添加定时任务
	_, err := c.AddFunc("* * * * *", func() {
		fmt.Println("每分钟执行一次:", time.Now().Format("2006-01-02 15:04:05"))
	})
	if err != nil {
		fmt.Println("添加任务失败:", err)
		return
	}

	// 启动cron调度器
	c.Start()

	// 防止主程序退出
	select {}
}

2. cron 表达式格式

cronticker 使用标准的 cron 表达式格式：

* * * * *
| | | | |
| | | | +----- 星期几 (0 - 6) (星期天=0)
| | | +------- 月份 (1 - 12)
| | +--------- 日 (1 - 31)
| +----------- 小时 (0 - 23)
+------------- 分钟 (0 - 59)

3. 常用示例

package main

import (
	"fmt"
	"time"
	
	"github.com/robfig/cron/v3"
)

func main() {
	c := cron.New()

	// 每5分钟执行一次
	c.AddFunc("*/5 * * * *", func() {
		fmt.Println("每5分钟执行:", time.Now().Format("15:04:05"))
	})

	// 每天凌晨1点执行
	c.AddFunc("0 1 * * *", func() {
		fmt.Println("每天凌晨1点执行")
	})

	// 每周一上午9点执行
	c.AddFunc("0 9 * * 1", func() {
		fmt.Println("每周一上午9点执行")
	})

	// 每月1号凌晨0点执行
	c.AddFunc("0 0 1 * *", func() {
		fmt.Println("每月1号凌晨0点执行")
	})

	c.Start()
	select {}
}

高级功能

1. 设置时区

package main

import (
	"fmt"
	"time"
	
	"github.com/robfig/cron/v3"
)

func main() {
	// 使用中国时区
	location, _ := time.LoadLocation("Asia/Shanghai")
	c := cron.New(cron.WithLocation(location))

	c.AddFunc("0 9 * * *", func() {
		fmt.Println("北京时间每天9点执行:", time.Now().Format("15:04:05"))
	})

	c.Start()
	select {}
}

2. 任务日志

package main

import (
	"fmt"
	"log"
	"time"
	
	"github.com/robfig/cron/v3"
)

func main() {
	c := cron.New(
		cron.WithLogger(
			cron.VerbosePrintfLogger(log.New(os.Stdout, "cron: ", log.LstdFlags)),
		),
	)

	c.AddFunc("* * * * *", func() {
		fmt.Println("每分钟执行一次")
	})

	c.Start()
	select {}
}

3. 任务删除

package main

import (
	"fmt"
	"time"
	
	"github.com/robfig/cron/v3"
)

func main() {
	c := cron.New()

	// 添加任务并保存ID
	id, _ := c.AddFunc("* * * * *", func() {
		fmt.Println("每分钟执行一次")
	})

	// 10秒后删除任务
	time.AfterFunc(10*time.Second, func() {
		c.Remove(id)
		fmt.Println("任务已删除")
	})

	c.Start()
	select {}
}

注意事项

1. cronticker 的最小时间粒度是分钟，不支持秒级任务
2. 任务执行是同步的，长时间运行的任务会阻塞后续任务
3. 对于需要并发执行的任务，需要在任务函数内部自行处理

替代方案

如果你需要更复杂的定时任务功能，也可以考虑以下替代方案：

1. github.com/robfig/cron - 功能更全面的 cron 库
2. github.com/jasonlvhit/gocron - 更简单的 API
3. github.com/gorhill/cronexpr - 专注于 cron 表达式解析

希望这个指南能帮助你使用 cronticker 实现 Golang 中的定时任务调度！