SpringBoot中定時任務的實現


本文轉載自博主 江南一點雨 博文 https://www.cnblogs.com/lenve/p/10728897.html

定時任務的使用場景?

視頻網站購買會員后,每天會給會員贈送成長值,每月會給會員送電影卷;比如一些定時需要生成的報表,郵件等;比如一些需要定時處理的任務等;

定時任務實現的幾種方式:

1)Timer:這是Java自帶的java.util.Timer類,這個類允許你調度一個java.util.TimerTask任務。使用這種方式可以讓你的程序按照某一個頻度執行,但不能在指定時間運行,一般使用比較少。

2)Spring Task:Spring3.0以后自帶的Task,可以將它看成一個輕量級的Quartz,而且使用起來比Quartz簡單許多;

3)ScheduledExecutorService:也是jdk自帶的一個類,是基於線程池設計的定時任務類,每個調度任務都會分配到線程池中的一個線程去執行,也就是說,任務是並發執行的,互不影響;

4)Quartz:這是一個功能比較強大的調度器,可以讓你的程序在指定的時間執行,也可以按照某一個頻度執行,配置起來稍顯復雜。

 

第一,二種方式過於簡單,在實際開發中可能使用較少,這里我們着重了解下第三,四種方式。

@Scheduled

使用@Scheduled非常容易,直接創建一個SpringBoot項目,並且添加web依賴 spring-boot-starter-web,項目創建成功后,添加@EnableScheduling注解,開啟定時任務;

@SpringBootApplication
@EnableScheduling
public class ScheduledApplication {

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

}

 

接下來配置定時任務:

    @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注解開啟定時任務;

2)fixedRate表示任務執行之間的時間間隔,具體指兩次任務的開始時間間隔,有可能出現第二次任務開始而第一次任務並未結束的情況;

3)fixedDelay表示任務執行之間的時間間隔,具體指本次任務結束到下次任務開始之間的時間間隔;

4)initialDelay表示首次任務啟動的延遲時間;

5)所有時間的單位都是毫秒。

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

【秒】【分】【時】【日】【月】【周】【年】

具體取值如下:

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

通配符含義:

  • ? 表示不指定值,即不關心某個字段的取值時使用。需要注意的是,月份中的日期和星期可能會起沖突,因此在配置時這兩個得有一個是 ?
  • * 表示所有值,例如:在秒的字段上設置 *,表示每一秒都會觸發
  • , 用來分開多個值,例如在周字段上設置 "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秒觸發一次,如下:

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

  

Quartz:

一般在項目中,除非定時任務涉及到的業務實在太簡單,使用@Scheduled注解來解決定時任務,否則大部分情況都是使用Quartz來做定時任務,在SpringBoot中使用Quartz,只需要在創建項目時,添加Quartz依賴即可。

項目創建完成后,也需要添加開啟定時任務的注解:

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

 

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

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

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

 

 

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

1)首先將這個Job注冊到Spring容器中;

2)這種定義方式有一個缺陷,就是無法傳參。

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

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

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

Job有了之后,接下來創建類,配置JobDetail和Trigger觸發器,如下:

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

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

1)JobDetail的配置有兩種方式:MethodInvokingJobDetailFactoryBean和JobDetailFactoryBean;

2)使用MethodInvokingJobDetailFactoryBean可以配置目標Bean的名字和目標方法的名字,這種方式不支持傳參;

3)使用JobDetailFactoryBean可以配置JobDetail,任務類繼承自QuartzJobBean,這種方式支持傳參,將參數封裝在JobDataMap中進行傳遞;

4)Trigger是指觸發器,Quartz定義了多個觸發器,這里向大家展示其中兩種的用法,SimpleTrigger和CronTrigger;

5)SimpleTrigger有點類似前面說的@Scheduled的基本用法;

6)CronTrigger則有點類似於@Scheduled中的cron表達式用法。

全部定義完成之后,啟動SpringBoot項目就可以看到定時任務的執行了。

 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM