玩轉SpringBoot之定時任務詳解

時間 2019-12-15

標籤 springboot 定時任務詳解欄目 Spring 简体版

原文原文鏈接

序言

使用SpringBoot建立定時任務很是簡單，目前主要有如下三種建立方式：java

1、基於註解(@Scheduled)
2、基於接口（SchedulingConfigurer）前者相信你們都很熟悉，可是實際使用中咱們每每想從數據庫中讀取指定時間來動態執行定時任務，這時候基於接口的定時任務就派上用場了。
3、基於註解設定多線程定時任務

1、靜態：基於註解

基於註解@Scheduled默認爲單線程，開啓多個任務時，任務的執行時機會受上一個任務執行時間的影響。mysql

一、建立定時器

使用SpringBoot基於註解來建立定時任務很是簡單，只需幾行代碼即可完成。代碼以下：git

@Component
@Configuration      //1.主要用於標記配置類，兼備Component的效果。
@EnableScheduling   // 2.開啓定時任務
public class SaticScheduleTask {
    //3.添加定時任務
    @Scheduled(cron = "0/5 * * * * ?")
    //或直接指定時間間隔，例如：5秒
    //@Scheduled(fixedRate=5000)
    private void configureTasks() {
        System.err.println("執行靜態定時任務時間: " + LocalDateTime.now());
    }
}

Cron表達式參數分別表示：github

秒（0~59）例如0/5表示每5秒
分（0~59）
時（0~23）
日（0~31）的某天，需計算
月（0~11）
周幾（可填1-7 或 SUN/MON/TUE/WED/THU/FRI/SAT）

@Scheduled：除了支持靈活的參數表達式cron以外，還支持簡單的延時操做，例如 fixedDelay ，fixedRate 填寫相應的毫秒數便可。web

二、啓動測試

啓動應用，能夠看到控制檯打印出以下信息：spring

顯然，使用@Scheduled 註解很方便，但缺點是當咱們調整了執行週期的時候，須要重啓應用才能生效，這多少有些不方便。爲了達到實時生效的效果，能夠使用接口來完成定時任務。sql

2、動態：基於接口

基於接口（SchedulingConfigurer）數據庫

一、導入依賴包：

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <version>2.0.4.RELEASE</version>
    </parent>

    <dependencies>
        <dependency><!--添加Web依賴 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency><!--添加MySql依賴 -->
             <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency><!--添加Mybatis依賴 配置mybatis的一些初始化的東西-->
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.1</version>
        </dependency>
        <dependency><!-- 添加mybatis依賴 -->
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

二、添加數據庫記錄：

開啓本地數據庫mysql，隨便打開查詢窗口，而後執行腳本內容，以下：springboot

DROP DATABASE IF EXISTS `socks`;
CREATE DATABASE `socks`; USE `SOCKS`; DROP TABLE IF EXISTS `cron`; CREATE TABLE `cron` ( `cron_id` varchar(30) NOT NULL PRIMARY KEY, `cron` varchar(30) NOT NULL ); INSERT INTO `cron` VALUES ('1', '0/5 * * * * ?');

而後在項目中的application.yml 添加數據源：mybatis

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/socks
    username: root
    password: 123456

三、建立定時器

數據庫準備好數據以後，咱們編寫定時任務，注意這裏添加的是TriggerTask，目的是循環讀取咱們在數據庫設置好的執行週期，以及執行相關定時任務的內容。
具體代碼以下：

@Component
@Configuration      //1.主要用於標記配置類，兼備Component的效果。
@EnableScheduling   // 2.開啓定時任務
public class DynamicScheduleTask implements SchedulingConfigurer { @Mapper public interface CronMapper { @Select("select cron from cron limit 1") public String getCron(); } @Autowired //注入mapper @SuppressWarnings("all") CronMapper cronMapper; /** * 執行定時任務. */ @Override public void configureTasks(ScheduledTaskRegistrar taskRegistrar) { taskRegistrar.addTriggerTask( //1.添加任務內容(Runnable) () -> System.out.println("執行動態定時任務: " + LocalDateTime.now().toLocalTime()), //2.設置執行週期(Trigger) triggerContext -> { //2.1 從數據庫獲取執行週期 String cron = cronMapper.getCron(); //2.2 合法性校驗. if (StringUtils.isEmpty(cron)) { // Omitted Code ..  } //2.3 返回執行週期(Date) return new CronTrigger(cron).nextExecutionTime(triggerContext); } ); } }

四、啓動測試

啓動應用後，查看控制檯，打印時間是咱們預期的每10秒一次：

而後打開Navicat ，將執行週期修改成每6秒執行一次，如圖：

查看控制檯，發現執行週期已經改變，而且不須要咱們重啓應用，十分方便。如圖：

注意：若是在數據庫修改時格式出現錯誤，則定時任務會中止，即便從新修改正確；此時只能從新啓動項目才能恢復。

3、多線程定時任務

基於註解設定多線程定時任務

一、建立多線程定時任務

//@Component註解用於對那些比較中立的類進行註釋；
//相對與在持久層、業務層和控制層分別採用 @Repository、@Service 和 @Controller 對分層中的類進行註釋
@Component
@EnableScheduling   // 1.開啓定時任務
@EnableAsync        // 2.開啓多線程
public class MultithreadScheduleTask {

        @Async
        @Scheduled(fixedDelay = 1000)  //間隔1秒
        public void first() throws InterruptedException {
            System.out.println("第一個定時任務開始 : " + LocalDateTime.now().toLocalTime() + "\r\n線程 : " + Thread.currentThread().getName());
            System.out.println();
            Thread.sleep(1000 * 10);
        }

        @Async
        @Scheduled(fixedDelay = 2000)
        public void second() {
            System.out.println("第二個定時任務開始 : " + LocalDateTime.now().toLocalTime() + "\r\n線程 : " + Thread.currentThread().getName());
            System.out.println();
        }
    }