Java SpringBoot
SpringBoot创建定时任务,目前主要有以下三种实现方式:

  • 基于注解(**@Scheduled**): 基于注解@Scheduled默认为单线程,开启多个任务时,任务的执行时机会受上一个任务执行时间的影响;
  • 基于接口(**SchedulingConfigurer**): 用于实现从数据库获取指定时间来动态执行定时任务;
  • 基于注解设定多线程定时任务: 基于注解设定多线程定时任务;

    一、静态:基于注解

    1、创建定时器

    使用SpringBoot基于注解来创建定时任务比较简单,只需要如下代码即可。代码如下:

    1. @Configuration //1.主要用于标记配置类,兼备Component的效果。
    2. @EnableScheduling // 2.开启定时任务
    3. public class SaticScheduleTask {
    4. //3.添加定时任务
    5. @Scheduled(cron = "0/5 * * * * ?")
    6. //或直接指定时间间隔,例如:5秒
    7. //@Scheduled(fixedRate=5000)
    8. private void configureTasks() {
    9. System.err.println("执行静态定时任务时间: " + LocalDateTime.now());
    10. }
    11. }

    Cron表达式参数分别表示:

  • 秒(0~59) 例如0/5表示每5秒

  • 分(0~59)
  • 时(0~23)
  • 日(0~31)的某天,需计算
  • 月(0~11)
  • 周几( 可填1-7 或 SUN/MON/TUE/WED/THU/FRI/SAT)

@Scheduled:除了支持灵活的参数表达式cron之外,还支持简单的延时操作,例如 fixedDelay ,fixedRate 填写相应的毫秒数即可。
建议:直接点击在线Cron表达式生成器生成参数比较方便:https://www.matools.com/cron/

2、启动测试

启动应用,控制台打印信息如下:
Spring Boot实现定时任务的三种方式 - 图1
显然,使用@Scheduled 注解很方便,但缺点是当调整了执行周期的时候,需要重启应用才能生效,这多少有些不方便。为了达到实时生效的效果,可以使用接口来完成定时任务。

二、动态:基于接口

基于接口(SchedulingConfigurer)

1、导入依赖包:

  1. <parent>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter</artifactId>
  4. <version>2.0.4.RELEASE</version>
  5. </parent>
  6. <dependencies>
  7. <dependency><!--添加Web依赖 -->
  8. <groupId>org.springframework.boot</groupId>
  9. <artifactId>spring-boot-starter-web</artifactId>
  10. </dependency>
  11. <dependency><!--添加MySql依赖 -->
  12. <groupId>mysql</groupId>
  13. <artifactId>mysql-connector-java</artifactId>
  14. </dependency>
  15. <dependency><!--添加Mybatis依赖 配置mybatis的一些初始化的东西-->
  16. <groupId>org.mybatis.spring.boot</groupId>
  17. <artifactId>mybatis-spring-boot-starter</artifactId>
  18. <version>1.3.1</version>
  19. </dependency>
  20. <dependency><!-- 添加mybatis依赖 -->
  21. <groupId>org.mybatis</groupId>
  22. <artifactId>mybatis</artifactId>
  23. <version>3.4.5</version>
  24. <scope>compile</scope>
  25. </dependency>
  26. </dependencies>

2、添加数据库记录:

开启本地数据库mysql,随便打开查询窗口,然后执行脚本内容,如下:

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

Spring Boot实现定时任务的三种方式 - 图2
然后在项目中的application.yml 添加数据源:

  1. spring:
  2. datasource:
  3. url: jdbc:mysql://localhost:3306/socks
  4. username: root
  5. password: 123456

3、创建定时器

数据库准备好数据后,开始编写定时任务,注意这里添加的是TriggerTask,目的是循环读取在数据库设置好的执行周期,以及执行相关定时任务的内容。
具体代码如下:

  1. @Configuration //1.主要用于标记配置类,兼备Component的效果。
  2. @EnableScheduling // 2.开启定时任务
  3. public class DynamicScheduleTask implements SchedulingConfigurer {
  4. @Mapper
  5. public interface CronMapper {
  6. @Select("select cron from cron limit 1")
  7. public String getCron();
  8. }
  9. @Autowired //注入mapper
  10. @SuppressWarnings("all")
  11. CronMapper cronMapper;
  12. /**
  13. * 执行定时任务.
  14. */
  15. @Override
  16. public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
  17. taskRegistrar.addTriggerTask(
  18. //1.添加任务内容(Runnable)
  19. () -> System.out.println("执行动态定时任务: " + LocalDateTime.now().toLocalTime()),
  20. //2.设置执行周期(Trigger)
  21. triggerContext -> {
  22. //2.1 从数据库获取执行周期
  23. String cron = cronMapper.getCron();
  24. //2.2 合法性校验.
  25. if (StringUtils.isEmpty(cron)) {
  26. // Omitted Code ..
  27. }
  28. //2.3 返回执行周期(Date)
  29. return new CronTrigger(cron).nextExecutionTime(triggerContext);
  30. }
  31. );
  32. }
  33. }

4、启动测试

启动应用后,查看控制台,打印时间是预期的每10秒一次:
Spring Boot实现定时任务的三种方式 - 图3
然后打开Navicat ,将执行周期修改为每6秒执行一次,如图:
Spring Boot实现定时任务的三种方式 - 图4
查看控制台,发现执行周期已经改变,并且不需要重启应用,十分方便。如图:
Spring Boot实现定时任务的三种方式 - 图5
注意:如果在数据库修改时格式出现错误,则定时任务会停止,即使重新修改正确后,也只能重新启动项目才能恢复。

三、多线程定时任务

基于注解设定多线程定时任务

1、创建多线程定时任务

  1. //@Component注解用于对那些比较中立的类进行注释;
  2. //相对与在持久层、业务层和控制层分别采用 @Repository、@Service 和 @Controller 对分层中的类进行注释
  3. @Component
  4. @EnableScheduling // 1.开启定时任务
  5. @EnableAsync // 2.开启多线程
  6. public class MultithreadScheduleTask {
  7. @Async
  8. @Scheduled(fixedDelay = 1000) //间隔1秒
  9. public void first() throws InterruptedException {
  10. System.out.println("第一个定时任务开始 : " + LocalDateTime.now().toLocalTime() + "\r\n线程 : " + Thread.currentThread().getName());
  11. System.out.println();
  12. Thread.sleep(1000 * 10);
  13. }
  14. @Async
  15. @Scheduled(fixedDelay = 2000)
  16. public void second() {
  17. System.out.println("第二个定时任务开始 : " + LocalDateTime.now().toLocalTime() + "\r\n线程 : " + Thread.currentThread().getName());
  18. System.out.println();
  19. }
  20. }

注:这里的@Async注解很关键

2、启动测试

启动应用后,查看控制台:
image.png
从截图中可以看出,第一个和第二个定时任务互不影响;并且,由于开启了多线程,第一个任务的执行时间也不受其本身执行时间的限制,所以需要注意可能会出现重复操作导致数据异常。