SpringBoot中使用任务调度器的注意事项

柔光的暖阳◎ 2023-06-08 03:24 6阅读 0赞

在项目开发过程中，我们经常需要执行具有周期性的任务。通过定时任务可以很好的帮助我们实现。

我们拿常用的几种定时任务框架做一个比较：

![format_png][]

从以上表格可以看出，Spring Schedule框架功能完善，简单易用。对于中小型项目需求，Spring Schedule是完全可以胜任的。

### 1、springboot集成schedule ###

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

1.1 添加maven依赖包

由于Spring Schedule包含在spring-boot-starter基础模块中了，所有不需要增加额外的依赖。

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

<dependencies>
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter</artifactId>
 </dependency>
 
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-test</artifactId>
 <scope>test</scope>
 </dependency>
 </dependencies>

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

1.2 启动类，添加启动注解

在springboot入口或者配置类中增加@EnableScheduling注解即可启用定时任务。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>@EnableScheduling</code> <code>@SpringBootApplication</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>ScheduleApplication { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>static</code>&nbsp;<code>void</code>&nbsp;<code>main(String[] args) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>SpringApplication.run(ScheduleApplication.</code><code>class</code><code>, args);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

1.3.添加定时任务

我们将对Spring Schedule三种任务调度器分别举例说明。

**1.3.1 Cron表达式**

类似于Linux下的Cron表达式时间定义规则。Cron表达式由6或7个空格分隔的时间字段组成，如下图：

![format_png 1][]

常用表达式：

![format_png 2][]

举个栗子：

添加一个work()方法，每10秒执行一次。

注意：当方法的执行时间超过任务调度频率时，调度器会在下个周期执行。

如：假设work()方法在第0秒开始执行，方法执行了12秒，那么下一次执行work()方法的时间是第20秒。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>@Component</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>MyTask { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Scheduled</code><code>(cron =&nbsp;</code><code>"0/10 * * * * *"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>void</code>&nbsp;<code>work() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// task execution logic</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**1.3.2 固定间隔任务**

下一次的任务执行时间，是从方法最后一次任务执行结束时间开始计算。并以此规则开始周期性的执行任务。

举个栗子：

添加一个work()方法，每隔10秒执行一次。

例如：假设work()方法在第0秒开始执行，方法执行了12秒，那么下一次执行work()方法的时间是第22秒。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>@Scheduled</code><code>(fixedDelay =&nbsp;</code><code>1000</code><code>*</code><code>10</code><code>)</code> <code>public</code>&nbsp;<code>void</code>&nbsp;<code>work() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// task execution logic</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**1.3.3 固定频率任务**

按照指定频率执行任务，并以此规则开始周期性的执行调度。

举个栗子：

添加一个work()方法，每10秒执行一次。

注意：当方法的执行时间超过任务调度频率时，调度器会在当前方法执行完成后立即执行下次任务。

例如：假设work()方法在第0秒开始执行，方法执行了12秒，那么下一次执行work()方法的时间是第12秒。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>@Scheduled</code><code>(fixedRate =&nbsp;</code><code>1000</code><code>*</code><code>10</code><code>)</code> <code>public</code>&nbsp;<code>void</code>&nbsp;<code>work() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// task execution logic</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

### 2、配置TaskScheduler线程池 ###

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

在实际项目中，我们一个系统可能会定义多个定时任务。那么多个定时任务之间是可以相互独立且可以并行执行的。

通过查看org.springframework.scheduling.config.ScheduledTaskRegistrar源代码，发现spring默认会创建一个单线程池。这样对于我们的多任务调度可能会是致命的，当多个任务并发（或需要在同一时间）执行时，任务调度器就会出现时间漂移，任务执行时间将不确定。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>protected</code>&nbsp;<code>void</code>&nbsp;<code>scheduleTasks() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>(</code><code>this</code><code>.taskScheduler ==&nbsp;</code><code>null</code><code>) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>this</code><code>.localExecutor = Executors.newSingleThreadScheduledExecutor();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>this</code><code>.taskScheduler =&nbsp;</code><code>new</code>&nbsp;<code>ConcurrentTaskScheduler(</code><code>this</code><code>.localExecutor);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//省略...</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

2.1 自定义线程池

新增一个配置类，实现SchedulingConfigurer接口。重写configureTasks方法，通过taskRegistrar设置自定义线程池。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>@Configuration</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>ScheduleConfig&nbsp;</code><code>implements</code>&nbsp;<code>SchedulingConfigurer { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>void</code>&nbsp;<code>configureTasks(ScheduledTaskRegistrar taskRegistrar) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>taskRegistrar.setScheduler(taskExecutor());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Bean</code><code>(destroyMethod=</code><code>"shutdown"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>Executor taskExecutor() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>Executors.newScheduledThreadPool(</code><code>20</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

### 3、实际应用中的问题 ###

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

3.1 Web应用中的启动和关闭问题

我们知道通过spring加载或初始化的Bean，在服务停止的时候，spring会自动卸载（销毁）。但是由于线程是JVM级别的，如果用户在Web应用中启动了一个线程，那么这个线程的生命周期并不会和Web应用保持一致。也就是说，即使Web应用停止了，这个线程依然没有结束（死亡）。

解决方法：

1）当前对象是通过spring初始化

spring在卸载（销毁）实例时，会调用实例的destroy方法。通过实现DisposableBean接口覆盖destroy方法实现。在destroy方法中主动关闭线程。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>@Component</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>MyTask&nbsp;</code><code>implements</code>&nbsp;<code>DisposableBean{ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>void</code>&nbsp;<code>destroy()&nbsp;</code><code>throws</code>&nbsp;<code>Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//关闭线程或线程池</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>ThreadPoolTaskScheduler scheduler = (ThreadPoolTaskScheduler)applicationContext.getBean(</code><code>"scheduler"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>scheduler.shutdown();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//省略...</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

2）当前对象不是通过spring初始化（管理）

那么我们可以增加一个Servlet上下文监听器，在Servlet服务停止的时候主动关闭线程。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>MyTaskListenter&nbsp;</code><code>implements</code>&nbsp;<code>ServletContextListener{ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>void</code>&nbsp;<code>contextDestroyed(ServletContextEvent arg0) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//关闭线程或线程池</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//省略...</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

3.2 分布式部署问题

在实际项目中，我们的系统通常会做集群、分布式或灾备部署。那么定时任务就可能出现并发问题，即同一个任务在多个服务器上同时在运行。

解决方法（分布式锁）：

1）通过数据库表锁

2）通过缓存中间件

3）通过Zookeeper实现

[format_png]: /images/20230531/aaa7cfeea8ee4e49a9c055cc5c6827c7.png
[aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]: /images/20230531/74c325d8cd814849b024aebe0ffc8719.png
[format_png 1]: /images/20230531/d4c58a9e2a6b4d15897e278aa297da3a.png
[format_png 2]: /images/20230531/a904bb81ad774b2688d3b7cb071ce4a7.png