你好呀,我是why。
我之前寫過一些關於線程池的文章,然后有同學去翻了一圈,發現我沒有寫過一篇關於 @Async
注解的文章,於是他來問我:

是的,我攤牌了。
我不喜歡這個注解的原因,是因為我壓根就沒用過。

我習慣用自定義線程池的方式去做一些異步的邏輯,且這么多年一直都是這樣用的。
所以如果是我主導的項目,你在項目里面肯定是看不到 @Async
注解的。
那我之前見過 @Async
注解嗎?
肯定是見過啊,有的朋友就喜歡用這個注解。
一個注解就搞定異步開發,多爽啊。
我不知道用這個注解的人知不知道其原理,反正我是不知道的。
最近開發的時候引入了一個組件,發現調用的方法里面,有的地方用到了這個注解。
既然這次用到了,那就研究一下吧。
首先需要說明的是,本文並不會寫線程池相關的知識點。
僅描述我是通過什么方式,去了解這個我之前一無所知的注解的。
搞個 Demo
不知道大家如果碰到這種情況會去怎么下手啊。
但是我認為不論是從什么角度去下手的,最后一定是會落到源碼里面的。
所以,我一般是先搞個 Demo。
Demo 非常簡單啊,就三個類。
首先是啟動類,這沒啥說的:

然后搞個 service:

這個 service 里面的 syncSay 方法被打上了 @Async
注解。
最后,搞個 Controller 來調用它,完事:

Demo 就搭建好了,你也動手去搞一個,耗時超過 5 分鍾,算我輸。
然后,把項目啟動起來,調用接口,查看日志:

我去,從線程名稱來看,這也沒異步呀?
怎么還是 tomcat 的線程呢?
於是,我就遇到了研究路上的第一個問題:@Async
注解沒有生效。
為啥不生效?
為什么不生效呢?
我也是懵逼的,我說了之前對這個注解一無所知,那我怎么知道呢?
那遇到這個問題的時候會怎么辦?
當然是面向瀏覽器編程啦!
這個地方,如果我自己從源碼里面去分析為啥沒生效,一定也能查出原因。
但是,如果我面向瀏覽器編程,只需要 30 秒,我就能查到這兩個信息:
失效原因:
-
1. @SpringBootApplication
啟動類當中沒有添加@EnableAsync
注解。 -
2.沒有走 Spring 的代理類。因為 @Transactional
和@Async
注解的實現都是基於 Spring 的 AOP,而 AOP 的實現是基於動態代理模式實現的。那么注解失效的原因就很明顯了,有可能因為調用方法的是對象本身而不是代理對象,因為沒有經過 Spring 容器管理。
很顯然,我這個情況符合第一種情況,沒有添加 @EnableAsync
注解。
另外一個原因,我也很感興趣,但是現在我的首要任務是把 Demo 搭建好,所以不能被其他信息給誘惑了。
很多同學帶着問題去查詢的時候,本來查的問題是@Async
注解為什么沒有生效,結果慢慢的就走偏了,十五分鍾后問題就逐漸演變為了 SpringBoot 的啟動流程。
再過半小時,網頁上就顯示的是一些面試必背八股文之類的東西...
我說這個意思就是,查問題就好好查問題。查問題的過程中肯定會由這個問題引發的自己更加感興趣的問題。但是,記錄下來,先不要讓問題發散。
這個道理,就和帶着問題去看源碼一樣,看着看着,可能連自己的問題是什么都不知道了。

好了,說回來。
我在啟動類上加上該注解:

再次發起調用:

