很多時(shí)候，我們有這么一個(gè)需求，需要在每天的某個(gè)固定時(shí)間或者每隔一段時(shí)間讓應(yīng)用去執(zhí)行某一個(gè)任務(wù)。為了實(shí)現(xiàn)這個(gè)需求，通常我們會(huì)通過(guò)多線程來(lái)實(shí)現(xiàn)這個(gè)功能，但是這樣我們需要自己做一些比較麻煩的工作。接下來(lái)，讓我們看看如何使用Spring scheduling task簡(jiǎn)化定時(shí)任務(wù)功能的實(shí)現(xiàn)。

添加maven依賴

為了方便展示，我們使用Spring Boot來(lái)簡(jiǎn)化我們的Spring配置。因?yàn)槲覀兪褂玫氖荢pring自帶的Scheduling，因此我們只需要引入最進(jìn)本的spring-boot-starter即可。

<parent>
    <groupId>org.springframework.boot<span class="hljs-name"groupId>
    <artifactId>spring-boot-starter-parent<span class="hljs-name"artifactId>
    <version>1.2.5.RELEASE<span class="hljs-name"version>
<span class="hljs-name"parent>

<properties>
    <java.version>1.8<span class="hljs-name"java.version>
<span class="hljs-name"properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot<span class="hljs-name"groupId>
        <artifactId>spring-boot-starter<span class="hljs-name"artifactId>
    <span class="hljs-name"dependency>
<span class="hljs-name"dependencies>

注意，Spring boot需要JDK8的編譯環(huán)境。

創(chuàng)建Scheduled Task

讓我們創(chuàng)建一個(gè)ScheduleTask來(lái)實(shí)現(xiàn)我們的需求：

@Component
public class ScheduledTask {

    private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    private Integer count0 = 1;
    private Integer count1 = 1;
    private Integer count2 = 1;

    @Scheduled(fixedRate = 5000)
    public void reportCurrentTime() throws InterruptedException {
        System.out.println(String.format("---第%s次執(zhí)行，當(dāng)前時(shí)間為：%s", count0++, dateFormat.format(new Date())));
    }

    @Scheduled(fixedDelay = 5000)
    public void reportCurrentTimeAfterSleep() throws InterruptedException {
        System.out.println(String.format("===第%s次執(zhí)行，當(dāng)前時(shí)間為：%s", count1++, dateFormat.format(new Date())));
    }

    @Scheduled(cron = "*/5 * * * * *")
    public void reportCurrentTimeCron() throws InterruptedException {
        System.out.println(String.format("+++第%s次執(zhí)行，當(dāng)前時(shí)間為：%s", count2++, dateFormat.format(new Date())));
    }

}

可以看到，我們?cè)谖覀冋嬲枰獔?zhí)行的方法上添加了@Scheduled標(biāo)注，表示這個(gè)方法是需要定時(shí)執(zhí)行的。

在@Scheduled標(biāo)注中，我們使用了三種方式來(lái)實(shí)現(xiàn)了同一個(gè)功能：每隔5秒鐘記錄一次當(dāng)前的時(shí)間：

fixedRate = 5000表示每隔5000ms，Spring scheduling會(huì)調(diào)用一次該方法，不論該方法的執(zhí)行時(shí)間是多少

fixedDelay = 5000表示當(dāng)方法執(zhí)行完畢5000ms后，Spring scheduling會(huì)再次調(diào)用該方法

cron = "*/5 * * * * * *"提供了一種通用的定時(shí)任務(wù)表達(dá)式，這里表示每隔5秒執(zhí)行一次。

配置Scheduling

接下來(lái)我們通過(guò)Spring boot來(lái)配置一個(gè)最簡(jiǎn)單的Spring web應(yīng)用，我們只需要一個(gè)帶有main方法的類即可：

[]()

@SpringBootApplication
@EnableScheduling
public class App {

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

}

我們先來(lái)看看class上的標(biāo)注：

@SpringBootApplication 實(shí)際上是了以下三個(gè)標(biāo)注的集合：

@Configuration 告訴Spring這是一個(gè)配置類，里面的所有標(biāo)注了@Bean的方法的返回值將被注冊(cè)為一個(gè)Bean

@EnableAutoConfiguration 告訴Spring基于class path的設(shè)置、其他bean以及其他設(shè)置來(lái)為應(yīng)用添加各種Bean

@ComponentScan 告訴Spring掃描Class path下所有類來(lái)生成相應(yīng)的Bean

@EnableScheduling 告訴Spring創(chuàng)建一個(gè)task executor，如果我們沒有這個(gè)標(biāo)注，所有@Scheduled標(biāo)注都不會(huì)執(zhí)行

通過(guò)以上標(biāo)注，我們完成了schedule的基本配置。最后，我們添加main方法來(lái)啟動(dòng)一個(gè)Spring boot應(yīng)用即可。

測(cè)試

在根目錄下執(zhí)行命令：mvn spring-boot:run，我們可以看到：