SpringBoot中非同步請求和非同步呼叫（看這一篇就夠了）

SpringBoot · 發表 2019-04-06 22:33:00

摘要：一、SpringBoot中非同步請求的使用 1、非同步請求與同步請求特點：可以先釋放容器分配給請求的執行緒與相關資源，減輕系統負擔，釋放了容器所分配執行緒的請求，其響應將被延後，可以在耗時處理完成（例如長時間的運算）時再對客戶端進行響應。一句話：增加了伺...

一、SpringBoot中非同步請求的使用

1、非同步請求與同步請求

特點：

可以先釋放容器分配給請求的執行緒與相關資源，減輕系統負擔，釋放了容器所分配執行緒的請求，其響應將被延後，可以在耗時處理完成（例如長時間的運算）時再對客戶端進行響應。一句話：增加了伺服器對客戶端請求的吞吐量（實際生產上我們用的比較少，如果併發請求量很大的情況下，我們會通過nginx把請求負載到叢集服務的各個節點上來分攤請求壓力，當然還可以通過訊息佇列來做請求的緩衝）。

2、非同步請求的實現

方式一：Servlet方式實現非同步請求

@RequestMapping(value = "/email/servletReq", method = GET)
public void servletReq (HttpServletRequest request, HttpServletResponse response) {
AsyncContext asyncContext = request.startAsync();
//設定監聽器:可設定其開始、完成、異常、超時等事件的回撥處理
asyncContext.addListener(new AsyncListener() {
@Override
public void onTimeout(AsyncEvent event) throws IOException {
System.out.println("超時了...");
//做一些超時後的相關操作...
}
@Override
public void onStartAsync(AsyncEvent event) throws IOException {
System.out.println("執行緒開始");
}
@Override
public void onError(AsyncEvent event) throws IOException {
System.out.println("發生錯誤："+event.getThrowable());
}
@Override
public void onComplete(AsyncEvent event) throws IOException {
System.out.println("執行完成");
//這裡可以做一些清理資源的操作...
}
});
//設定超時時間
asyncContext.setTimeout(20000);
asyncContext.start(new Runnable() {
@Override
public void run() {
try {
Thread.sleep(10000);
System.out.println("內部執行緒：" + Thread.currentThread().getName());
asyncContext.getResponse().setCharacterEncoding("utf-8");
asyncContext.getResponse().setContentType("text/html;charset=UTF-8");
asyncContext.getResponse().getWriter().println("這是非同步的請求返回");
} catch (Exception e) {
System.out.println("異常："+e);
}
//非同步請求完成通知
//此時整個請求才完成
asyncContext.complete();
}
});
//此時之類 request的執行緒連線已經釋放了
System.out.println("主執行緒：" + Thread.currentThread().getName());
}

方式二：使用很簡單，直接返回的引數包裹一層callable即可，可以繼承WebMvcConfigurerAdapter類來設定預設執行緒池和超時處理

@RequestMapping(value = "/email/callableReq", method = GET)
@ResponseBody
public Callable<String> callableReq () {
System.out.println("外部執行緒：" + Thread.currentThread().getName());

return new Callable<String>() {

@Override
public String call() throws Exception {
Thread.sleep(10000);
System.out.println("內部執行緒：" + Thread.currentThread().getName());
return "callable!";
}
};
}

@Configuration
public class RequestAsyncPoolConfig extends WebMvcConfigurerAdapter {

@Resource
private ThreadPoolTaskExecutor myThreadPoolTaskExecutor;

@Override
public void configureAsyncSupport(final AsyncSupportConfigurer configurer) {
//處理 callable超時
configurer.setDefaultTimeout(60*1000);
configurer.setTaskExecutor(myThreadPoolTaskExecutor);
configurer.registerCallableInterceptors(timeoutCallableProcessingInterceptor());
}

@Bean
public TimeoutCallableProcessingInterceptor timeoutCallableProcessingInterceptor() {
return new TimeoutCallableProcessingInterceptor();
}

}

