SpringBoot實現定時任務

SpringBoot實現定時任務 Spring Boot定時任務的兩種實現方式

在 Spring + SpringMVC 環境中,通常來講,要實現定時任務,咱們有兩中方案,一種是使用 Spring 自帶的定時任務處理器 @Scheduled 註解,另外一種就是使用第三方框架 Quartz ,Spring Boot 源自 Spring+SpringMVC ,所以自然具有這兩個 Spring 中的定時任務實現策略,固然也支持 Quartz,本文咱們就來看下 Spring Boot 中兩種定時任務的實現方式。java

@Scheduled

使用 @Scheduled 很是容易,直接建立一個 Spring Boot 項目,而且添加 web 依賴 spring-boot-starter-web,項目建立成功後,添加 @EnableScheduling 註解,開啓定時任務:web

@SpringBootApplication
@EnableScheduling
public class ScheduleApplication {

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

接下來配置定時任務:spring

@Service
public class HelloService {
    @Scheduled(fixedDelay = 2000)
    public void fixedDelay(){
        System.out.println("fixedDelay>>>"+new Date());
    }
    @Scheduled(fixedRate = 2000)
    public void fixedRate(){
        System.out.println("fixedRate>>>"+new Date());
    }
}
  1. 首先使用 @Scheduled 註解開啓一個定時任務。
  2. fixedRate 表示任務執行之間的時間間隔,具體是指兩次任務的開始時間間隔,即第二次任務開始時,第一次任務可能還沒結束。
  3. fixedDelay 表示任務執行之間的時間間隔,具體是指本次任務結束到下次任務開始之間的時間間隔。
  4. initialDelay 表示首次任務啓動的延遲時間。
  5. 全部時間的單位都是毫秒。

上面這是一個基本用法,除了這幾個基本屬性以外,@Scheduled 註解也支持 cron 表達式,使用 cron 表達式,能夠很是豐富的描述定時任務的時間。cron 表達式格式以下:框架

[秒] [分] [小時] [日] [月] [周] [年]ide

具體取值以下:spring-boot

序號 說明 是否必填 容許填寫的值 容許的通配符
1 0-59 - * /
2 0-59 - * /
3 0-23 - * /
4 1-31 - * ? / L W
5 1-12 or JAN-DEC - * /
6 1-7 or SUN-SAT - * ? / L ##
7 1970-2099 - * /

這一塊須要你們注意的是,月份中的日期和星期可能會起衝突,所以在配置時這兩個得有一個是 ?this

通配符含義:spa

  • ? 表示不指定值,即不關心某個字段的取值時使用。須要注意的是,月份中的日期和星期可能會起衝突,所以在配置時這兩個得有一個是 ?
  • * 表示全部值,例如:在秒的字段上設置 *,表示每一秒都會觸發
  • , 用來分開多個值,例如在周字段上設置 「MON,WED,FRI」 表示週一,週三和週五觸發
  • - 表示區間,例如在秒上設置 「10-12」,表示 10,11,12秒都會觸發
  • / 用於遞增觸發,如在秒上面設置」5/15」 表示從5秒開始,每增15秒觸發(5,20,35,50)
  • ## 序號(表示每個月的第幾個周幾),例如在周字段上設置」6##3」表示在每個月的第三個週六,(用 在母親節和父親節再合適不過了)
  • 周字段的設置,若使用英文字母是不區分大小寫的 ,即 MON 與mon相同
  • L 表示最後的意思。在日字段設置上,表示當月的最後一天(依據當前月份,若是是二月還會自動判斷是不是潤年), 在周字段上表示星期六,至關於」7」或」SAT」(注意週日算是第一天)。若是在」L」前加上數字,則表示該數據的最後一個。例如在周字段上設置」6L」這樣的格式,則表示」本月最後一個星期五」
  • W 表示離指定日期的最近工做日(週一至週五),例如在日字段上設置」15W」,表示離每個月15號最近的那個工做日觸發。若是15號正好是週六,則找最近的週五(14號)觸發, 若是15號是周未,則找最近的下週一(16號)觸發,若是15號正好在工做日(週一至週五),則就在該天觸發。若是指定格式爲 「1W」,它則表示每個月1號日後最近的工做日觸發。若是1號正是週六,則將在3號下週一觸發。(注,」W」前只能設置具體的數字,不容許區間」-「)
  • LW 能夠一組合使用。若是在日字段上設置」LW」,則表示在本月的最後一個工做日觸發(通常指發工資 )

例如,在 @Scheduled 註解中來一個簡單的 cron 表達式,每隔5秒觸發一次,以下:code

@Scheduled(cron = "0/5 * * * * *")
    public void cron() {
        System.out.println(new Date());
    }

上面介紹的是使用 @Scheduled 註解的方式來實現定時任務,接下來咱們再來看看如何使用 Quartz 實現定時任務。blog

Quartz

通常在項目中,除非定時任務涉及到的業務實在是太簡單,使用 @Scheduled 註解來解決定時任務,不然大部分狀況可能都是使用 Quartz 來作定時任務。在 Spring Boot 中使用 Quartz ,只須要在建立項目時,添加 Quartz 依賴便可:

[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-g6hVisgu-1588384869505)(http://www.javaboy.org/images/boot2/16-1.png)]

項目建立完成後,也須要添加開啓定時任務的註解:

@SpringBootApplication
@EnableScheduling
public class QuartzApplication {

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

}

Quartz 在使用過程當中,有兩個關鍵概念,一個是JobDetail(要作的事情),另外一個是觸發器(何時作),要定義 MyFirstJob,須要先定義 Job,Job 的定義有兩種方式:

第一種方式,直接定義一個Bean:

@Component
public class MyFirstJob {
    public void sayhello(){
        System.out.println("first job say hello"+new Date());
    }
}

關於這種定義方式說兩點:

  1. 首先將這個 Job 註冊到 Spring 容器中。
  2. 這種定義方式有一個缺陷,就是沒法傳參。

第二種定義方式,則是繼承 MySecondJob 並實現默認的方法:

public class MySecondJob extends QuartzJobBean {
    private String name;

    public void setName(String name) {
        this.name = name;
    }

    @Override
    protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("second job say hello"+name+":"+new Date());
    }
}

和第1種方式相比,這種方式支持傳參,任務啓動時,executeInternal 方法將會被執行。

Job 有了以後,接下來建立類,配置 JobDetail 和 Trigger 觸發器,以下:

@Configuration
public class QuartzConfig {
    @Bean
    MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean(){
        MethodInvokingJobDetailFactoryBean bean=new MethodInvokingJobDetailFactoryBean();
        bean.setTargetBeanName("myFirstJob");
        bean.setTargetMethod("sayhello");
        return bean;
    }
    @Bean
    JobDetailFactoryBean jobDetailFactoryBean(){
        JobDetailFactoryBean bean=new JobDetailFactoryBean();
        JobDataMap map = new JobDataMap();
        map.put("name","xiaoliu" );
        bean.setJobDataAsMap(map);
        bean.setJobClass(MySecondJob.class);
        return bean;
    }
    @Bean
    SimpleTriggerFactoryBean simpleTriggerFactoryBean(){
        SimpleTriggerFactoryBean bean=new SimpleTriggerFactoryBean();
        bean.setJobDetail(methodInvokingJobDetailFactoryBean().getObject());
        bean.setStartTime(new Date());
        bean.setRepeatInterval(2000);
        bean.setRepeatCount(3);
        return bean;
    }
    @Bean
    CronTriggerFactoryBean cronTriggerFactoryBean(){
        CronTriggerFactoryBean bean=new CronTriggerFactoryBean();
        bean.setJobDetail(jobDetailFactoryBean().getObject());
        bean.setCronExpression("* * * * * ?");
        return bean;
    }
    @Bean
    SchedulerFactoryBean schedulerFactoryBean(){
        SchedulerFactoryBean bean = new SchedulerFactoryBean();
        bean.setTriggers(simpleTriggerFactoryBean().getObject(),cronTriggerFactoryBean().getObject());
        return bean;
    }
}

關於這個配置說以下幾點:

  1. JobDetail 的配置有兩種方式:MethodInvokingJobDetailFactoryBean 和 JobDetailFactoryBean 。
  2. 使用 MethodInvokingJobDetailFactoryBean 能夠配置目標 Bean 的名字和目標方法的名字,這種方式不支持傳參。
  3. 使用 JobDetailFactoryBean 能夠配置 JobDetail ,任務類繼承自 QuartzJobBean ,這種方式支持傳參,將參數封裝在 JobDataMap 中進行傳遞。
  4. Trigger 是指觸發器,Quartz 中定義了多個觸發器,這裏向你們展現其中兩種的用法,SimpleTrigger 和 CronTrigger 。
  5. SimpleTrigger 有點相似於前面說的 @Scheduled 的基本用法。
  6. CronTrigger 則有點相似於 @Scheduled 中 cron 表達式的用法。

img

所有定義完成後,啓動 Spring Boot 項目就能夠看到定時任務的執行了。

在這裏插入圖片描述

相關文章
相關標籤/搜索