可以看到線程名字變了,說明真的就好了。
現在我的 Demo 已經搭好了,可以開始找角度去卷了。
從上面的日志我也能知道,在默認情況下有一個線程前綴為 task-
的線程池在幫我執行任務。
說到線程池,我就得知道這個線程池的相關配置才放心。
那么我怎么才能知道呢?
先壓一壓
其實正常人的思路這個時候就應該是去翻源碼,找對應的注入線程池的地方。
而我,就有點不正常了,我懶得去源碼里面找,我想讓它自己暴露到我的面前。
怎么讓它暴露出來呢?
仗着我對線程池的了解,我的第一個思路是先壓一壓這個線程池。
壓爆它,壓的它處理不過來任務,讓它走到拒絕邏輯里面去,正常來說是會拋出異常的吧?

於是,我把程序稍微改造了一下:

想的是直接來一波大力出奇跡:

結果...
它竟然...
照單全收了,沒有異常?
日志一秒打幾行,打的很歡樂:

雖然沒有出現我預想的拒絕異常,但是我從日志里面還是看出了一點點端倪。
比如我就發現這個 taks 最多就到 8:

朋友們,你說這是啥意思?
是不是就是說這個我正在尋找的線程池的核心線程數的配置是 8 ?
什么,你問我為什么不能是最大線程數?
有可能嗎?
當然有可能。但是我 10000 個任務發過來,沒有觸發線程池拒絕策略,剛好把最大線程池給用完了?
也就是說這個線程池的配置是隊列長度 9992,最大線程數 8 ?
這也太巧合了且不合理了吧?
所以我覺得核心線程數配置是 8 ,隊列長度應該是 Integer.MAX_VALUE
。
為了證實我的猜想,我把請求改成了這樣:

num=一千萬。
通過 jconsole 觀察堆內存使用情況:

那叫一個飆升啊,點擊【執行GC】按鈕也沒有任何緩解。
也從側面證明了:任務有可能都進隊列里面排隊了,導致內存飆升。
雖然,我現在還不知道它的配置是什么,但是經過剛剛的黑盒測試,我有正當的理由懷疑:
默認的線程池有導致內存溢出的風險。

但是,同時也意味着我想從讓它拋出異常,從而自己暴露在我面前的騷想法落空。
懟源碼
前面的思路走不通,老老實實的開始懟源碼吧。
我是從這個注解開始懟的:

點進這個注解之后,幾段英文,不長,我從里面獲取到了一個關鍵信息:

主要關注我畫線的地方。
In terms of target method signatures, any parameter types are supported.
在目標方法的簽名中,入參是任何類型都支持的。
多說一句:這里說到目標方法,說到 target,大家腦海里面應該是要立刻出現一個代理對象的概念的。
上面這句話好理解,甚至感覺是一句廢話。
但是,它緊跟了一個 However:
However, the return type is constrained to either void or Future.

constrained,受限制,被約束的意思。
這句話是說:返回類型被限制為 void 或者 Future。
啥意思呢?
那我偏要返回一個 String 呢?

WTF,打印出來的居然是 null !?

那這里如果我返回一個對象,豈不是很容易爆出空指針異常?
看完注解上的注釋之后,我發現了第二個隱藏的坑:
如果被
@Async
注解修飾的方法,返回值只能是 void 或者 Future。
void 就不說了,說說這個 Future。
看我划線的另外一句:
it will have to return a temporary {@code Future} handle that just passes a value through: e.g. Spring's {@link AsyncResult}
上有一個 temporary,是四級詞匯啊,應該認識的,就是短暫的、暫時的意思。
temporary worker,臨時工,明白吧。
所以意思就是如果你要返回值,你就用 AsyncResult 對象來包一下,這個 AsyncResult 就是 temporary worker。
就像這樣:

接着我們把目光放到注解的 value 屬性上:

這個注解,看注釋上面的意思,就是說這個應該填一個線程池的 bean 名稱,相當於指定線程池的意思。
也不知道理解的對不對,等會寫個方法驗證一下就知道了。
好了,到現在,我把信息整理匯總一下。
-
我之前完全不懂這個注解,現在我有一個 Demo 了,搭建 Demo 的時候我發現除了 @Async
注解之外,還需要加上@EnableAsync
注解,比如加在啟動類上。 -
然后把這個默認的線程池當做黑盒測試了一把,我懷疑它的核心線程數默認是 8,隊列長度無線長。有內存溢出的風險。 -
通過閱讀 @Async
上的注解,我發現返回值只能是 void 或者 Future 類型,否則即使返回了其他值,不會報錯,但是返回的值是 null,有空指針風險。 -
@Async
注解中有一個 value 屬性,看注釋應該是可以指定自定義線程池的。
接下來我把要去探索的問題排個序,只聚焦到 @Async
的相關問題上:
-
1.默認線程池的具體配置是什么? -
2.源碼是怎么做到只支持 void 和 Future 的? -
3.value 屬性是干什么用的?
具體配置是啥?
我找到具體配置其實是一個很快的過程。
因為這個類的 value 參數簡直太友好了:

五處調用的地方,其中四處都是注釋。
有效的調用就這一個地方,直接先打上斷點再說:
org.springframework.scheduling.annotation.AnnotationAsyncExecutionInterceptor#getExecutorQualifier
發起調用之后,果然跑到了斷點這個地方:

順着斷點往下調試,就會來到這個地方:
org.springframework.aop.interceptor.AsyncExecutionAspectSupport#determineAsyncExecutor

這個代碼結構非常的清晰。
編號為 ① 的地方,是獲取對應方法上的 @Async
注解的 value 值。這個值其實就是 bean 名稱,如果不為空則從 Spring 容器中獲取對應的 bean。
如果 value 是沒有值的,也就是我們 Demo 的這種情況,會走到編號為 ② 的地方。
這個地方就是我要找的默認的線程池。
最后,不論是默認的線程池還是 Spring 容器中我們自定義的線程池。
都會以方法為維度,在 map 中維護方法和線程池的映射關系。
也就是編號為 ③ 的這一步,代碼中的 executors 就是一個 map:

所以,我要找的東西,就是編號為 ② 的這個地方的邏輯。
這里面主要是一個 defaultExecutor 對象:

這個玩意是一個函數式編程,所以如果你不知道這個玩意是干什么的,調試起來可能有點懵逼:
我建議你去惡補一下, 10 分鍾就能入門。

最終你會調試到這個地方來:
org.springframework.aop.interceptor.AsyncExecutionAspectSupport#getDefaultExecutor

這個代碼就有點意思了,就是從 BeanFactory 里面獲取一個默認的線程池相關的 Bean 出來。流程很簡單,日志也打印的很清楚,就不贅述了。
但是我想說的有意思的點是,我不知道你看到這份代碼,有沒有看出一絲絲雙親委派內味。
都是利用異常,在異常里面處理邏輯。
就上面這“垃圾”代碼,直接就觸犯了阿里開發規范中的兩大條:


在源碼里面這就是好代碼。
在業務流程里面,這就是違反了規范。
所以,說一句題外話。
就是阿里開發規范我個人感覺,其實是針對我們寫業務代碼的同事一個最佳實踐。
但是當把這個尺度拉到中間件、基礎組件、框架源碼的范圍時,就會出現一點水土不服的症狀,這個東西見仁見智,我是覺得阿里開發規范的 idea 插件,對於我這樣寫增刪查改的程序員來說,是真的香。
不說遠了,我們還是回來看看獲取到的這個線程池:

這不就找到我想要的東西了嗎,這個線程池的相關參數都可以看到了。
也證實了我之前猜想:
我覺得核心線程數配置是 8 ,隊列長度應該是 Integer.MAX_VALUE。
但是,現在我是直接從 BeanFactory 獲取到了這個線程池的 Bean,那么這個 Bean 是什么時候注入的呢?
朋友們,這還不簡單嗎?
我都已經拿到這個 Bean 的 beanName 了,就是 applicationTaskExecutor,但凡你把 Spring 獲取 bean 的流程的八股文背的熟練一點,你都知道在這個地方打上斷點,加上調試條件,慢慢去 Debug 就知道了:
org.springframework.beans.factory.support.AbstractBeanFactory#getBean(java.lang.String)

