springboot 基於@Scheduled註解 實現定時任務

前言

定時任務通常有三種完成方法

  1. java自帶的API java.util.Timer類 java.util.TimerTask類

在 JDK 中,內置了兩個類,可以實現定時任務的功能:

  • java.util.Timer :可以通過創建 java.util.TimerTask 調度任務,在同一個線程中串行執行,相互影響。也就是說,對於同一個 Timer 裏的多個 TimerTask 任務,如果一個 TimerTask 任務在執行中,其它 TimerTask 即使到達執行的時間,也只能排隊等待。因爲 Timer 是串行的,同時存在 坑坑 ,所以後來 JDK 又推出了 ScheduledExecutorService ,Timer 也基本不再使用。

  • java.util.concurrent.ScheduledExecutorService :在 JDK 1.5 新增,基於線程池設計的定時任務類,每個調度任務都會被分配到線程池中併發執行,互不影響。這樣,ScheduledExecutorService 就解決了 Timer 串行的問題。

在日常開發中,我們很少直接使用 Timer 或 ScheduledExecutorService 來實現定時任務的需求。主要有幾點原因:

  • 它們僅支持按照指定頻率,不直接支持指定時間的定時調度,需要我們結合 Calendar 自行計算,才能實現複雜時間的調度。例如說,每天、每週五、2019-11-11 等等。

  • 它們是進程級別,而我們爲了實現定時任務的高可用,需要部署多個進程。此時需要等多考慮,多個進程下,同一個任務在相同時刻,不能重複執行。

  • 項目可能存在定時任務較多,需要統一的管理,此時不得不進行二次封裝。

     所以,一般情況下,我們會選擇專業的調度任務中間件

2、Quartz框架 開源 功能強大 使用起來稍顯複雜

3.Spring 3.0以後自帶了task 調度工具,比Quartz更加的簡單方便

使用SpringBoot創建定時任務非常簡單,目前主要有以下三種創建方式:
一、基於註解(@Scheduled)
二、基於接口(SchedulingConfigurer) 前者相信大家都很熟悉,但是實際使用中我們往往想從數據庫中讀取指定時間來動態執行定時任務,這時候基於接口的定時任務就派上用場了。
三、基於註解設定多線程定時任務
 

 

一、靜態:基於註解

1、創建定時器

使用SpringBoot基於註解來創建定時任務非常簡單,只需幾行代碼便可完成。 代碼如下:

 

@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());
    }
}

@Controller
public class TestSchudle {


    @Scheduled(cron = "0/5 * * * * ?")
    //或直接指定時間間隔,例如:5秒
    //@Scheduled(fixedRate=5000)
    private void configureTasks() {
        System.err.println("在controller裏進行定時操作 " + LocalDateTime.now());
    }

}

關於Cron表達式介紹

cronExpression定義時間規則,Cron表達式由6或7個空格分隔的時間字段組成:秒 分鐘 小時 日期 月份 星期 年(可選)

 

字段  允許值  允許的特殊字符 
秒       0-59     , - * / 
分       0-59     , - * / 
小時      0-23     , - * / 
日期      1-31     , - * ? / L W C 
月份      1-12     , - * / 
星期      1-7       , - * ? / L C # 
年     1970-2099   , - * /

關於Cron表達式的介紹來源:

http://blog.csdn.net/supingemail/article/details/22274279

表達式網站生成:

表達式網站地址

 

二、動態:基於接口

基於接口(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>

 

2、添加數據庫記錄:

開啓本地數據庫mysql,隨便打開查詢窗口,然後執行腳本內容,如下:

 

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 添加數據源:

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

3、創建定時器

數據庫準備好數據之後,我們編寫定時任務,注意這裏添加的是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);
                }
        );
    }

}

三、多線程定時任務

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

1、創建多線程定時任務

 

//@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();
        }
    }

 

實例

參考:https://blog.csdn.net/debugbugbg/article/details/81091715

 

              SpringTask 默認是單線程的 上面的兩個定時任務使用的都是同一個線程;在實際開發中,不希望所有的任務都運行在一個線程中,想要改成多線程,給SpringTask提供一個多線程的TaskScheduler,Spring已經有默認實現

結果:

 

 

代碼地址:https://github.com/mmzsblog/springboot-schedule

 轉載:https://www.cnblogs.com/mmzs/p/10161936.html

其他參考:

https://blog.csdn.net/jack_bob/article/details/78786740

https://blog.csdn.net/fastlearn/article/details/83306796

https://mp.weixin.qq.com/s/jqN4noo5NazckPCehWFgpA

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章