编写Spring Boot应用中经常会遇到这样的场景，比如：我需要定时地发送一些短信、邮件之类的操作，也可能会定时地检查和监控一些标志、参数，或者实时的显示一些数据等。
基本使用
添加@EnableScheduling注解到入口类声明上面，启用定时任务的配置，如下所示：
@SpringBootApplication
//在Spring Boot的主类中加入@EnableScheduling注解，启用定时任务的配置
@EnableScheduling
public class Application {
public static void main(String[] args) throws Exception {
SpringApplication.run(Application.class);
}
}
将@Scheduled添加到不带参数的方法上，如下所示：
@RestController
@RequestMapping(value = "/SpringScheduledController")
public class SpringScheduledController {
int i = 0;
@Scheduled(fixedRate = 3000)
@ApiOperation(value = "springScheduled", notes = "spring定时器")
@RequestMapping(value = "/springScheduled", method = RequestMethod.POST)
public void springScheduled() {
System.out.println("----------" + i++);
}
}
运行结果
参数详解
- @Scheduled(fixedDelay = 5000)
延迟执行。任务在上个任务完成后达到设置的延时时间就执行。此处，任务会在上个任务完成后经过5s再执行。 - @Scheduled(fixedRate = 5000)
定时执行。任务间隔规定时间即执行。此处，任务每隔五秒便会执行一次。 - @Scheduled(initialDelay=1000, fixedRate=5000)
第一次延迟1秒后执行，之后按fixedRate的规则每5秒执行一次 - @Scheduled(cron = “0 0 2 * * ?”)
自定义规则执行。比较复杂，一般用6或7个标识符(非官方叫法，方便区分记忆这么叫的)表示任务的执行规则。此处的逻辑是每天的凌晨两点开始定时执行任务。 - cron表达式
一个cron表达式有至少6个（也可能7个）有空格分隔的时间元素。
按顺序依次为
1 秒（0~59）
2 分钟（0~59）
3 小时（0~23）
4 天（0~31）
5 月（0~11）
6 星期（1~7 1=SUN 或 SUN，MON，TUE，WED，THU，FRI，SAT）
7 年份（1970－2099）
其中每个元素可以是一个值(如6),一个连续区间(9-12),一个间隔时间(8-18/4)(/表示每隔4小时),一个列表(1,3,5),通配符。由于"月份中的日期"和"星期中的日期"这两个元素互斥的,必须要对其中一个设置 ?
自定义示例
0 0 10,14,16 * * ? 每天上午10点，下午2点，4点
0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时
0 0 12 ? * WED 表示每个星期三中午12点
"0 0 12 * * ?" 每天中午12点触发
"0 15 10 ? * *" 每天上午10:15触发
"0 15 10 * * ?" 每天上午10:15触发
"0 15 10 * * ? *" 每天上午10:15触发
"0 15 10 * * ? 2005" 2005年的每天上午10:15触发
"0 * 14 * * ?" 在每天下午2点到下午2:59期间的每1分钟触发
"0 0/5 14 * * ?" 在每天下午2点到下午2:55期间的每5分钟触发
"0 0/5 14,18 * * ?" 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
"0 0-5 14 * * ?" 在每天下午2点到下午2:05期间的每1分钟触发
"0 10,44 14 ? 3 WED" 每年三月的星期三的下午2:10和2:44触发
"0 15 10 ? * MON-FRI" 周一至周五的上午10:15触发
"0 15 10 15 * ?" 每月15日上午10:15触发
"0 15 10 L * ?" 每月最后一日的上午10:15触发
"0 15 10 ? * 6L" 每月的最后一个星期五上午10:15触发
"0 15 10 ? * 6L 2002-2005" 2002年至2005年的每月的最后一个星期五上午10:15触发
"0 15 10 ? * 6#3" 每月的第三个星期五上午10:15触发
配置详解
有些子表达式能包含一些范围或列表
例如：子表达式（天（星期））可以为 “MON-FRI”，“MON，WED，FRI”，“MON-WED,SAT”
“*”字符代表所有可能的值
“/”字符用来指定数值的增量
例如：在子表达式（分钟）里的“0/15”表示从第0分钟开始，每15分钟
在子表达式（分钟）里的“3/20”表示从第3分钟开始，每20分钟（它和“3，23，43”）的含义一样
“？”字符仅被用于天（月）和天（星期）两个子表达式，表示不指定值
当2个子表达式其中之一被指定了值以后，为了避免冲突，需要将另一个子表达式的值设为“？”
“L” 字符仅被用于天（月）和天（星期）两个子表达式，它是单词“last”的缩写
如果在“L”前有具体的内容，它就具有其他的含义了。例如：“6L”表示这个月的倒数第６天
注意：在使用“L”参数时，不要指定列表或范围，因为这会导致问题
W 字符代表着平日(Mon-Fri)，并且仅能用于日域中。它用来指定离指定日的最近的一个平日。大部分的商业处理都是基于工作周的，所以 W 字符可能是非常重要的。
例如，日域中的 15W 意味着 "离该月15号的最近一个平日。" 假如15号是星期六，那么 trigger 会在14号(星期五)触发，因为星期四比星期一离15号更近。
C：代表“Calendar”的意思。它的意思是计划所关联的日期，如果日期没有被关联，则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。
- 字段允许的特殊字符
字段 允许值 允许的特殊字符
秒 0-59 , - * /
分 0-59 , - * /
小时 0-23 , - * /
日期 1-31 , - * ? / L W C
月份 1-12 或者 JAN-DEC , - * /
星期 1-7 或者 SUN-SAT , - * ? / L C #
年（可选） 留空, 1970-2099 , - * /
案例
例1：@scheduled (cron=“0 0 2 2 * ? *”) 表示：每月二号凌晨两点执行。
例2：@scheduled (cron=“15,20,40 15-20 2/5 L * ?”) 表示：每月的最后一天的凌晨2点开始每隔5小时的第15分钟到第20分钟之间的每分钟的第15,20,40秒执行一次。
例3：@scheduled (cron=“0 0 0 15W * ?”) 表示：每月离15号最近的工作日。
例4：@scheduled (cron= "0 0 0 0 * 2#3 ") 表示：每月的第三个周一。
执行情况说明
1、fixedRate配置了上一次任务的开始时间到下一次任务的开始时间的间隔，每次任务都会执行；
2、fixedDelay配置了上一次任务的结束时间到下一次任务的开始时间的间隔，每次任务都会执行；
3、cron表达式配置了在哪一刻执行任务，会在配置的任务开始时间判断任务是否可以执行，如果能则执行，不能则会跳过本次执行；
4、如果是强调任务间隔的定时任务，建议使用fixedRate和fixedDelay，如果是强调任务在某时某分某刻执行的定时任务，建议使用cron表达式。
通过配置文件读取表达式
(1).cron
配置文件yml
demo:
cron: 0/10 * * * * ?
代码
@Scheduled(cron = "${demo.cron:0/2 * * * * ?}")
public void cronTaskYmlDemo() {
log.info("cron yml demo");
}
如果配置文件没有配，就会使用默认的值。
(2).fixedDelay
配置文件yml
demo:
fixed-delay: 5
代码
@Scheduled(initialDelay = 5, fixedDelayString = "${demo.fixed-delay:2}", timeUnit = TimeUnit.SECONDS)
public void fixedDelayTaskYmlDemo() {
log.info("fixedDelay yml demo");
}
如果在配置文件中没有配置，则每隔2秒执行一次，如果配置了，就每隔5秒执行一次。initialDelay 表示，项目启动后，5秒开始执行第一次任务。
注意：${erwin.fixed-delay:2}，冒号前后不能有空格。
(3).fixedRate
配置文件yml
demo:
fixed-rate: 5
代码
@Scheduled(initialDelay = 5, fixedRateString = "${erwin.fixed-rate:2}", timeUnit = TimeUnit.SECONDS)
public void fixedRateTaskYmlDemo() {
log.info("fixedRate yml demo");
}
写配置的时候，没有提示,解决方案
导入依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
写配置属性
@Date
@Configuration
@ConfigurationProperties("demo")
public class ErwinProperties {
private String cron;
private Long fixedDelay;
private Long fixedRate;
}
yml
demo:
cron: 0/10 * * * * ?
fixed-delay: 5
fixed-rate: 5
@Scheduled注意事项
- spring的注解@Scheduled 需要写在实现方法上；
- 定时器的任务方法不能有返回值（如果有返回值，spring初始化的时候会告诉你有个错误、需要设定一个proxytargetclass的某个值为true），不能指向任何的参数；
- 如果该方法需要与应用程序上下文的其他对象进行交互，通常是通过依赖注入来实现；
- 实现类上要有组件的注解@Component。
@Scheduled 定时任务不执行
一、排查代码中添加的定时任务步骤是否正确
- 启动类上加 @EnableScheduling 注解
- 定时任务类上加@Component
- 定时方法上加@Scheduled
@Scheduled(cron = "0 19 16 * * ?")
public void cron() {
log.info("定时任务开启：---");
}
二、排查是否任务阻塞，如果定时任务出现异常阻塞后，将不会在次执行
解决：进行try…catch异常抛出
三、java中多个@Scheduled定时器不执行
原因是：@Scheduled注解会在默认情况下以单线程的方式执行定时任务。
这个“单线程”指两个方面：
- 如果一个定时任务执行时间大于其任务间隔时间，那么下一次将会等待上一次执行结束后再继续执行。
- 如果多个定时任务在同一时刻执行，任务会依次执行。
为了让@Scheduled效率更高，我们可以通过两种方法将定时任务变成多线程执行：
方法1、在启动类中配置TaskScheduler线程池大小：
public TaskScheduler taskScheduler() {
ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
taskScheduler.setPoolSize(10);//不配置默认是1
return taskScheduler;
}
方法2、利用Spring提供的@Async注解和@EnableAsync注解
@Component
@EnableAsync //开启异步支持
public class TimedTask{
@Async // 对某个方法进行异步执行
@Scheduled(initialDelay = 1,fixedDelay=10000)//initialDelay 在容器启动后，延迟1毫秒再执行一次定时器
public void aa() {
//执行业务逻辑
}
@Async
@Scheduled(initialDelay = 1,fixedDelay=10000)//fixedDelay 以上一次方法执行完开始算起，如上一次方法执行阻塞住了，那么直到上一次执行完，并间隔给定的时间后，执行下一次
public void bb() {
//执行业务逻辑
}
}
@Scheduled 的执行原理
1、加载使用 @Scheduled 注解的类及方法
Spring 首先会通过类 ScheduledAnnotationBeanPostProcessor 的 postProcessAfterInitialization 方法去初始化 bean，待初始化完 bean 后，就会拦截所有用到“@Scheduled”注解的方法，进行调度处理，具体细节请看下面代码：
2、解析 @Scheduled 的内容，并将定时任务注册到 ScheduledTaskRegistrar 中
解析相应的注解参数，放入“定时任务列表”等待后续处理；之后在“定时任务列表”中统一执行相应的定时任务（定时任务先执行 corn，判断定时任务的执行时间，计算出相应的下次执行时间，放入线程中，到了时间就执行。再执行按“频率”（fixedRate）执行的定时任务，直到所有任务执行结束）。
3、执行定时任务
run 方法是调度 task 的核心，task 的执行实际上是 run 方法的执行。
总结
从上面代码可以看出，如果多个定时任务定义的是同一个时间，会根据程序加载标有 @Scheduled 方法的先后来执行。若某个定时任务一直无法执行完成，则无法设置下次任务执行时间，之后会导致此任务后面的所有定时任务无法继续执行，也就会出现所有的定时任务罢工的现象。所以应用 SpringBoot 的定时任务的方法中，一定不要出现“死循环”、“执行耗费大量时间”、“http持续等待无响应”的现象，否则会导致定时任务直接罢工。针对数据量、查询或者远程调用特别多的场景，推荐把定时任务分段处理
定时任务调度：Unexpected error occurred in scheduled task错误
这是因为@Scheduled注解方式级别高于资源注入级别,导致了资源注入失败在代码中使用了@Autowired注解进行自动注入，但是@Scheduled注解优先级高于@Autowired，导致定时任务启动时自动注入的对象为null
解决：使用ApplicationContextAware,它实现了这个接口的bean，当spring容器初始化的时候，会自动的将ApplicationContext注入进来
@Component
@Lazy(value = false)
public class AlertTask implements ApplicationContextAware {
private static ApplicationContext context;
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
context = applicationContext;
}
public static ApplicationContext getApplicationContext() {
return context;
}
public static Object getBean(String name) {
return getApplicationContext().getBean(name);
}
/**
* @Description 定时获取数据更新本地数据
* @Return void
* @Date 2019-11-01 09:15:17
**/
@Scheduled(cron = "0/5 * * * * ?")//每两分钟执行一次0 */2 * * * ?
public void getEquipmentDataAlert() throws Exception {
DeviceService DeviceService = (DeviceService)this.getBean("DeviceService");
DeviceService.findxx();
}
}
或者将implements ApplicationContextAware抽出来,封装一个工具类.
/**
* @Description 定时任务service注入工具
*/
public class TaskUtil implements ApplicationContextAware {
private static ApplicationContext context;
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
context = applicationContext;
}
public static ApplicationContext getApplicationContext() {
return context;
}
public static Object getBean(String name) {
return getApplicationContext().getBean(name);
}
}
548
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