假設你就是不知道在上面這個地方打斷點去調試呢?
再說一個簡單粗暴的方法,你都拿到 beanName 了,在代碼里面一搜不就出來了嘛。
簡單粗暴效果好:
org.springframework.boot.autoconfigure.task.TaskExecutionAutoConfiguration

都找到這個類了,隨便打個斷點,就可以開始調試了。
再說一個騷一點的操作。
假設我現在連 beaName 都不知道,但是我知道它肯定是一個被 Spring 管理的線程池。
那么我就獲取項目里面所有被 Spring 管理的線程池,總有一個得是我要找的吧?
你看下面截圖,當前這個 bean 不就是我要找的 applicationTaskExecutor 嗎?

這都是一些野路子,騷操作,知道就好,有時候多個排查思路。

返回類型的支持
前面我們卷完了第一個關於配置的問題。
接下來,我們看另外一個前面提出的問題:
源碼是怎么做到只支持 void 和 Future 的?
答案就藏在這個方法里面:
org.springframework.aop.interceptor.AsyncExecutionInterceptor#invoke

標號為 ① 的地方,其實就是我們前面分析的從 map 里面拿 method 對應的線程池的方法。
拿到線程池之后來到標號為 ② 的地方,就是封裝一個 Callable 對象。
那么是把什么封裝到 Callable 對象里面呢?
這個問題先按下不表,我們先牢牢的圍繞我們的問題往下走,不然問題會越來越多。
標號為 ③ 的地方,doSubmit,見名知意,這個地方就是執行任務的地方了。
org.springframework.aop.interceptor.AsyncExecutionAspectSupport#doSubmit

其實這里就是我要找的答案。
你看這個方法的入參 returnType 是 String,其實就是被 @Async 注解修飾的 asyncSay 方法。
你要不信,我可以帶你看看前一個調用棧,這里可以看到具體的方法:

怎么樣,沒有騙你吧。
所以,現在你再看 doSubmit 方法拿着這個方法的返回類型干啥了。
一共四個分支,前面三個都是判斷是否是 Future 類型的。
其中的 ListenableFuture 和 CompletableFuture 都是繼承自 Future 的。
這個兩個類在 @Async 注解的方法注釋里面也提到了:

而我們的程序走到了最后的一個 else,含義就是返回值不是 Future 類型的。
那么你看它干了啥事兒?

直接把任務 submit 到線程池之后,就返回了一個 null。
這可不得爆出空指針異常嗎?
到這個地方,我們也解決了這個問題:
源碼是怎么做到只支持 void 和 Future 的?
其實道理很簡單,我們正常的使用線程池提交不也就這兩個返回類型嗎?
用 submit 的方式提交,返回一個 Future,把結果封裝到 Future 里面:

用 execute 的方式提交,沒有返回值:

而框架通過一個簡單的注解幫我們實現異步化,它玩的再花里胡哨 ,就算是玩出花來了,它也得遵守線程池提交的底層原理啊。
所以,源碼為什么只支持 void 和 Future 的返回類型?
因為底層的線程池只支持這兩種類型的返回。
只是它的做法稍微有點坑,直接把其他的返回類型的返回值都處理為 null 了。
你還別不服,誰叫你不讀注釋上的說明呀。
另外,我發現這個地方還有個小的優化點:

當它走到這個方法的時候,返回值已經明確是 null 了。
為什么還用 executor.submit(task)
提交任務呢?
用 execute 就行了啊。
區別,你問我區別?
不是剛剛才說了嗎, submit 方法是有返回值的。

