go-zero 框架集成定时任务的核心做法是在 go-zero 的配置文件(如 etc/config.yaml)中配置 crontab 字段,并在代码中通过 core.cronjob 接口实现具体的业务逻辑。具体而言,你需要定义一个实现了 run() 方法的 struct,然后在 main.go 中使用 core.startcronjob 启动该任务,或者在微服务架构中利用 svc.servicecontext 注入依赖后启动。这样做可以让 go-zero 自动管理任务的调度、并发控制以及优雅停机。

Crontab 配置文件的结构是怎样的
在 Go-Zero 项目中,定时任务的配置通常位于 etc/your-service.yaml 文件中。配置项名为 crontab,其值是一个列表,每个元素包含 Spec(Cron 表达式)和 Jobs(任务名称列表)。这种结构允许你为不同的 Cron 表达式指定一组需要执行的任务,或者为同一个任务配置多个触发时间。Go-Zero 的配置加载机制会自动将这些 YAML 数据映射到结构体中,供运行时使用。

package main
import (
"flag"
"fmt"
"log"
"time"
"github.com/zeromicro/go-zero/core/cron"
"github.com/zeromicro/go-zero/core/logx"
)
// MyTask 定义一个简单的定时任务
type MyTask struct {
name string
}
// Run 是核心方法,必须实现 core.CronJob 接口
func (t *MyTask) Run() {
logx.Infof("[%s] Task executed at %s", t.name, time.Now().Format(time.RFC3339))
// 在这里编写你的业务逻辑,例如清理数据库、发送通知等
}
func main() {
var configFile = flag.String("f", "etc/config.yaml", "the config file")
flag.Parse()
// 1. 创建 Cron 实例
c := cron.NewCron()
// 2. 添加任务
// 注意:这里为了演示,直接硬编码了任务,实际项目中应从配置读取
task := &MyTask{name: "cleanup-task"}
// 假设我们想每5秒执行一次
_, err := c.AddJob("@every 5s", task)
if err != nil {
log.Fatalf("Failed to add job: %v", err)
}
// 3. 启动 Cron
c.Start()
// 保持主进程运行
select {}
}
如何确保任务只在一个节点执行
在分布式部署场景下,如果多个服务实例同时运行相同的定时任务,会导致重复执行和数据冲突。Go-Zero 本身提供的 core.CronJob 是单机版的,要实现分布式锁或单点执行,通常需要结合 Redis 或其他分布式协调组件。一种常见的做法是在 Run() 方法内部先尝试获取分布式锁,只有获取成功的节点才执行业务逻辑。另一种更高级的做法是使用 Go-Zero 的 store 模块配合 Redis 来实现简单的分布式锁机制,或者使用专门的分布式调度系统如 Elastic-Job 或 XXL-JOB,但在轻量级集成中,基于 Redis 的锁是最常用的方案。

package main
import (
"context"
"fmt"
"time"
"github.com/redis/go-redis/v9"
"github.com/zeromicro/go-zero/core/cron"
"github.com/zeromicro/go-zero/core/logx"
)
// DistributedTask 带有分布式锁检查的任务
type DistributedTask struct {
client *redis.Client
lockKey string
}
// Run 实现分布式执行逻辑
func (t *DistributedTask) Run() {
ctx := context.Background()
// 尝试获取分布式锁,设置过期时间为 10 秒,防止死锁
ok, err := t.client.SetNX(ctx, t.lockKey, "locked", 10*time.Second).Result()
if err != nil {
logx.Errorf("Lock error: %v", err)
return
}
if !ok {
// 其他节点正在执行,跳过本次
return
}
defer t.client.Del(ctx, t.lockKey) // 释放锁
logx.Info("Executing distributed task...")
// 执行业务逻辑
}
func main() {
// 初始化 Redis 客户端
client := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
Password: "",
DB: 0,
})
task := &DistributedTask{
client: client,
lockKey: "my-distributed-task-lock",
}
c := cron.NewCron()
c.AddJob("@every 10s", task)
c.Start()
select {}
}
任务执行期间发生异常会怎样处理
当定时任务的 Run() 方法中抛出未捕获的 panic 或返回错误时,Go-Zero 的 cron 模块默认行为是记录日志并继续调度下一次执行,而不会停止整个 Cron 服务。这意味着单个任务的失败不会影响后续任务的触发。然而,如果任务逻辑中包含长时间运行的阻塞操作,可能会导致任务重叠执行。为了避免这种情况,建议在 Run() 方法中使用上下文(context)来控制超时,或者确保任务逻辑是幂等的且执行时间可控。此外,可以通过自定义 Logger 来监控这些异常,以便及时发现和处理问题。











