Spring中@Configuration@EnableAsync@Async用法總結

引言： 在Java應用中，絕大多數狀況下都是經過同步的方式來實現交互處理的；可是在處理與第三方系統交互的時候，容易形成響應遲緩的狀況，以前大部分都是使用多線程來完成此類任務，其實，在spring 3.x以後，就已經內置了@Async來完美解決這個問題，本文將完成介紹@Async的用法。

1.  何爲異步調用？

    在解釋異步調用以前，咱們先來看同步調用的定義；同步就是整個處理過程順序執行，當各個過程都執行完畢，並返回結果。 異步調用則是隻是發送了調用的指令，調用者無需等待被調用的方法徹底執行完畢；而是繼續執行下面的流程。

     例如， 在某個調用中，須要順序調用 A, B, C三個過程方法；如他們都是同步調用，則須要將他們都順序執行完畢以後，方算做過程執行完畢； 如B爲一個異步的調用方法，則在執行完A以後，調用B，並不等待B完成，而是執行開始調用C，待C執行完畢以後，就意味着這個過程執行完畢了。

2.  常規的異步調用處理方式

    在Java中，通常在處理相似的場景之時，都是基於建立獨立的線程去完成相應的異步調用邏輯，經過主線程和不一樣的線程之間的執行流程，從而在啓動獨立的線程以後，主線程繼續執行而不會產生停滯等待的狀況。

3. @Async介紹

   在Spring中，基於@Async標註的方法，稱之爲異步方法；這些方法將在執行的時候，將會在獨立的線程中被執行，調用者無需等待它的完成，便可繼續其餘的操做。

     如何在Spring中啓用@Async

       基於Java配置的啓用方式：

 

[html] view plain copy

 

1. @Configuration  
2. @EnableAsync  
3. public class SpringAsyncConfig { ... }  

     基於XML配置文件的啓用方式，配置以下：

 

 

[html] view plain copy

 

1. <task:executor id="myexecutor" pool-size="5"  />  
2. <task:annotation-driven executor="myexecutor"/>  

   以上就是兩種定義的方式。

 

4. 基於@Async無返回值調用

    示例以下：

[html] view plain copy

 

1. @Async  //標註使用  
2. public void asyncMethodWithVoidReturnType() {  
3.     System.out.println("Execute method asynchronously. "  
4.       + Thread.currentThread().getName());  
5. }  

  使用的方式很是簡單，一個標註便可解決全部的問題。

 

5. 基於@Async返回值的調用

   示例以下：

 

[html] view plain copy

 

1. @Async  
2. public Future<String> asyncMethodWithReturnType() {  
3.     System.out.println("Execute method asynchronously - "  
4.       + Thread.currentThread().getName());  
5.     try {  
6.         Thread.sleep(5000);  
7.         return new AsyncResult<String>("hello world !!!!");  
8.     } catch (InterruptedException e) {  
9.         //  
10.     }  
11.    
12.     return null;  
13. }  

   以上示例能夠發現，返回的數據類型爲Future類型，其爲一個接口。具體的結果類型爲AsyncResult,這個是須要注意的地方。

 

   調用返回結果的異步方法示例：

 

[html] view plain copy

 

1. public void testAsyncAnnotationForMethodsWithReturnType()  
2.    throws InterruptedException, ExecutionException {  
3.     System.out.println("Invoking an asynchronous method. "  
4.       + Thread.currentThread().getName());  
5.     Future<String> future = asyncAnnotationExample.asyncMethodWithReturnType();  
6.    
7.     while (true) {  ///這裏使用了循環判斷，等待獲取結果信息  
8.         if (future.isDone()) {  //判斷是否執行完畢  
9.             System.out.println("Result from asynchronous process - " + future.get());  
10.             break;  
11.         }  
12.         System.out.println("Continue doing something else. ");  
13.         Thread.sleep(1000);  
14.     }  
15. }  

  分析： 這些獲取異步方法的結果信息，是經過不停的檢查Future的狀態來獲取當前的異步方法是否執行完畢來實現的。

 

6. 基於@Async調用中的異常處理機制

    在異步方法中，若是出現異常，對於調用者caller而言，是沒法感知的。若是確實須要進行異常處理，則按照以下方法來進行處理：

    1.  自定義實現AsyncTaskExecutor的任務執行器

         在這裏定義處理具體異常的邏輯和方式。

    2.  配置由自定義的TaskExecutor替代內置的任務執行器

    示例步驟1，自定義的TaskExecutor

 

[html] view plain copy

 

1. public class ExceptionHandlingAsyncTaskExecutor implements AsyncTaskExecutor {  
2.     private AsyncTaskExecutor executor;  
3.     public ExceptionHandlingAsyncTaskExecutor(AsyncTaskExecutor executor) {  
4.         this.executor = executor;  
5.      }  
6.       ////用獨立的線程來包裝，@Async其本質就是如此  
7.     public void execute(Runnable task) {       
8.       executor.execute(createWrappedRunnable(task));  
9.     }  
10.     public void execute(Runnable task, long startTimeout) {  
11.         /用獨立的線程來包裝，@Async其本質就是如此  
12.        executor.execute(createWrappedRunnable(task), startTimeout);           
13.     }   
14.     public Future submit(Runnable task) { return executor.submit(createWrappedRunnable(task));  
15.        //用獨立的線程來包裝，@Async其本質就是如此。  
16.     }   
17.     public Future submit(final Callable task) {  
18.       //用獨立的線程來包裝，@Async其本質就是如此。  
19.        return executor.submit(createCallable(task));   
20.     }   
21.       
22.     private Callable createCallable(final Callable task) {   
23.         return new Callable() {   
24.             public T call() throws Exception {   
25.                  try {   
26.                      return task.call();   
27.                  } catch (Exception ex) {   
28.                      handle(ex);   
29.                      throw ex;   
30.                    }   
31.                  }   
32.         };   
33.     }  
34.   
35.     private Runnable createWrappedRunnable(final Runnable task) {   
36.          return new Runnable() {   
37.              public void run() {   
38.                  try {  
39.                      task.run();   
40.                   } catch (Exception ex) {   
41.                      handle(ex);   
42.                    }   
43.             }  
44.         };   
45.     }   
46.     private void handle(Exception ex) {  
47.       //具體的異常邏輯處理的地方  
48.       System.err.println("Error during @Async execution: " + ex);  
49.     }  
50. }  

 分析： 能夠發現其是實現了AsyncTaskExecutor, 用獨立的線程來執行具體的每一個方法操做。在createCallable和createWrapperRunnable中，定義了異常的處理方式和機制。

 

handle()就是將來咱們須要關注的異常處理的地方。

      配置文件中的內容：

 

[html] view plain copy

 

1. <task:annotation-driven executor="exceptionHandlingTaskExecutor" scheduler="defaultTaskScheduler" />  
2. <bean id="exceptionHandlingTaskExecutor" class="nl.jborsje.blog.examples.ExceptionHandlingAsyncTaskExecutor">  
3.     <constructor-arg ref="defaultTaskExecutor" />  
4. </bean>  
5. <task:executor id="defaultTaskExecutor" pool-size="5" />  
6. <task:scheduler id="defaultTaskScheduler" pool-size="1" />  

  分析： 這裏的配置使用自定義的taskExecutor來替代缺省的TaskExecutor。

 

7. @Async調用中的事務處理機制

    在@Async標註的方法，同時也適用了@Transactional進行了標註；在其調用數據庫操做之時，將沒法產生事務管理的控制，緣由就在於其是基於異步處理的操做。

     那該如何給這些操做添加事務管理呢？能夠將須要事務管理操做的方法放置到異步方法內部，在內部被調用的方法上添加@Transactional.

    例如：  方法A，使用了@Async/@Transactional來標註，可是沒法產生事務控制的目的。

          方法B，使用了@Async來標註，  B中調用了C、D，C/D分別使用@Transactional作了標註，則可實現事務控制的目的。

8. 總結

     經過以上的描述，應該對@Async使用的方法和注意事項了。