Springboot 定时任务的使用

Spring 提供了@Scheduled 注解用于定时任务。也就是说一般需求可以无需第三方定时任务。

开启定时任务

启动类加 @EnableScheduling 开启定时任务

@SpringBootApplication
@EnableScheduling // 开启定时任务
public class MainApplication {public static void main(String[] args) {SpringApplication.run(MainApplication.class, args);
    }
}

执行方法

@Component
public class Jobs {

    // 表示方法执行完成后 5 秒
    @Scheduled(fixedDelay = 5000)
    public void fixedDelayJob() throws InterruptedException {System.out.println("fixedDelay 每隔 5 秒 " + new Date());
    }

    // 表示每隔 3 秒
    @Scheduled(fixedRate = 3000)
    public void fixedRateJob() {System.out.println("fixedRate 每隔 3 秒 " + new Date());
    }

    // 表示每天 8 时 30 分 0 秒执行
    @Scheduled(cron = "0 0,30 0,8 ? * ? ")
    public void cronJob() {System.out.println(new Date() + " ...>>cron");
    }
}

第三种使用 cron 表达式可上网搜在线 cron 表达式，选择时间会自动生成，cron 说明

* 第一位，表示秒，取值 0 -59
* 第二位，表示分，取值 0 -59
* 第三位，表示小时，取值 0 -23
* 第四位，日期天 / 日，取值 1 -31
* 第五位，日期月份，取值 1 -12
* 第六位，星期，取值 1 -7，星期一，星期二...，注：不是第 1 周，第二周的意思
          另外：1 表示星期天，2 表示星期一。
* 第 7 为，年份，可以留空，取值 1970-2099

(*)星号：可以理解为每的意思，每秒，每分，每天，每月，每年...
(?)问号：问号只能出现在日期和星期这两个位置。
(-)减号：表达一个范围，如在小时字段中使用“10-12”，则表示从 10 到 12 点，即 10,11,12
(,)逗号：表达一个列表值，如在星期字段中使用“1,2,4”，则表示星期一，星期二，星期四
(/)斜杠：如：x/y，x 是开始值，y 是步长，比如在第一位（秒） 0/15 就是，从 0 秒开始，每 15 秒，最后就是 0，15，30，45，60    另：*/y，等同于 0 /y

举例

0 0 3 * * ?     每天 3 点执行
0 5 3 * * ?     每天 3 点 5 分执行
0 5 3 ? * *     每天 3 点 5 分执行，与上面作用相同
0 5/10 3 * * ?  每天 3 点的 5 分，15 分，25 分，35 分，45 分，55 分这几个时间点执行
0 10 3 ? * 1    每周星期天，3 点 10 分 执行，注：1 表示星期天    
0 10 3 ? * 1#3  每个月的第三个星期，星期天 执行，# 号只能出现在星期的位置 

开启异步任务

在类上加 @EnableAsync 注解

@SpringBootApplication
@EnableScheduling // 开启定时任务
@EnableAsync // 开启异步
public class MainApplication {public static void main(String[] args) {SpringApplication.run(MainApplication.class, args);
    }
}

异步执行，很简单在方法上加 @Async 注解即可

    @Async
    @Scheduled(cron = "0 0,30 0,8 ? * ? ")
    public void cronJob() {System.out.println(new Date() + " ...>>cron");
    }

基于接口

以上基于注解可能不灵活，有时将 cron 表达式存储在数据库就无法执行了，可以使用接口实现。

依赖

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <version>2.0.4.RELEASE</version>
    </parent>

    <dependencies>
        <dependency><!-- 添加 Web 依赖 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency><!-- 添加 MySql 依赖 -->
             <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency><!-- 添加 Mybatis 依赖 配置 mybatis 的一些初始化的东西 -->
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.1</version>
        </dependency>
        <dependency><!-- 添加 mybatis 依赖 -->
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

执行本地 MySQL 创建表且插入一条数据

DROP DATABASE IF EXISTS `socks`;
CREATE DATABASE `socks`;
USE `SOCKS`;
DROP TABLE IF EXISTS `cron`;
CREATE TABLE `cron`  (`cron_id` varchar(30) NOT NULL PRIMARY KEY,
  `cron` varchar(30) NOT NULL  
);
INSERT INTO `cron` VALUES ('1', '0/5 * * * * ?');

具体代码：

@Component
@Configuration      //1. 主要用于标记配置类，兼备 Component 的效果。
@EnableScheduling   // 2. 开启定时任务
public class DynamicScheduleTask implements SchedulingConfigurer {

    @Mapper
    public interface CronMapper {@Select("select cron from cron limit 1")
        public String getCron();}

    @Autowired      // 注入 mapper
    @SuppressWarnings("all")
    CronMapper cronMapper;

    /**
     * 执行定时任务.
     */
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {taskRegistrar.addTriggerTask(//1. 添加任务内容(Runnable)
                () -> System.out.println(" 执行动态定时任务: " + LocalDateTime.now().toLocalTime()),
                //2. 设置执行周期(Trigger)
                triggerContext -> {
                    //2.1 从数据库获取执行周期
                    String cron = cronMapper.getCron();
                    //2.2 合法性校验.
                    if (StringUtils.isEmpty(cron)) {// Omitted Code ..}
                    //2.3 返回执行周期(Date)
                    return new CronTrigger(cron).nextExecutionTime(triggerContext);
                }
        );
    }

}

参考：https://www.cnblogs.com/qdhxhz/p/9058418.html

https://www.mmzsblog.cn/articles/2019/08/08/1565247960802.html