SpringBoot从入门到精通教程（四）- @Scheduled定时器用法和场景案例分析

需求背景

日常项目开发中，我们经常会遇到以下几种特定需求：

1. 一些事情，需要在指定时间执行
2. 一些事情，需要在指定时间执行后，再间隔指定时间重复执行
3. 一些事情，需要在启动任务之后，隔多久才执行

Springboot2中提供了@Scheduled注解，可以定时执行，比如定时检查某些功能是否正常，或定时备份某份数据等，它可以帮你完成这些定时操作。

技术点

主要使用了两个注解

1. @EnableScheduling

配置在启动类入口，用于开启定时功能

2. @Scheduled

用于配置具体某个任务的执行时间点，实现某个特定功能

案例说明

场景案例分析：

1. 定时器计划用法介绍
2. 开启并行多线程任务两种方式
3. 场景案例分析

代码演示

1. 定时器计划用法介绍

启动类入口配置，开启定时功能

package com.md.demo;

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

/**
 * 程序主入口
 * 
 * @author Minbo.He
 *
 */
@SpringBootApplication
@EnableScheduling
public class Application {

	public static void main(String[] args) {
		SpringApplication.run(Application.class, args);
	}
	
}

任务实现类

package com.md.demo;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import com.md.demo.service.DemoService;

/**
 * 任务中心1
 * 
 * @author Minbo.He
 *
 */
@Component
public class ScheduledTasks {

	protected static Logger logger = LoggerFactory.getLogger(ScheduledTasks.class);
	
	@Autowired
	private DemoService service;

	/*
	 * 一般用法详解
	 * 
	 * initialDelay表示一个初始延迟时间，第一次被调用前延迟的时间 
	 * fixedDelay表示一个固定延迟时间执行，上个任务完成后,延迟多久执行
	 */

	// 启动立即执行
	// 每5秒执行一次
	@Scheduled(initialDelay = 1000, fixedDelay = 5000)
	public void test1() {
		logger.info("test1这里，每5秒执行一次。DemoService --->>> " + this.service.sayHello());
	}

	// 每5秒执行一次
	@Scheduled(initialDelay = 1000, fixedDelay = 5000)
	public void test2() {
		logger.info("test2这里，每5秒执行一次");
	}

	
//	Cron表达式用法：秒 分 时 日 月 周
//	比如：
//		每5秒执行一次：*/5 * * * * *
//		每30分钟执行一次：* */30 * * * *
//		每1小时执行一次：* * */1 * * *
//		每天2点执行一次：* * 2 * * *
	
	// 固定时间才执行，即为10秒的整数倍执行，比如20秒，30秒，40秒时，会执行
	// 每10秒执行一次
	@Scheduled(cron = "*/10 * * * * *")
	public void test3() {
		logger.info("test3这里，每10秒执行一次");
	}
	
}

注：cron更详细的用法，可自行网上了解一下

代码执行效果：

问题：这里你会发现，当有多个任务配置执行时，一直只有一个线程在跑（默认线程池是单个池）

这肯定是不行的，我们希望是：当有多个任务同时存在时，需要多线程能并发执行，彼此不影响，以下是解决方案

2. 开启并行多线程任务两种方式

a. 方式一：通过实现SchedulingConfigurer接口，重写configureTasks方法，重新定义线程池

package com.md.demo;

import java.util.concurrent.Executors;

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

/**
 * 并行多线程任务功能（方式一）
 * 
 * @author Minbo.He
 */
@Configuration
public class ScheduleConfig implements SchedulingConfigurer {

	@Override
	public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
		// 开启一个固定10个大小的线程池，也使用Executors下其他的线程池
		taskRegistrar.setScheduler(Executors.newScheduledThreadPool(10));
	}
}

代码执行效果：

b. 方式二：通过异步方式执行调度任务

package com.md.demo;

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

/**
 * 程序主入口
 * 
 * @author Minbo.He
 *
 */
@SpringBootApplication
@EnableScheduling
@EnableAsync
public class Application {

	public static void main(String[] args) {
		SpringApplication.run(Application.class, args);
	}
	
}

package com.md.demo;

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

/**
 * 
 * 并行多线程任务功能（方式二）
 * 
 * 任务中心2：通过异步方式执行调度任务
 * 
 * 配置Application入口的@EnableAsync，在定时任务方法前面配置@Async，即配置了任务线程池
 * 
 * @author Minbo.He
 *
 */
@Component
public class ScheduledTasksAsync {

	protected static Logger logger = LoggerFactory.getLogger(ScheduledTasksAsync.class);

	// 启动立即执行
	// 每5秒执行一次
	@Async
	@Scheduled(initialDelay = 1000, fixedDelay = 5000)
	public void test4() {
		logger.info("test4这里，每5秒执行一次");
	}

}

代码执行效果：

完整源码下载

我的Github源码地址：

https://github.com/hemin1003/spring-boot-study/tree/master/spring-boot2-study/spring-boot2-parent

推荐平台

1、Elastic-Job

Elastic-Job是一个分布式调度解决方案，由两个相互独立的子项目Elastic-Job-Lite和Elastic-Job-Cloud组成。
Elastic-Job-Lite定位为轻量级无中心化解决方案，使用jar包的形式提供分布式任务的协调服务；Elastic-Job-Cloud采用自研Mesos Framework的解决方案，额外提供资源治理、应用分发以及进程隔离等功能。

2、XXL-JOB（推荐这个，轻量、简单易用）

XXL-JOB是一个轻量级分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展，与springboot集成十分简单。

场景案例分析

1. 分布式部署下任务重复执行问题

可以通过分布式锁实现。多节点部署时，在任务启动时先获取锁是否存在，如果不存在，则加锁后，然后自身执行。

比如通过redis setnx实现，向redis中存一个key值，每次会先判断该key值是否存在

2、当服务器有问题如宕机，那失败或丢失的任务如何处理，怎么补偿

可以把每次执行时间持久化到db中（我们目前使用中的方式），或者存入到redis中，然后判定周期区间，重新执行任务

附加说明

当项目不大、业务逻辑不是很复杂时，利用@Scheduled来执行任务或跑批，一般来说就够用了

随着项目发展壮大，业务越来越复杂时，就可以考虑使用上面提到的推荐平台其中之一

下一章教程

SpringBoot从入门到精通教程（五）- 内嵌Tomcat自定义配置用法

该系列教程

SpringBoot从入门到精通教程

 

 

 

------------------------------------------------------

------------------------------------------------------

 

关于我（个人域名）

我的开源项目集Github

 

期望和大家一起学习，共同进步，共勉，O(∩_∩)O谢谢

欢迎交流问题，可加个人QQ 469580884，

或者，加我的群号 751925591，一起探讨交流问题

不讲虚的，只做实干家

Talk is cheap，show me the code

如果觉得内容赞，您可以请我喝杯咖啡：