方式三：和方式二差不多，在Callable外包一層，給WebAsyncTask設定一個超時回撥，即可實現超時處理

@RequestMapping(value = "/email/webAsyncReq", method = GET)
@ResponseBody
public WebAsyncTask<String> webAsyncReq () {
System.out.println("外部執行緒：" + Thread.currentThread().getName());
Callable<String> result = () -> {
System.out.println("內部執行緒開始：" + Thread.currentThread().getName());
try {
TimeUnit.SECONDS.sleep(4);
} catch (Exception e) {
// TODO: handle exception
}
logger.info("副執行緒返回");
System.out.println("內部執行緒返回：" + Thread.currentThread().getName());
return "success";
};
WebAsyncTask<String> wat = new WebAsyncTask<String>(3000L, result);
wat.onTimeout(new Callable<String>() {

@Override
public String call() throws Exception {
// TODO Auto-generated method stub
return "超時";
}
});
return wat;
}

方式四：DeferredResult可以處理一些相對複雜一些的業務邏輯，最主要還是可以在另一個執行緒裡面進行業務處理及返回，即可在兩個完全不相干的執行緒間的通訊。

@RequestMapping(value = "/email/deferredResultReq", method = GET)
@ResponseBody
public DeferredResult<String> deferredResultReq () {
System.out.println("外部執行緒：" + Thread.currentThread().getName());
//設定超時時間
DeferredResult<String> result = new DeferredResult<String>(60*1000L);
//處理超時事件 採用委託機制
result.onTimeout(new Runnable() {

@Override
public void run() {
System.out.println("DeferredResult超時");
result.setResult("超時了!");
}
});
result.onCompletion(new Runnable() {

@Override
public void run() {
//完成後
System.out.println("呼叫完成");
}
});
myThreadPoolTaskExecutor.execute(new Runnable() {

@Override
public void run() {
//處理業務邏輯
System.out.println("內部執行緒：" + Thread.currentThread().getName());
//返回結果
result.setResult("DeferredResult!!");
}
});
return result;
}

二、SpringBoot中非同步呼叫的使用

1、介紹

非同步請求的處理。除了非同步請求，一般上我們用的比較多的應該是非同步呼叫。通常在開發過程中，會遇到一個方法是和實際業務無關的，沒有緊密性的。比如記錄日誌資訊等業務。這個時候正常就是啟一個新執行緒去做一些業務處理，讓主執行緒非同步的執行其他業務。

2、使用方式（基於spring下）

需要在啟動類加入@EnableAsync使非同步呼叫@Async註解生效
在需要非同步執行的方法上加入此註解即可@Async("threadPool"),threadPool為自定義執行緒池
程式碼略。。。就倆標籤，自己試一把就可以了

3、注意事項
在預設情況下，未設定TaskExecutor時，預設是使用SimpleAsyncTaskExecutor這個執行緒池，但此執行緒不是真正意義上的執行緒池，因為執行緒不重用，每次呼叫都會建立一個新的執行緒。可通過控制檯日誌輸出可以看出，每次輸出執行緒名都是遞增的。所以最好我們來自定義一個執行緒池。
呼叫的非同步方法，不能為同一個類的方法（包括同一個類的內部類），簡單來說，因為Spring在啟動掃描時會為其建立一個代理類，而同類呼叫時，還是呼叫本身的代理類的，所以和平常呼叫是一樣的。其他的註解如@Cache等也是一樣的道理，說白了，就是Spring的代理機制造成的。所以在開發中，最好把非同步服務單獨抽出一個類來管理。下面會重點講述。。

4、什麼情況下會導致@Async非同步方法會失效？

呼叫同一個類下注有@Async非同步方法：在spring中像@Async和@Transactional、cache等註解本質使用的是動態代理，其實Spring容器在初始化的時候Spring容器會將含有AOP註解的類物件“替換”為代理物件（簡單這麼理解），那麼註解失效的原因就很明顯了，就是因為呼叫方法的是物件本身而不是代理物件，因為沒有經過Spring容器，那麼解決方法也會沿著這個思路來解決。
呼叫的是靜態(static )方法
呼叫(private)私有化方法

5、解決4中問題1的方式（其它2,3兩個問題自己注意下就可以了）
將要非同步執行的方法單獨抽取成一個類，原理就是當你把執行非同步的方法單獨抽取成一個類的時候，這個類肯定是被Spring管理的，其他Spring元件需要呼叫的時候肯定會注入進去，這時候實際上注入進去的就是代理類了。

其實我們的注入物件都是從Spring容器中給當前Spring元件進行成員變數的賦值，由於某些類使用了AOP註解，那麼實際上在Spring容器中實際存在的是它的代理物件。那麼我們就可以通過上下文獲取自己的代理物件呼叫非同步方法。

@Controller
@RequestMapping("/app")
public class EmailController {

//獲取ApplicationContext物件方式有多種,這種最簡單,其它的大家自行了解一下
@Autowired
private ApplicationContext applicationContext;

@RequestMapping(value = "/email/asyncCall", method = GET)
@ResponseBody
public Map<String, Object> asyncCall () {
Map<String, Object> resMap = new HashMap<String, Object>();
try{
//這樣呼叫同類下的非同步方法是不起作用的
//this.testAsyncTask();
//通過上下文獲取自己的代理物件呼叫非同步方法
EmailController emailController = (EmailController)applicationContext.getBean(EmailController.class);
emailController.testAsyncTask();
resMap.put("code",200);
}catch (Exception e) {
resMap.put("code",400);
logger.error("error!",e);
}
return resMap;
}

//注意一定是public,且是非static方法
@Async
public void testAsyncTask() throws InterruptedException {
Thread.sleep(10000);
System.out.println("非同步任務執行完成！");
}

}

開啟cglib代理，手動獲取Spring代理類,從而呼叫同類下的非同步方法。

首先，在啟動類上加上@EnableAspectJAutoProxy(exposeProxy = true)註解。

程式碼實現，如下：

@Controller
@RequestMapping("/app")
public class EmailController {

@RequestMapping(value = "/email/asyncCall", method = GET)
@ResponseBody
public Map<String, Object> asyncCall () {

Map<String, Object> resMap = new HashMap<String, Object>();
try{
EmailController proxy = (EmailController)AopContext.currentProxy();
proxy.testAsyncTask();
System.out.println("end!");
resMap.put("code", ResultStatusCode.SUCCESS.getCode());
}catch (Exception e) {
resMap.put("code", ResultStatusCode.FAILED.getCode());
logger.error("",e);
}
return resMap;
}

//注意一定是public,且是非static方法
@Async
public void testAsyncTask() throws InterruptedException {
Thread.sleep(10000);
System.out.println("非同步任務執行完成！");
}
}

三、非同步請求與非同步呼叫的區別

兩者的使用場景不同，非同步請求用來解決併發請求對伺服器造成的壓力，從而提高對請求的吞吐量；而非同步呼叫是用來做一些非主線流程且不需要實時計算和響應的任務，比如同步日誌到kafka中做日誌分析等。
非同步請求是會一直等待response相應的，需要返回結果給客戶端的；而非同步呼叫我們往往會馬上返回給客戶端響應，完成這次整個的請求，至於非同步呼叫的任務後臺自己慢慢跑就行，客戶端不會關心。

四、總結

非同步請求和非同步呼叫的使用到這裡基本就差不多了，有問題還希望大家多多指出。
這邊文章提到了動態代理，而spring中Aop的實現原理就是動態代理，後續會對動態代理做詳細解讀，還望多多支援哈~

個人部落格地址：

csdn: https://blog.csdn.net/tiantuo6513

cnblogs: https://www.cnblogs.com/baixianlong

segmentfault: https://segmentfault.com/u/baixianlong

github:https://github.com/xianlongbai