1??????Spring Boot定時任務和異步調用

我們在編寫Spring Boot應用中經常會遇到這樣的場景，比如：我需要定時地發送一些短信、郵件之類的操作，也可能會定時地檢查和監控一些標志、參數等。

spring boot定時任務spring-boot-jsp項目源碼：

碼云地址：https://git.oschina.net/wyait/springboot1.5.4.git

github地址：https://github.com/wyait/spring-boot-1.5.4.git

1.1??創建定時任務

在Spring Boot中編寫定時任務是非常簡單的事，下面通過實例介紹如何在Spring Boot中創建定時任務，實現每過5秒輸出一下當前時間。

1，在Spring Boot的主類中加入@EnableScheduling注解，啟用定時任務的配置

//?這是一個配置Spring的配置類

@Configuration

// @SpringBootApplication：Spring Boot項目的核心注解，主要目的是開啟自動配置。

@SpringBootApplication

@EnableScheduling//開啟定時任務

public class DemoApplication {

?? publicstatic void main(String[] args) {

????? //啟動spring boot應用

????? SpringApplicationsa = new SpringApplication(DemoApplication.class);

????? //禁用devTools熱部署

????? System.setProperty("spring.devtools.restart.enabled","false");

????? //禁用命令行更改application.properties屬性

????? sa.setAddCommandLineProperties(false);

????? sa.run(args);

?? }

}

2，創建定時任務實現類：

@Component

public class ScheduledTasks {

??? private static final SimpleDateFormatdateFormat = new SimpleDateFormat("HH:mm:ss");

???

??? @Scheduled(fixedRate = 5000)

??? public void reportCurrentTime() {

??????? System.out.println("現在時間：" +dateFormat.format(new Date()));

??? }

}

3，運行程序，控制臺中可以看到類似如下輸出，定時任務開始正常運作了

關于上述的簡單入門示例也可以參見官方的Scheduling Tasks：https://spring.io/guides/gs/scheduling-tasks/

1.2??@Scheduled詳解

在上面的入門例子中，使用了@Scheduled(fixedRate = 5000)注解來定義每過5秒執行的任務，對于@Scheduled的使用可以總結如下幾種方式：

@Scheduled(fixedRate ? ? = 5000)：上一次開始執行時間點之后5秒再執行
@Scheduled(fixedDelay ? ? = 5000)：上一次執行完畢時間點之后5秒再執行
@Scheduled(initialDelay=1000, ? ? fixedRate=5000)：第一次延遲1秒后執行，之后按fixedRate的規則每5秒執行一次
@Scheduled(cron="*/5 ? ? * * * * *")：通過cron表達式定義規則

1.3??異步調用

什么是“異步調用”？

“異步調用”對應的是“同步調用”，同步調用指程序按照定義順序依次執行，每一行程序都必須等待上一行程序執行完成之后才能執行；異步調用指程序在順序執行時，不等待異步調用的語句返回結果就執行后面的程序。

1.3.1?????同步調用

1，下面通過一個簡單示例來直觀的理解什么是同步調用：

@Component

public class Task {

??? public static Random random =new Random();

??? public void doTaskOne() throws Exception {

??????? System.out.println("開始做任務一");

??????? long start =System.currentTimeMillis();

??????? Thread.sleep(random.nextInt(10000));

??????? long end = System.currentTimeMillis();

??????? System.out.println("完成任務一，耗時：" + (end - start) + "毫秒");

??? }

??? public void doTaskTwo() throws Exception {

??????? System.out.println("開始做任務二");

??????? long start =System.currentTimeMillis();

??????? Thread.sleep(random.nextInt(10000));

??????? long end = System.currentTimeMillis();

??????? System.out.println("完成任務二，耗時：" + (end - start) + "毫秒");

??? }

??? public void doTaskThree() throws Exception{

???? ???System.out.println("開始做任務三");

??????? long start =System.currentTimeMillis();

??????? Thread.sleep(random.nextInt(10000));

??????? long end = System.currentTimeMillis();

??????? System.out.println("完成任務三，耗時：" + (end - start) + "毫秒");

??? }

}

2，Controller中新增方法：

@Autowired

?? privateTask task;

?? @ApiIgnore

?? @RequestMapping("/test")

?? publicvoid getTest() {

????? try{

??????? task.doTaskOne();

??????? task.doTaskTwo();

??????? task.doTaskThree();

????? }catch (Exception e) {

??????? //TODO Auto-generated catch block

??????? e.printStackTrace();

????? }

?? }

3，啟動，訪問：

開始做任務一

完成任務一，耗時：4910毫秒

開始做任務二

完成任務二，耗時：5104毫秒