雖然你不用,但是它還是會去構建一個返回的 Future 對象呀。
然而構建出來了,也沒用上呀。
所以直接用 execute 提交就行了。
少生成一個 Future 對象,算不算優化?
有一說一,不算什么有價值的優化,但是說出去可是優化過 Spring 的源碼的,裝逼夠用了。

接着,再說一下我們前面按下不表的部分,這里編號為 ② 的地方封裝的到底是什么?

其實這個問題用腳指頭應該也猜到了:

只是我單獨擰出來說的原因是我要給你證明,這里返回的 result 就是我們方法返回的真實的值。
只是判斷了一下類型不是 Future 的話就不做處理,比如我這里其實是返回了 hi:1
字符串的,只是不符合條件,就被扔掉了:

另外,idea 還是很智能的,它會提示你這個地方的返回值是有問題的:

甚至修改方法都給你標出來了,你只需要一點,它就給你重新改好了。

對於為什么要這么改,現在我們已經拿捏的非常清楚了。
知其然,也知其所以然。

@Async 注解的 value
接下來我們看看 @Async 注解的 value 屬性是干什么的。
其實在前面我已經悄悄的提到了,只是一句話就帶過了,就是這個地方:

前面說編號為 ① 的地方,是獲取對應方法上的 @Async
注解的 value 值。這個值其實就是 bean 名稱,如果不為空則從 Spring 容器中獲取對應的 bean。
然后我就直接分析到標號為 ② 的地方了。
現在我們重新看看標號為 ① 的地方。
我也重新安排一個測試用例去驗證我的想法。
反正 value 值應該是 Spring 的 bean 名稱,而且這個 bean 一定是一個線程池對象,這個沒啥說的。
所以,我把 Demo 程序修改為這樣:

再次跑起來,跑到這個斷點的地方,就和我們默認的情況不一樣了,這個時候 qualifier 有值了:

接下來就是去 beanFactory 里面拿名字為 whyThreadPool 的 bean 了。
最后,拿出來的線程池就是我自定義的這個線程池:

這個其實是一個很簡單的探索過程,但是這背后蘊涵了一個道理。
就是之前有同學問我的這個問題:

其實這個問題挺有代表性的,很多同學都認為線程池不能濫用,一個項目共用一個就好了。
線程池確實不能濫用,但是一個項目里面確實是可以有多個自定義線程池的。
根據你的業務場景來划分。
比如舉個簡單的例子,業務主流程上可以用一個線程池,但是當主流程中的某個環節出問題了,假設需要發送預警短信。
發送預警短信的這個操作,就可以用另外一個線程池來做。
它們可以共用一個線程池嗎?
可以,能用。
但是會出現什么問題呢?
假設項目中某個業務出問題了,在不斷的,瘋狂的發送預警短信,甚至把線程池都占滿了。
這個時候如果主流程的業務和發送短信用的是同一個線程池,會出現什么美麗的場景?
是不是一提交任務,就直接走到拒絕策略里面去了?
預警短信發送這個附屬功能,導致了業務不可以,本末倒置的了吧?
所以,建議使用兩個不同的線程池,各司其職。
這其實就是聽起來很高大上的線程池隔離技術。
那么落到 @Async
注解上是怎么回事呢?
其實就是這樣的:

然后,還記得我們前面提到的那個維護方法和線程池的映射關系的 map 嗎?
就是它:

現在,我把程序跑起來調用一下上面的三個方法,目的是為了把值給放進去這個 map:

看明白了嗎?
再次復述一次這句話:
以方法維度維護方法和線程池之間的關系。
現在,我對於 @Async
這個注解算是有了一點點的了解,我覺得它也還是很可愛的。后面也許我會考慮在項目里面把它給用起來。畢竟它更加符合 SpringBoot 的基於注解開發的編程理念。

最后說一句
好了,看到了這里了,點贊、關注隨便安排一個吧,要是你都安排上我也不介意。寫文章很累的,需要一點正反饋。
給各位讀者朋友們磕一個了:

