Springboot整合Schedule实现定时任务

目录

前言

一、定时任务的有哪些实现方式 

二、Springboot整合Schedule实现定时任务

使用@Scheduled注解创建定时任务

代码样例

开启定时任务

代码样例

执行结果 （单线程）

多线程处理定时任务

源分析【ScheduledTaskRegistrar.class】

多线程实现

执行结果

三、cron详解

cron表达式在线工具

cron表达式定义

每个域可出现的字符类型和各字符的含义

总结

---

---

前言

有时候在开发中经常会使用一些定时的任务，比如果整点推送，或者是每隔一段时间给客户发送一个消息等等。
定时任务一般会存在 中大型企业级 项目中，为了减少 服务器、数据库 的压力，往往会以 定时任务 的方式去完成某些业务逻辑。

常见的就是 金融服务系统推送回调，一般支付系统订单在没有收到成功的回调返回内容时会 持续性的回调，这种回调一般都是 定时任务 来完成。

还有就是报表的生成，我们一般会在客户访问量小时完成这个操作，也可以采用定时任务来完成。

---

一、定时任务的有哪些实现方式 

• Timer：这是java自带的java.util.Timer类，这个类允许你调度一个java.util.TimerTask任务。使用这种方式可以让你的程序按照某一个频度执行，但不能在指定时间运行。一般用的较少。
• ScheduledExecutorService：也jdk自带的一个类；是基于线程池设计的定时任务类,每个调度任务都会分配到线程池中的一个线程去执行,也就是说,任务是并发执行,互不影响。
• Spring Task：Spring3.0以后自带的task，可以将它看成一个轻量级的Quartz，而且使用起来比Quartz简单许多。
• Quartz：这是一个功能比较强大的的调度器，可以让你的程序在指定时间执行，也可以按照某一个频度执行，配置起来稍显复杂

二、Springboot整合Schedule实现定时任务

• 使用@Scheduled注解创建定时任务

@Scheduled注解的参数如下：

1. cron：cron表达式，指定任务在特定时间执行；
2. fixedDelay：表示上一次任务执行完成后多久再次执行，参数类型为long，单位ms；
3. fixedDelayString：与fixedDelay含义一样，只是参数类型变为String；
4. fixedRate：表示按一定的频率执行任务，参数类型为long，单位ms；
5. fixedRateString: 与fixedRate的含义一样，只是将参数类型变为String；
6. initialDelay：表示延迟多久再第一次执行任务，参数类型为long，单位ms；
7. initialDelayString：与initialDelay的含义一样，只是将参数类型变为String；
8. zone：时区，默认为当前时区，一般没有用到。

• 代码样例

mport org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

/**
 * Description: 构建执行定时任务
 */
@Component
public class ScheduledTasks {

    private Logger logger = LoggerFactory.getLogger(ScheduledTasks.class);

    private int fixedDelayCount = 1;
    private int fixedRateCount = 1;
    private int initialDelayCount = 1;
    private int cronCount = 1;

    @Scheduled(fixedDelay = 5000)        //fixedDelay = 5000表示当前方法执行完毕5000ms后，Spring scheduling会再次调用该方法
    public void testFixDelay() {
        logger.info("===fixedDelay: 第{}次执行方法", fixedDelayCount++);
    }

    @Scheduled(fixedRate = 5000)        //fixedRate = 5000表示当前方法开始执行5000ms后，Spring scheduling会再次调用该方法
    public void testFixedRate() {
        logger.info("===fixedRate: 第{}次执行方法", fixedRateCount++);
    }

    @Scheduled(initialDelay = 1000, fixedRate = 5000)   //initialDelay = 1000表示延迟1000ms执行第一次任务
    public void testInitialDelay() {
        logger.info("===initialDelay: 第{}次执行方法", initialDelayCount++);
    }

    @Scheduled(cron = "0 0/1 * * * ?")  //cron接受cron表达式，根据cron表达式确定定时规则
    public void testCron() {
        logger.info("===initialDelay: 第{}次执行方法", cronCount++);
    }

}

• 开启定时任务

使用 @EnableScheduling 注解，它的作用是发现注解@Scheduled的任务并由后台执行。没有它的话将无法执行定时任务。

• 代码样例

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

/**
 * Description: 启动类
 */
@SpringBootApplication
@EnableScheduling
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