開始做任務三

完成任務三，耗時：2853毫秒

任務一、任務二、任務三順序的執行完了，換言之doTaskOne、doTaskTwo、doTaskThree三個函數順序的執行完成。

1.3.2?????異步調用

上述的同步調用雖然順利的執行完了三個任務，但是可以看到執行時間比較長，若這三個任務本身之間不存在依賴關系，可以并發執行的話，同步調用在執行效率方面就比較差，可以考慮通過異步調用的方式來并發執行。

在Spring Boot中，我們只需要通過使用@Async注解就能簡單的將原來的同步函數變為異步函數，Task類改在為如下模式：

@Component

public class Task {

??? @Async

??? public void doTaskOne() throws Exception {

?? ?????//?同上內容，省略

??? }

??? @Async

??? public void doTaskTwo() throws Exception {

??????? //?同上內容，省略

??? }

??? @Async

??? public void doTaskThree() throws Exception{

??????? //?同上內容，省略

??? }

}

為了讓@Async注解能夠生效，還需要在SpringBoot的主程序中配置@EnableAsync（@EnableScheduling直接替換掉），如下所示：

//?這是一個配置Spring的配置類

@Configuration

// @SpringBootApplication：Spring Boot項目的核心注解，主要目的是開啟自動配置。

@SpringBootApplication

//@EnableScheduling//開啟定時任務

@EnableAsync

public class DemoApplication {

?? publicstatic void main(String[] args) {

????? //啟動spring boot應用

????? SpringApplicationsa = new SpringApplication(DemoApplication.class);

????? //禁用devTools熱部署

????? System.setProperty("spring.devtools.restart.enabled","false");

????? //禁用命令行更改application.properties屬性

????? sa.setAddCommandLineProperties(false);

????? sa.run(args);

?? }

}

啟動，結果：

此時可以反復執行單元測試，您可能會遇到各種不同的結果，比如：

沒有任何任務相關的輸出
有部分任務相關的輸出
亂序的任務相關的輸出

原因是目前doTaskOne、doTaskTwo、doTaskThree三個函數的時候已經是異步執行了。主程序在異步調用之后，主程序并不會理會這三個函數是否執行完成了，由于沒有其他需要執行的內容，所以程序就自動結束了，導致了不完整或是沒有輸出任務相關內容的情況。

注：?@Async所修飾的函數不要定義為static類型，這樣異步調用不會生效

1.3.3?????異步回調

為了讓doTaskOne、doTaskTwo、doTaskThree能正常結束，假設我們需要統計一下三個任務并發執行共耗時多少，這就需要等到上述三個函數都完成調動之后記錄時間，并計算結果。

那么我們如何判斷上述三個異步調用是否已經執行完成呢？我們需要使用Future<T>來返回異步調用的結果，就像如下方式改造doTaskOne函數：

@Async

?? publicFuture<String> doTaskOne() throws Exception {

????? System.out.println("開始做任務一");

????? longstart = System.currentTimeMillis();

????? Thread.sleep(random.nextInt(10000));

????? longend = System.currentTimeMillis();

????? System.out.println("完成任務一，耗時：" + (end - start) + "毫秒");

????? returnnew AsyncResult<>("任務一完成");

?? }

按照如上方式改造一下其他兩個異步函數之后，下面我們改造一下Controller中方法，在等待完成三個異步調用之后來做一些其他事情。

@ApiIgnore

?? @RequestMapping("/test1")

?? publicvoid getTest1() {

????? try{

??????? longstart = System.currentTimeMillis();

??????? Future<String>task1 = task.doTaskOne();

??????? Future<String>task2 = task.doTaskTwo();

??????? Future<String>task3 = task.doTaskThree();

??????? while(true) {

?????????? if(task1.isDone() && task2.isDone() && task3.isDone()) {

????????????? //三個任務都調用完成，退出循環等待

????????????? break;

?????????? }

?????????? Thread.sleep(1000);

??????? }

??????? longend = System.currentTimeMillis();

??????? System.out.println("任務全部完成，總耗時：" + (end - start) + "毫秒");

????? }catch (Exception e) {

??????? e.printStackTrace();

????? }

?? }

看看我們做了哪些改變：

在測試用例一開始記錄開始時間
在調用三個異步函數的時候，返回Future<String>類型的結果對象
在調用完三個異步函數之后，開啟一個循環，根據返回的Future<String>對象來判斷三個異步函數是否都結束了。若都結束，就結束循環；若沒有都結束，就等1秒后再判斷。
跳出循環之后，根據結束時間 - 開始時間，計算出三個任務并發執行的總耗時。

執行一下上述的單元測試，可以看到如下結果：