Spring对调度和异步执行的注解支持-CFANZ编程社区

Spring为任务调度和异步方法执行提供注解支持。

1 启用Scheduling注解

要启用 @Scheduled 和 @Async ，在 @Configuration 类（或者在启动类）添加 @EnableScheduling 和 @EnableAsync，如下：

@Configuration
@EnableAsync
@EnableScheduling
public class AppConfig {

}

@SpringBootApplication(exclude = {
		DataSourceAutoConfiguration.class,
})
@EnableScheduling
public class RoadSyncApplication {

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

你可以为你的应用程序选择相关的注释。例如,如果你只需要支持 @Scheduled,可以省略 @EnableAsync。对于更细粒度的控制,你还可以分别实现 SchedulingConfigurer 接口和 AsyncConfigurer 接口。有关完整详细信息,请参阅 SchedulingConfigurer 和 AsyncConfigurer javadoc。

如果你更喜欢 XML 配置,你可以使用 <task:annotation-driven> 元素:

<task:annotation-driven executor="myExecutor" scheduler="myScheduler"/>
<task:executor id="myExecutor" pool-size="5"/>
<task:scheduler id="myScheduler" pool-size="10"/>

请注意,对于上面的 XML,提供了 executor 引用来处理那些与 @Async 注释对应的方法,并提供了 scheduler 引用来管理那些用 @Scheduled 注释的方法。

默认情况下,处理 @Async 注释的建议模式是 proxy,它仅允许通过代理拦截调用。使用这种方式无法拦截同一类中的本地调用。对于更高级的拦截模式,请考虑切换到 aspectj 模式与编译时织入或加载时织入结合使用。

2 `@Scheduled` 注释

可将 @Scheduled 注释以及触发元数据添加到方法中。

2.1 fixedDelay

如下方法每五秒(5000ms)执行一次,采用固定延迟,这意味着周期从每次先前调用的完成时间开始测量。

@Scheduled(fixedDelay = 5000)  
public void doSomething() {
	// 定期运行的内容  
}

默认情况下,固定延迟、固定速率和初始延迟的值将使用ms作为时间单位。如果你想使用不同的时间单位,比如秒或分钟,你可以通过在 @Scheduled 中配置 timeUnit 属性来实现。例如,前面的例子也可以写成如下形式:

@Scheduled(fixedDelay = 5, timeUnit = TimeUnit.SECONDS)
public void doSomething() {
	// 定期运行的内容
}

如果你需要固定速率执行,可以在注释中使用 fixedRate 属性。下面的方法每五秒(从每次调用的开始时间间隔测量)执行一次:

@Scheduled(fixedRate = 5, timeUnit = TimeUnit.SECONDS)  
public void doSomething() {
	// 定期运行的内容
}

对于固定延迟和固定速率任务,你可以通过指示等待的时间量来指定初始延迟,然后再执行方法的第一次调用,如下面的 fixedRate 示例所示:

@Scheduled(initialDelay=1000, fixedRate=5000)  
public void doSomething() {
	// 定期运行的内容
}

对于一次性任务,你可以只指定通过指示等待执行方法的时间量的初始延迟:

@Scheduled(initialDelay=1000)
public void doSomething() {
	// 只运行一次的内容
}

如果简单的定期计划不够表达力,则可以提供 cron 表达式。下面的示例仅在工作日运行:

@Scheduled(cron="*/5 * * * * MON-FRI")  
public void doSomething() {
	// 仅在工作日运行的内容 
}

你还可以使用 zone 属性来指定解析 cron 表达式的时区。

请注意,要计划的方法必须具有 void 返回值,并且不接受任何参数。如果方法需要与应用程序上下文中的其他对象交互,那么这些对象通常已经通过依赖注入提供了。

@Scheduled 可以用作可重复注释。如果在同一方法上找到几个 scheduled 声明,每个声明都将独立处理,为每个声明触发单独的触发器。因此,这样的共定位计划可以并行重叠并立即连续执行多次。请确保你指定的 cron 表达式等不会意外重叠。

从 Spring Framework 4.3 开始,支持任何范围的 bean 上的 @Scheduled 方法。确保在运行时不初始化同一 @Scheduled 注释类的多个实例,除非你确实希望调度回调到每个这样的实例。与此相关的是,确保不要在使用 @Scheduled 注释并作为常规 Spring bean 注册到容器中的 bean 类上使用 @Configurable。否则,你将获得双重初始化(一次通过容器,一次通过 @Configurable 方面),其结果是每个 @Scheduled 方法被调用两次。

FAQ

问题

生产用@Scheduled注解写定时任务，5min执行一次：

@Scheduled(cron = "0 0/5 * * * ?")
public void MyTimerJobSchedule() throws Exception {
  //省略具体业务逻辑
  System.out.println("五分钟执行一次");
}

过几天，领导通知说有问题，一查日志，发现是定时任务问题。本来应该是5min跑一次，结果日志发现，每天0点-3点正常，3-10点没执行；一直到10-11点之间才继续跑。

原因

发现可能是定时任务单线程模式导致任务阻塞。

继续分析日志，发现该定时任务的线程号是[Scheduling-1]，除了执行自身的任务，还打印了其它定时任务的输出语句。

每天3点前，[Scheduling-1]线程在执行本人写的5min一次的定时任务，3点后，[Scheduling-1]线程会执行另一个比较耗时的定时任务，直到10点后，[Scheduling-1]线程才重新执行5min一次的定时任务。

看来，确实是由于@Scheduled定时任务默认使用单线程模式导致：一旦有一个定时任务比较耗时，就会影响到其它定时任务按时执行。

解决方法

在定时任务加@Async注解，并在启动类增加@EnableAsync注解，使用多线程模式执行定时任务。

备注：参考网址：https://blog.csdn.net/LYM0721/article/details/89499588

参考网址中有第二种解决方法，但是已说明不太好用，因此只用第一种解决方法就够了。

Spring对调度和异步执行的注解支持

1 启用Scheduling注解

2 @Scheduled 注释

2.1 fixedDelay

FAQ

问题

原因

解决方法

2 `@Scheduled` 注释