1. 概述

在新设计的架构中有定时任务或者说是计划任务的需求。我想从如下选项中选择

其实现在设计的架构针对的是一些不是太大规模的应用，定时任务也就不会特别巨大。为了节省资源，所以先直接使用最简单的方案 Spring @Scheduled 。

2. 设计目标

• 轻量级，直接集成到项目
• 注解方式完成
• 支持cron表达式
• 支持多实例部署时不重复执行计划任务

3. Spring @Scheduled基本应用介绍

示例中都是基于Springboot2.4.3的
一旦相关类创建后，计划任务管理器会跟着程序的启动自动启动

3.1 首先是基本配置

因为引入springboot就自带了，所以不需要单独在引入依赖。本来直接建立一个config类，标注@EnableScheduling就可以开启计划任务。但考虑到计划任务使用线程池，为了保证资源使用有边界，所以在这里特意自定义了线程池。

SchedulingConfig.java

 // 省略掉了包名和引入

/**
 * spring boot 自带的计划任务
 */
@Configuration
@EnableScheduling
public class SchedulingConfig implements SchedulingConfigurer {

    private int corePoolSize = 5;
    private int maxPoolSize = 10;
    private int queueCapacity = 5;

    /**
     * 自己建立线程池防止资源使用无边界问题
     * @return
     */
    @Bean(destroyMethod="shutdown")
    public Executor taskExecutor() {
        return Executors.newScheduledThreadPool(100);
    }

    /**
     * 设置线程池
     * @param taskRegistrar
     */
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        taskRegistrar.setScheduler(taskExecutor());
    }
}

  

3.2 基本使用

固定延迟时间的任务使用方法

相同方法会在上一个任务执行完后，再延时指定的时间执行

     @Scheduled(fixedDelay = 1000)
    public void scheduleFixedDelayTask() {
        DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern("yyyy年MM月dd日 HH:mm:ss");
        LocalDateTime localDateTime = LocalDateTime.now();
        String dateString = dateTimeFormatter.format(localDateTime);
        System.out.println("固定延迟时间的任务 - " + dateString);
    }
  

固定频率任务执行使用方法

默认也是在上一个任务完成的情况下才会执行的，所以下面这个例子耗时2秒，也就不能按照真正的1秒的频率执行了。解决方案是使用异步注解。稍后会有示例

     @Scheduled(fixedRate = 1000)
    public void scheduleFixedRateTask() {
        // 让我们来测试一下每次任务都超时的情况下
        try {
            TimeUnit.SECONDS.sleep(2);
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
        System.out.println(
                "固定频率的任务 - " + System.currentTimeMillis() / 1000);
    }
  

在指定延迟时间后执行的固定频率任务

     @Scheduled(fixedDelay = 1000, initialDelay = 1000)
    public void scheduleFixedRateWithInitialDelayTask() {
        long now = System.currentTimeMillis() / 1000;
        System.out.println(
                "在指定延迟时间后执行的固定频率任务 - " + now);
    }
  

根据cron表达式确定时间执行

可指定cron表达式和时区。运行下面的例子可以证明多个注解放在一个方法上，实际会启动多个任务

     @Scheduled(cron = "0 35 14 * * ?", zone = "Asia/Shanghai")
    @Scheduled(cron = "*/5 * * * * ?", zone = "Asia/Shanghai")
    @Scheduled(cron = "*/5 * * * * ?")
    public void scheduleTaskUsingCronExpression() {
        long now = System.currentTimeMillis() / 1000;
        System.out.println(
                "使用cron表达式的定时任务 - " + now);
    }
  

在配置文件中配置crontab表达式

下例子中的$是在application.yml（或者自己定义的prifile文件）中配置的。
这点是我比较喜欢的，生产环境不方便重新编译的情况下，可用

     @Scheduled(cron = "${cron.expression}")
    public void scheduleTaskUsingCronExpressionWithProperty() {
        long now = System.currentTimeMillis() / 1000;
        System.out.println(
                "使用cron表达式的定时任务(配置文件指定时间) - " + now);
    }
  

最后说真正的实现固定频率执行任务的配置方式

需要在类上加上@EnableAsync，在方法上加上@Async。
不过注意资源消耗，请谨慎使用

DemoAsyncTasks.java

 //package and import abort

/**
 * 异步执行任务，能真正实现按频率执行 关键在@EnableAsync注解的使用
 */
@EnableAsync
@Component
public class DemoAsyncTasks {

    /**
     * 此种任务适合确保间隔时间内完成的，否则会消耗大量的资源（线程资源）和出现Out of Memory exception
     * 任务执行结果类似如下
     * <pre>
     * 固定频率异步执行的任务 - 1615357318
     * 固定频率异步执行的任务 - 1615357319
     * 固定频率异步执行的任务 - 1615357320
     * 固定频率异步执行的任务 - 1615357321
     * 固定频率异步执行的任务 - 1615357322
     * </pre>
     */
    @Async
    @Scheduled(fixedRate = 1000)
    @UniqueExecutionLock(timeout = 5) // 这个将是下篇文章介绍的多实例唯一执行锁，本期测试的话可直接删除
    public void scheduleFixedRateTaskAsync() throws InterruptedException {
        System.out.println(
                "固定频率异步执行的任务 - " + System.currentTimeMillis() / 1000);
        Thread.sleep(2000);
    }

}  

4. 多实例部署防止重复执行的方案

在自写的架构中，是通过锁使整个计划任务管理器只在单个实例中运行实现的。优点是容易查问题，缺点是不能随机分布到各个节点运行。

现在使用Springboot @Scheduled的方案决定用单个任务的同步锁来实现。简单来说就是：

• 多实例部署时，每个实例的计划任务都启动；
• 在每个计划任务在执行前先获取锁
• 获取到锁的执行，获取不到锁的跳过执行

而实现获取锁的方式可以用数据库mysql的记录版本控制或者redis缓存来实现。

我暂时计划用redis来实现。主要用到redis的”set if absent (SETNX)”的命令来实现锁的获取，同时兼顾超时删除。当然在每个计划任务方法重复写锁获取和锁释放的代码有点不优雅和重复劳动。所以我设计了通过切片和自写注解的方式，实现在计划任务方法上加锁和设置超时的组件框架，将在下一篇文中中介绍（直接开箱即用哦）。

参考资料：