Spring Boot 中實現(xiàn)定時任務(wù)的兩種方式

在 Spring + SpringMVC 環(huán)境中,一般來說,要實現(xiàn)定時任務(wù),我們有兩中方案,一種是使用 Spring 自帶的定時任務(wù)處理器 @Scheduled 注解,另一種就是使用第三方框架 Quartz ,Spring Boot 源自 Spring+SpringMVC ,因此天然具備這兩個 Spring 中的定時任務(wù)實現(xiàn)策略,當然也支持 Quartz,本文我們就來看下 Spring Boot 中兩種定時任務(wù)的實現(xiàn)方式。

@Scheduled

使用 @Scheduled 非常容易,直接創(chuàng)建一個 Spring Boot 項目,并且添加 web 依賴 spring-boot-starter-web,項目創(chuàng)建成功后,添加 @EnableScheduling 注解,開啟定時任務(wù):

@SpringBootApplication
@EnableScheduling
public class ScheduledApplication {
    public static void main(String[] args) {
        SpringApplication.run(ScheduledApplication.class, args);
    }
}

接下來配置定時任務(wù):

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

上面這是一個基本用法,除了這幾個基本屬性之外,@Scheduled 注解也支持 cron 表達式,使用 cron 表達式,可以非常豐富的描述定時任務(wù)的時間。cron 表達式格式如下:

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

具體取值如下:

這一塊需要大家注意的是,月份中的日期和星期可能會起沖突,因此在配置時這兩個得有一個是 ?。

通配符含義:

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

例如,在 @Scheduled 注解中來一個簡單的 cron 表達式,每隔5秒觸發(fā)一次,如下:

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

上面介紹的是使用 @Scheduled 注解的方式來實現(xiàn)定時任務(wù),接下來我們再來看看如何使用 Quartz 實現(xiàn)定時任務(wù)。

Quartz

一般在項目中,除非定時任務(wù)涉及到的業(yè)務(wù)實在是太簡單,使用 @Scheduled 注解來解決定時任務(wù),否則大部分情況可能都是使用 Quartz 來做定時任務(wù)。在 Spring Boot 中使用 Quartz ,只需要在創(chuàng)建項目時,添加 Quartz 依賴即可:

image.png

項目創(chuàng)建完成后,也需要添加開啟定時任務(wù)的注解:

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

Quartz 在使用過程中,有兩個關(guān)鍵概念,一個是JobDetail(要做的事情),另一個是觸發(fā)器(什么時候做),要定義 JobDetail,需要先定義 Job,Job 的定義有兩種方式:

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

@Component
public class MyJob1 {
    public void sayHello() {
        System.out.println("MyJob1>>>"+new Date());
    }
}

關(guān)于這種定義方式說兩點:

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

第二種定義方式,則是繼承 QuartzJobBean 并實現(xiàn)默認的方法:

public class MyJob2 extends QuartzJobBean {
    HelloService helloService;
    public HelloService getHelloService() {
        return helloService;
    }
    public void setHelloService(HelloService helloService) {
        this.helloService = helloService;
    }
    @Override
        protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        helloService.sayHello();
    }
}
public class HelloService {
    public void sayHello() {
        System.out.println("hello service >>>"+new Date());
    }
}

和第1種方式相比,這種方式支持傳參,任務(wù)啟動時,executeInternal 方法將會被執(zhí)行。

Job 有了之后,接下來創(chuàng)建類,配置 JobDetail 和 Trigger 觸發(fā)器,如下:

@Configuration
public class QuartzConfig {
    @Bean
        MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean() {
        MethodInvokingJobDetailFactoryBean bean = new MethodInvokingJobDetailFactoryBean();
        bean.setTargetBeanName("myJob1");
        bean.setTargetMethod("sayHello");
        return bean;
    }
    @Bean
        JobDetailFactoryBean jobDetailFactoryBean() {
        JobDetailFactoryBean bean = new JobDetailFactoryBean();
        bean.setJobClass(MyJob2.class);
        JobDataMap map = new JobDataMap();
        map.put("helloService", helloService());
        bean.setJobDataMap(map);
        return bean;
    }
    @Bean
        SimpleTriggerFactoryBean simpleTriggerFactoryBean() {
        SimpleTriggerFactoryBean bean = new SimpleTriggerFactoryBean();
        bean.setStartTime(new Date());
        bean.setRepeatCount(5);
        bean.setJobDetail(methodInvokingJobDetailFactoryBean().getObject());
        bean.setRepeatInterval(3000);
        return bean;
    }
    @Bean
        CronTriggerFactoryBean cronTrigger() {
        CronTriggerFactoryBean bean = new CronTriggerFactoryBean();
        bean.setCronExpression("0/10 * * * * ?");
        bean.setJobDetail(jobDetailFactoryBean().getObject());
        return bean;
    }
    @Bean
        SchedulerFactoryBean schedulerFactoryBean() {
        SchedulerFactoryBean bean = new SchedulerFactoryBean();
        bean.setTriggers(cronTrigger().getObject(), simpleTriggerFactoryBean().getObject());
        return bean;
    }
    @Bean
        HelloService helloService() {
        return new HelloService();
    }
}

關(guān)于這個配置說如下幾點:

  1. JobDetail 的配置有兩種方式:MethodInvokingJobDetailFactoryBean 和 JobDetailFactoryBean 。
  2. 使用 MethodInvokingJobDetailFactoryBean 可以配置目標 Bean 的名字和目標方法的名字,這種方式不支持傳參。
  3. 使用 JobDetailFactoryBean 可以配置 JobDetail ,任務(wù)類繼承自 QuartzJobBean ,這種方式支持傳參,將參數(shù)封裝在 JobDataMap 中進行傳遞。
  4. Trigger 是指觸發(fā)器,Quartz 中定義了多個觸發(fā)器,這里向大家展示其中兩種的用法,SimpleTrigger 和 CronTrigger 。
  5. SimpleTrigger 有點類似于前面說的 @Scheduled 的基本用法。
  6. CronTrigger 則有點類似于 @Scheduled 中 cron 表達式的用法。

全部定義完成后,啟動 Spring Boot 項目就可以看到定時任務(wù)的執(zhí)行了。

總結(jié)

這里主要向大家展示了 Spring Boot 中整合兩種定時任務(wù)的方法,整合成功之后,剩下的用法基本上就和在 SSM 中使用一致了,不再贅述。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 一點知識 在JAVA開發(fā)領(lǐng)域,目前可以通過以下幾種方式進行定時任務(wù): Timer:jdk中自帶的一個定時調(diào)度類,可...
    雅倩蘭爸爸閱讀 3,927評論 1 28
  • 博客原文 徒手翻譯spring framework 4.2.3官方文檔的第33章,若有翻譯不當之處請指正。 定時任...
    rabbitGYK閱讀 5,852評論 4 24
  • 原文地址:SpringBoot幾種定時任務(wù)的實現(xiàn)方式 定時任務(wù)實現(xiàn)的幾種方式:Timer:這是java自帶的jav...
    sherlockwit_孫鳴閱讀 529評論 0 0
  • 落葉半,夜微涼,繁花落地已成霜 琴蕭瑟,念悠揚,囈語入耳戀回腸 怎料,往事煙,夢難尋。 唯有,悲上悲,愁亦愁 只留...
    語觴閱讀 274評論 0 1
  • “為了拿出有說服力的分析性報告,在選擇最有效的組織策略之前,要考慮你的受眾的可能反應(yīng)”。 * 接受態(tài)度的受...
    TaoMin閱讀 1,689評論 0 0

友情鏈接更多精彩內(nèi)容