• 执行结果 （单线程）

 

 

 从控制台输入的结果中我们可以看出所有的定时任务都是在同一个线程池用同一个线程来处理的。

• 多线程处理定时任务

• 源分析【ScheduledTaskRegistrar.class】

	protected void scheduleTasks() {
		if (this.taskScheduler == null) {
			this.localExecutor = Executors.newSingleThreadScheduledExecutor();
			this.taskScheduler = new ConcurrentTaskScheduler(this.localExecutor);
		}
		if (this.triggerTasks != null) {
			for (TriggerTask task : this.triggerTasks) {
				addScheduledTask(scheduleTriggerTask(task));
			}
		}
		if (this.cronTasks != null) {
			for (CronTask task : this.cronTasks) {
				addScheduledTask(scheduleCronTask(task));
			}
		}
		if (this.fixedRateTasks != null) {
			for (IntervalTask task : this.fixedRateTasks) {
				addScheduledTask(scheduleFixedRateTask(task));
			}
		}
		if (this.fixedDelayTasks != null) {
			for (IntervalTask task : this.fixedDelayTasks) {
				addScheduledTask(scheduleFixedDelayTask(task));
			}
		}
	}

这里说明如果taskScheduler为空，那么就给定时任务做了一个单线程的线程池

我们只需用调用这个方法显式的设置一个ScheduledExecutorService就可以达到并发的效果了。我们要做的仅仅是实现SchedulingConfigurer接口，重写configureTasks方法就OK了

• 多线程实现

import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;

import java.util.concurrent.Executors;

/**
 * Description: 多线程执行定时任务
 */
@Configuration
//所有的定时任务都放在一个线程池中，定时任务启动时使用不同都线程。
public class ScheduleConfig implements SchedulingConfigurer {
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        //设定一个长度10的定时任务线程池
        taskRegistrar.setScheduler(Executors.newScheduledThreadPool(10));
    }
}

• 执行结果

 

 

三、cron详解

• cron表达式在线工具

https://qqe2.com/cron/index

• cron表达式定义

Cron表达式是一个字符串，是由空格隔开的6或7个域组成，每一个域对应一个含义（秒 分 时 每月第几天 月 星期 年）其中年是可选字段。但是，spring的schedule值支持6个域的表达式，也就是不能设定年。

• 每个域可出现的字符类型和各字符的含义

• 各域支持的字符类型
  • 秒：可出现", - * /"四个字符，有效范围为0-59的整数
  • 分：可出现", - * /"四个字符，有效范围为0-59的整数
  • 时：可出现", - * /"四个字符，有效范围为0-23的整数
  • 每月第几天：可出现", - * / ? L W C"八个字符，有效范围为0-31的整数
  • 月：可出现", - * /"四个字符，有效范围为1-12的整数或JAN-DEc
  • 星期：可出现", - * / ? L C #"四个字符，有效范围为1-7的整数或SUN-SAT两个范围。1表示星期天，2表示星期一， 依次类推

• 特殊字符含义
  • * : 表示匹配该域的任意值，比如在秒*, 就表示每秒都会触发事件。
  • ? : 只能用在每月第几天和星期两个域。表示不指定值，当2个子表达式其中之一被指定了值以后，为了避免冲突，需要将另一个子表达式的值设为“?”。
  • - : 表示范围，例如在分域使用5-20，表示从5分到20分钟每分钟触发一次。
  • / : 表示起始时间开始触发，然后每隔固定时间触发一次，例如在分域使用5/20,则意味着5分，25分，45分，分别触发一次.
  • , : 表示列出枚举值。例如：在分域使用5,20，则意味着在5和20分时触发一次。
  • L : 表示最后，只能出现在星期和每月第几天域，如果在星期域使用1L,意味着在最后的一个星期日触发。
  • W : 表示有效工作日(周一到周五),只能出现在每月第几日域，系统将在离指定日期的最近的有效工作日触发事件。注意一点，W的最近寻找不会跨过月份。
  • LW : 这两个字符可以连用，表示在某个月最后一个工作日，即最后一个星期五。
  • # : 用于确定每个月第几个星期几，只能出现在每月第几天域。例如在1#3，表示某月的第三个星期日。

再次强调：实际使用的时候，使用在线工具生成【https://qqe2.com/cron/index】

---

总结