springboot 中異步處理 調用@Async實現

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

同步調用

下面通過一個簡單示例來直觀的理解什麼是同步調用:

  • 定義Task類,創建三個處理函數分別模擬三個執行任務的操作,操作消耗時間隨機取(10秒內)

 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30


 

@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) + "毫秒");

}

}

  • 在單元測試用例中,注入Task對象,並在測試用例中執行doTaskOnedoTaskTwodoTaskThree三個函數。

 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15


 

@RunWith(SpringJUnit4ClassRunner.class)

@SpringApplicationConfiguration(classes = Application.class)

public class ApplicationTests {

@Autowired

private Task task;

@Test

public void test() throws Exception {

task.doTaskOne();

task.doTaskTwo();

task.doTaskThree();

}

}

  • 執行單元測試,可以看到類似如下輸出:

 

1

2

3

4

5

6


 

開始做任務一

完成任務一,耗時:4256毫秒

開始做任務二

完成任務二,耗時:4957毫秒

開始做任務三

完成任務三,耗時:7173毫秒

任務一、任務二、任務三順序的執行完了,換言之doTaskOnedoTaskTwodoTaskThree三個函數順序的執行完成。

異步調用

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

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


 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19


 

@Component

public class Task {

@Async

public void doTaskOne() throws Exception {

// 同上內容,省略

}

@Async

public void doTaskTwo() throws Exception {

// 同上內容,省略

}

@Async

public void doTaskThree() throws Exception {

// 同上內容,省略

}

}

爲了讓@Async註解能夠生效,還需要在Spring Boot的主程序中配置@EnableAsync,如下所示:


 

1

2

3

4

5

6

7

8

9


 

@SpringBootApplication

@EnableAsync

public class Application {

public static void main(String[] args) {

SpringApplication.run(Application.class, args);

}

}

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

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

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

注: @Async所修飾的函數不要定義爲static類型,這樣異步調用不會生效

異步回調

爲了讓doTaskOnedoTaskTwodoTaskThree能正常結束,假設我們需要統計一下三個任務併發執行共耗時多少,這就需要等到上述三個函數都完成調動之後記錄時間,並計算結果。

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


 

1

2

3

4

5

6

7

8

9


 

@Async

public Future<String> doTaskOne() throws Exception {

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

long start = System.currentTimeMillis();

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

long end = System.currentTimeMillis();

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

return new AsyncResult<>("任務一完成");

}

按照如上方式改造一下其他兩個異步函數之後,下面我們改造一下測試用例,讓測試在等待完成三個異步調用之後來做一些其他事情。


 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22


 

@Test

public void test() throws Exception {

long start = 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);

}

long end = System.currentTimeMillis();

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

}

看看我們做了哪些改變:

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

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


 

1

2

3

4

5

6

7


 

開始做任務一

開始做任務二

開始做任務三

完成任務三,耗時:37毫秒

完成任務二,耗時:3661毫秒

完成任務一,耗時:7149毫秒

任務全部完成,總耗時:8025毫秒

可以看到,通過異步調用,讓任務一、二、三併發執行,有效的減少了程序的總運行時間。

 

Spring Boot中使用@Scheduled創建定時任務

 

 

 

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

創建定時任務

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

  • 在Spring Boot的主類中加入@EnableScheduling註解,啓用定時任務的配置

 

1

2

3

4

5

6

7

8

9

10


 

@SpringBootApplication

@EnableScheduling

public class Application {

public static void main(String[] args) {

SpringApplication.run(Application.class, args);

}

}

  • 創建定時任務實現類

 

1

2

3

4

5

6

7

8

9

10

11


 

@Component

public class ScheduledTasks {

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

@Scheduled(fixedRate = 5000)

public void reportCurrentTime() {

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

}

}

  • 運行程序,控制檯中可以看到類似如下輸出,定時任務開始正常運作了。

 
  1. 2016-05-15 10:40:04.073 INFO 1688 --- [ main] com.didispace.Application : Started Application in 1.433 seconds (JVM running for 1.967)

  2. 現在時間:10:40:09

  3. 現在時間:10:40:14

  4. 現在時間:10:40:19

  5. 現在時間:10:40:24

  6. 現在時間:10:40:29522

  7. 現在時間:10:40:34

關於上述的簡單入門示例也可以參見官方的Scheduling Tasks

@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表達式定義規則

Spring Boot屬性配置文件詳解

相信很多人選擇Spring Boot主要是考慮到它既能兼顧Spring的強大功能,還能實現快速開發的便捷。我們在Spring Boot使用過程中,最直觀的感受就是沒有了原來自己整合Spring應用時繁多的XML配置內容,替代它的是在pom.xml中引入模塊化的Starter POMs,其中各個模塊都有自己的默認配置,所以如果不是特殊應用場景,就只需要在application.properties中完成一些屬性配置就能開啓各模塊的應用。

在之前的各篇文章中都有提及關於application.properties的使用,主要用來配置數據庫連接、日誌相關配置等。除了這些配置內容之外,本文將具體介紹一些在application.properties配置中的其他特性和使用方法。

