RiverQueue项目中的定时任务实现详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00501/article/details/148549087

RiverQueue项目中的定时任务实现详解

river Fast and reliable background jobs in Go 项目地址: https://gitcode.com/gh_mirrors/river/river

概述

本文将深入探讨RiverQueue项目中如何实现定时任务功能。通过分析项目中的example_scheduled_job_test.go文件，我们将了解如何在RiverQueue中创建和调度未来执行的作业。

RiverQueue定时任务核心概念

RiverQueue是一个基于PostgreSQL的作业队列系统，它提供了强大的定时任务功能。定时任务允许开发者安排作业在未来特定时间执行，这在许多业务场景中非常有用，如定时报表生成、延迟通知发送等。

定时任务实现解析

1. 定义任务参数结构

首先需要定义一个包含任务参数的结构体，该结构体需要实现Kind()方法：

type ScheduledArgs struct {
    Message string `json:"message"`
}

func (ScheduledArgs) Kind() string { return "scheduled" }

Kind()方法返回的字符串是该类型任务的唯一标识符，在系统中用于区分不同类型的任务。

2. 实现任务处理器

任务处理器负责实际执行任务的逻辑，需要实现river.Worker接口：

type ScheduledWorker struct {
    river.WorkerDefaults[ScheduledArgs]
}

func (w *ScheduledWorker) Work(ctx context.Context, job *river.Job[ScheduledArgs]) error {
    fmt.Printf("Message: %s\n", job.Args.Message)
    return nil
}

WorkerDefaults提供了默认实现，开发者只需专注于Work方法的实现即可。

3. 初始化River客户端

创建River客户端是使用定时任务的前提：

workers := river.NewWorkers()
river.AddWorker(workers, &ScheduledWorker{})

riverClient, err := river.NewClient(riverpgxv5.New(dbPool), &river.Config{
    Logger: slog.New(&slogutil.SlogMessageOnlyHandler{Level: slog.LevelWarn}),
    Queues: map[string]river.QueueConfig{
        river.QueueDefault: {MaxWorkers: 100},
    },
    Schema:   riverdbtest.TestSchema(ctx, testutil.PanicTB(), riverpgxv5.New(dbPool), nil),
    TestOnly: true,
    Workers:  workers,
})

配置中需要注意：

Logger：设置日志处理器
Queues：配置队列参数
Schema：指定数据库schema（测试环境专用）
TestOnly：标记为测试模式（生产环境应移除）

4. 创建定时任务

使用Insert方法并指定ScheduledAt参数来创建定时任务：

_, err = riverClient.Insert(ctx,
    ScheduledArgs{
        Message: "hello from the future",
    },
    &river.InsertOpts{
        ScheduledAt: time.Now().Add(3 * time.Hour),
    })

这里将任务安排在3小时后执行。