db-scheduler 使用教程

项目介绍

db-scheduler 是一个基于数据库的任务调度器，支持持久化任务和周期性任务。它通过单一的数据库表来跟踪未来的任务执行，确保任务在服务器重启后仍然能够执行。db-scheduler 提供了灵活的配置选项和易于使用的 API，适用于需要可靠任务调度的各种应用场景。

项目快速启动

添加 Maven 依赖

首先，在你的项目中添加 db-scheduler 的 Maven 依赖：

<dependency>
    <groupId>com.github.kagkarlsson</groupId>
    <artifactId>db-scheduler</artifactId>
    <version>14.0.3</version>
</dependency>

创建数据库表

在你的数据库中创建 scheduled_tasks 表。以下是 PostgreSQL 的表定义示例：

CREATE TABLE scheduled_tasks (
    task_name VARCHAR(128) NOT NULL,
    task_instance VARCHAR(128) NOT NULL,
    task_data BYTEA,
    execution_time TIMESTAMP WITH TIME ZONE NOT NULL,
    picked BOOLEAN NOT NULL,
    picked_by VARCHAR(50),
    last_success TIMESTAMP WITH TIME ZONE,
    last_failure TIMESTAMP WITH TIME ZONE,
    consecutive_failures INT,
    last_heartbeat TIMESTAMP WITH TIME ZONE,
    version BIGINT NOT NULL,
    PRIMARY KEY (task_name, task_instance)
);

实例化并启动调度器

以下是一个简单的示例，展示如何实例化并启动 db-scheduler：

import com.github.kagkarlsson.scheduler.Scheduler;
import com.github.kagkarlsson.scheduler.task.helper.Tasks;
import com.github.kagkarlsson.scheduler.task.ExecutionContext;
import com.github.kagkarlsson.scheduler.task.TaskInstance;
import com.github.kagkarlsson.scheduler.task.VoidTask;

import javax.sql.DataSource;
import java.time.Duration;

public class SchedulerExample {
    public static void main(String[] args) {
        DataSource dataSource = ... // 初始化你的数据源

        VoidTask hourlyTask = Tasks.recurring("my-hourly-task", Duration.ofHours(1))
            .execute((TaskInstance<Void> taskInstance, ExecutionContext executionContext) -> {
                System.out.println("Executed hourly task");
            });

        final Scheduler scheduler = Scheduler.create(dataSource)
            .startTasks(hourlyTask)
            .threads(5)
            .build();

        scheduler.start();
    }
}

应用案例和最佳实践

动态任务调度

db-scheduler 支持动态创建和调度任务。以下是一个示例，展示如何通过 REST API 动态创建任务：

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class SchedulerController {
    private final Scheduler scheduler;

    public SchedulerController(Scheduler scheduler) {
        this.scheduler = scheduler;
    }

    @PostMapping(path = "/schedule", consumes = "application/json", produces = "application/json")
    public void scheduleTask(@RequestBody TaskRequest taskRequest) {
        scheduler.schedule(
            new OneTimeTask("dynamic-task", taskRequest.getData()),
            Instant.now().plusSeconds(taskRequest.getDelayInSeconds())
        );
    }
}

任务重试和失败处理

db-scheduler 提供了任务重试和失败处理的机制。你可以配置任务在失败后的重试策略，确保任务能够在遇到临时问题时自动重试。

VoidTask retryableTask = Tasks.oneTime("retryable-task")
    .onFailure((taskInstance, executionContext, throwable) -> {
        // 处理失败逻辑
        return RetryPolicy.exponentialBackoff(Duration.ofMinutes(1), 5);
    })
    .execute((taskInstance, executionContext) -> {
        // 任务执行逻辑
    });

典型生态项目

db-scheduler-ui

db-scheduler-ui 是一个用于 db-scheduler 的 UI