任务调度

相关信息

在项目开发中如果需要让程序自动在某个时刻去执行一些命令，就需要使用到任务调度

如何使用

引入依赖 spring-taybct-tool-scheduling

        <!--任务调度-->
        <dependency>
            <groupId>io.github.mangocrisp</groupId>
            <artifactId>spring-taybct-tool-scheduling</artifactId>
        </dependency>

基于 yaml

默认框架的任务调度是基于 yaml/properties 的

你只需要写对应的配置和写任务调度的类就可以实现调度了

taybct:
  scheduled:
    pool-size: 20
    await-termination-seconds: 60
    thread-name-prefix: "Scheduler-"
    wait-for-tasks-to-complete-on-shutdown: true
    tasks:
      clearDirtyData:
        task-key: clearDirtyData
        cron: 0 0/1 * * * ?
        description: "清理权限脏数据"
        auto-start: 1
        sort: 0
        params:
          "params1": 1
          "params2": 2
          "params3": 3
          "params4": 4
      clearExpires:
        task-key: clearExpires
        cron: 0 0/1 * * * ?
        description: "清理登录超时用户"
        auto-start: 1
        sort: 1
      iniPermissionConfig:
        task-key: iniPermissionConfig
        cron: 0 0/1 * * * ?
        description: "初始化权限配置"
        auto-start: 1
        sort: 2

@Component
@RequiredArgsConstructor
@Slf4j
@Scheduler("clearExpires")
public class ClearExpiresTask extends AbstractScheduledTaskJob {

    final ISysUserOnlineService sysUserOnlineService;

    @Override
    public void run(Map<String, Object> params) {
        log.info("ClearExpiresTask => 当前线程名称 {} ", Thread.currentThread().getName());
        log.info(">>>>>> 清理检查在线用户状态开始 >>>>>> ");
        sysUserOnlineService.clearExpires();
        log.info(">>>>>> 清理检查在线用户状态结束 >>>>>> ");
    }

}

基于数据库

这个在模块 spring-taybct-module-scheduling 里面已经写好了，你只需要在 module-scheduling 里面写调度类就可以了

@Component
@RequiredArgsConstructor
@Slf4j
@Scheduler("demo")
public class DemoTask extends AbstractScheduledTaskJob {

    final IScheduledLogService scheduledLogService;

    @Override
    protected Consumer<JSONObject> getLogRecorder() {
        return scheduledLogService::logRecorder;
    }

    @Override
    public void run(Map<String, Object> params) throws Exception {
        log.info("demo task => 当前线程名称 {} ", Thread.currentThread().getName());
        log.info(">>>>>> 测试任务开始 >>>>>> ");
//        stopRecord(OperateStatus.SUCCESS.getCode(), "我自己记录一个消息");
//        throw new RuntimeException("最后个报错");
    }

}

数据库任务调度接口

这个可以直接在 /doc.html 里面查看任务调度模块的接口就可以了

获取分页(带启动状态)，可以查看任务是否已经在启动，然后，有相应的指令去操作任务。

基于其他

...其实原理也还算是简单，你只需要继承 AbstractTaskSupplier 或者 实现 ITaskSupplier，然后实现 ITaskSupplier 的几个接口，就可以自己定义你想怎么去调度

@Scheduler

框架会去找所有加了这个注解的类，来当作任务调度的类，或者是 bean，这个名字，如果不指定，就会默认用 bean 的 name

日志记录

框架提供了基本的日志记录功能，你需要提供一个 Consumer<JSONObject> 来记录日志，一次任务调用完毕，会把调用的记录通过 JSONObject 传给你提供的这个 Consumer

自己定义日志的消息

默认的日志记录只记录，是否执行完毕，你如果需要记录一些其他的消息，可以直接

stopRecord(OperateStatus.SUCCESS.getCode(), "我自己记录一个消息");

但是，注意，这个记录只能写一次，而且，你记录之后，框架就不会再记录