自定義屬性與加載

我們在使用Spring Boot的時候,通常也需要定義一些自己使用的屬性,我們可以如下方式直接定義:


 

1

2


 

com.didispace.blog.name=wzb

com.didispace.blog.title=Spring Boot教程

然後通過@Value("${屬性名}")註解來加載對應的配置屬性,具體如下:


 

1

2

3

4

5

6

7

8

9

10

11


 

@Component

public class BlogProperties {

@Value("${com.didispace.blog.name}")

private String name;

@Value("${com.didispace.blog.title}")

private String title;

// 省略getter和setter

}

按照慣例,通過單元測試來驗證BlogProperties中的屬性是否已經根據配置文件加載了。


 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15


 

@RunWith(SpringJUnit4ClassRunner.class)

@SpringApplicationConfiguration(Application.class)

public class ApplicationTests {

@Autowired

private BlogProperties blogProperties;

@Test

public void getHello() throws Exception {

Assert.assertEquals(blogProperties.getName(), "wzb");

Assert.assertEquals(blogProperties.getTitle(), "Spring Boot教程");

}

}

參數間的引用

application.properties中的各個參數之間也可以直接引用來使用,就像下面的設置:


 

1

2

3


 

com.didispace.blog.name=wzb

com.didispace.blog.title=Spring Boot教程

com.didispace.blog.desc=${com.didispace.blog.name}正在努力寫《${com.didispace.blog.title}》

com.didispace.blog.desc參數引用了上文中定義的nametitle屬性,最後該屬性的值就是程序猿DD正在努力寫《Spring Boot教程》

使用隨機數

在一些情況下,有些參數我們需要希望它不是一個固定的值,比如密鑰、服務端口等。Spring Boot的屬性配置文件中可以通過${random}來產生int值、long值或者string字符串,來支持屬性的隨機值。


 

1

2

3

4

5

6

7

8

9

10


 

# 隨機字符串

com.didispace.blog.value=${random.value}

# 隨機int

com.didispace.blog.number=${random.int}

# 隨機long

com.didispace.blog.bignumber=${random.long}

# 10以內的隨機數

com.didispace.blog.test1=${random.int(10)}

# 10-20的隨機數

com.didispace.blog.test2=${random.int[10,20]}

通過命令行設置屬性值

相信使用過一段時間Spring Boot的用戶,一定知道這條命令:java -jar xxx.jar --server.port=8888,通過使用–server.port屬性來設置xxx.jar應用的端口爲8888。

在命令行運行時,連續的兩個減號--就是對application.properties中的屬性值進行賦值的標識。所以,java -jar xxx.jar --server.port=8888命令,等價於我們在application.properties中添加屬性server.port=8888,該設置在樣例工程中可見,讀者可通過刪除該值或使用命令行來設置該值來驗證。

通過命令行來修改屬性值固然提供了不錯的便利性,但是通過命令行就能更改應用運行的參數,那豈不是很不安全?是的,所以Spring Boot也貼心的提供了屏蔽命令行訪問屬性的設置,只需要這句設置就能屏蔽:SpringApplication.setAddCommandLineProperties(false)

多環境配置

我們在開發Spring Boot應用時,通常同一套程序會被應用和安裝到幾個不同的環境,比如:開發、測試、生產等。其中每個環境的數據庫地址、服務器端口等等配置都會不同,如果在爲不同環境打包時都要頻繁修改配置文件的話,那必將是個非常繁瑣且容易發生錯誤的事。

對於多環境的配置,各種項目構建工具或是框架的基本思路是一致的,通過配置多份不同環境的配置文件,再通過打包命令指定需要打包的內容之後進行區分打包,Spring Boot也不例外,或者說更加簡單。

在Spring Boot中多環境配置文件名需要滿足application-{profile}.properties的格式,其中{profile}對應你的環境標識,比如:

  • application-dev.properties:開發環境
  • application-test.properties:測試環境
  • application-prod.properties:生產環境

至於哪個具體的配置文件會被加載,需要在application.properties文件中通過spring.profiles.active屬性來設置,其值對應{profile}值。

如:spring.profiles.active=test就會加載application-test.properties配置文件內容

下面,以不同環境配置不同的服務端口爲例,進行樣例實驗。

  • 針對各環境新建不同的配置文件application-dev.propertiesapplication-test.propertiesapplication-prod.properties

  • 在這三個文件均都設置不同的server.port屬性,如:dev環境設置爲1111,test環境設置爲2222,prod環境設置爲3333

  • application.properties中設置spring.profiles.active=dev,就是說默認以dev環境設置

  • 測試不同配置的加載

    • 執行java -jar xxx.jar,可以觀察到服務端口被設置爲1111,也就是默認的開發環境(dev)
    • 執行java -jar xxx.jar --spring.profiles.active=test,可以觀察到服務端口被設置爲2222,也就是測試環境的配置(test)
    • 執行java -jar xxx.jar --spring.profiles.active=prod,可以觀察到服務端口被設置爲3333,也就是生產環境的配置(prod)

按照上面的實驗,可以如下總結多環境的配置思路:

  • application.properties中配置通用內容,並設置spring.profiles.active=dev,以開發環境爲默認配置
  • application-{profile}.properties中配置各個環境不同的內容
  • 通過命令行方式去激活不同環境的配置

Spring Boot中Web應用的統一異常處理

我們在做Web應用的時候,請求處理過程中發生錯誤是非常常見的情況。Spring Boot提供了一個默認的映射:/error,當處理中拋出異常之後,會轉到該請求中處理,並且該請求有一個全局的錯誤頁面用來展示異常內容。

選擇一個之前實現過的Web應用(Chapter3-1-2)爲基礎,啓動該應用,訪問一個不存在的URL,或是修改處理內容,直接拋出異常,如:


 

1

2

3

4


 

@RequestMapping("/hello")

public String hello() throws Exception {

throw new Exception("發生錯誤");

}

此時,可以看到類似下面的報錯頁面,該頁面就是Spring Boot提供的默認error映射頁面。

alt=默認的錯誤頁面alt=默認的錯誤頁面

統一異常處理

雖然,Spring Boot中實現了默認的error映射,但是在實際應用中,上面你的錯誤頁面對用戶來說並不夠友好,我們通常需要去實現我們自己的異常提示。

下面我們以之前的Web應用例子爲基礎(Chapter3-1-2),進行統一異常處理的改造。

  • 創建全局異常處理類:通過使用@ControllerAdvice定義統一的異常處理類,而不是在每個Controller中逐個定義。@ExceptionHandler用來定義函數針對的異常類型,最後將Exception對象和請求URL映射到error.html

 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15


 

@ControllerAdvice

class GlobalExceptionHandler {

public static final String DEFAULT_ERROR_VIEW = "error";

@ExceptionHandler(value = Exception.class)

public ModelAndView defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {

ModelAndView mav = new ModelAndView();

mav.addObject("exception", e);

mav.addObject("url", req.getRequestURL());

mav.setViewName(DEFAULT_ERROR_VIEW);

return mav;

}

}

  • 實現error.html頁面展示:在templates目錄下創建error.html,將請求的URL和Exception對象的message輸出。

 

1

2

3

4

5

6

7

8

9

10

11

12


 

<!DOCTYPE html>

<html>

<head lang="en">

<meta charset="UTF-8" />

<title>統一異常處理</title>

</head>

<body>

<h1>Error Handler</h1>

<div th:text="${url}"></div>

<div th:text="${exception.message}"></div>

</body>

</html>

啓動該應用,訪問:http://localhost:8080/hello,可以看到如下錯誤提示頁面。

alt=自定義的錯誤頁面alt=自定義的錯誤頁面

通過實現上述內容之後,我們只需要在Controller中拋出Exception,當然我們可能會有多種不同的Exception。然後在@ControllerAdvice類中,根據拋出的具體Exception類型匹配@ExceptionHandler中配置的異常類型來匹配錯誤映射和處理。

返回JSON格式

在上述例子中,通過@ControllerAdvice統一定義不同Exception映射到不同錯誤處理頁面。而當我們要實現RESTful API時,返回的錯誤是JSON格式的數據,而不是HTML頁面,這時候我們也能輕鬆支持。

本質上,只需在@ExceptionHandler之後加入@ResponseBody,就能讓處理函數return的內容轉換爲JSON格式。

下面以一個具體示例來實現返回JSON格式的異常處理。

  • 創建統一的JSON返回對象,code:消息類型,message:消息內容,url:請求的url,data:請求返回的數據

 

1

2

3

4

5

6

7

8

9

10

11

12

13


 

public class ErrorInfo<T> {

public static final Integer OK = 0;

public static final Integer ERROR = 100;

private Integer code;

private String message;

private String url;

private T data;

// 省略getter和setter

}

  • 創建一個自定義異常,用來實驗捕獲該異常,並返回json

 

1

2

3

4

5

6

7


 

public class MyException extends Exception {

public MyException(String message) {

super(message);

}

}

  • Controller中增加json映射,拋出MyException異常

 

1

2

3

4

5

6

7

8

9


 

@Controller

public class HelloController {

@RequestMapping("/json")

public String json() throws MyException {

throw new MyException("發生錯誤2");

}

}

  • MyException異常創建對應的處理

 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15


 

@ControllerAdvice

public class GlobalExceptionHandler {

@ExceptionHandler(value = MyException.class)

@ResponseBody

public ErrorInfo<String> jsonErrorHandler(HttpServletRequest req, MyException e) throws Exception {

ErrorInfo<String> r = new ErrorInfo<>();

r.setMessage(e.getMessage());

r.setCode(ErrorInfo.ERROR);

r.setData("Some Data");

r.setUrl(req.getRequestURL().toString());

return r;

}

}


 

1

2

3

4

5

6


 

{

code: 100,

data: "Some Data",

message: "發生錯誤2",

url: "http://localhost:8080/json"

}

至此,已完成在Spring Boot中創建統一的異常處理,實際實現還是依靠Spring MVC的註解,更多更深入的使用可參考Spring MVC的文檔。

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章