Thinking Twice Before Using @MockBean

號(hào)外苛秕!號(hào)外肌访!號(hào)外!你的 spring boot integration tests 運(yùn)行慢嗎艇劫,是不是每跑一次測(cè)試吼驶,你都在等待,等待它全綠的那一瞬間店煞。如果你遇到蟹演,那請(qǐng)接著往下看,也許可以幫助到你顷蟀。如果你沒(méi)有遇到酒请,那也請(qǐng)往下看,因?yàn)橐苍S以后你會(huì)遇到鸣个。

告訴你一個(gè)秘密:@MockBean會(huì)導(dǎo)致測(cè)試類(Test Class)之間spring boot application context不斷啟動(dòng)多次P叻础!囤萤!

不信昼窗,那么我們請(qǐng)看栗子 MockBean Annotation:

這項(xiàng)目有兩個(gè)測(cè)試類,AboutControllerTestTokenControllerTest

AccountControllerTest:

account-controller.png

TokenControllerTest:

token-controller.png

AccountControllerTest 沒(méi)有使用 @MockBean阁将,TokenControllerTest 使用 @MockBean膏秫。下面是兩個(gè)測(cè)試一起運(yùn)行產(chǎn)生的日志:

spring-boot-log.png

如上圖所示右遭,spring boot 啟動(dòng)兩次做盅。而spring boot 的啟動(dòng)時(shí)間也比較耗時(shí)缤削,所以@MockBean,很有可能導(dǎo)致測(cè)試運(yùn)行的很慢吹榴。那@MockBean到底是個(gè)怎么樣的存在亭敢?

WHAT

寫(xiě)過(guò)spring boot integration test的小伙伴,對(duì)于@MockBean應(yīng)該會(huì)比較熟悉图筹。在寫(xiě)測(cè)試時(shí)帅刀,對(duì)于一些應(yīng)用的外部依賴需要進(jìn)行一些Mock 處理,比如:Redis远剩、ElasticSearch扣溺、ExternalService 等。官方文檔介紹 Mocking and spying beans

mock-bean.png
  • It allows to add Mockito mocks in a Spring ApplicationContext.
  • If a bean, compatible with the declared class exists in the context, it replaces it by the mock.
  • If it is not the case, it adds the mock in the context as a bean.

也就是說(shuō)瓜晤,@MockBean會(huì)改變spring boot application context beans锥余,導(dǎo)致使用了@MockBean的測(cè)試類之間的需要不同application context,從而導(dǎo)致spring boot application context重啟痢掠。為什么需要不同application context 就需要重啟驱犹??足画?帶著疑惑雄驹,我們接著往下看。

WHY

Spring Boot Application Context

什么是application context淹辞?簡(jiǎn)單理解医舆,就是應(yīng)用程序運(yùn)行所需要的上下文。官方文檔介紹 Context Management:

context-management.png

官方文檔介紹 Context management and caching

testing-ctx-management.png

根據(jù)官方文檔意思象缀,application context為初始化測(cè)試實(shí)例提供上下文彬向,如果需要不同的application context實(shí)例化不同的測(cè)試,就需要重新啟動(dòng)spring boot攻冷,創(chuàng)建不同applicaiton context娃胆。文檔還說(shuō)到,為了解決spring boot application context啟動(dòng)慢的問(wèn)題等曼,會(huì)做緩存處理里烦。那@MockBean到底破壞了什么樣的緩存規(guī)則,從而導(dǎo)致spring boot重啟多次禁谦?是什么導(dǎo)致打開(kāi)方式出了問(wèn)題胁黑?

Spring Boot Application Context Cache

要回答這個(gè)問(wèn)題,就要先了解[application context caching]的uniquely key包含的內(nèi)容州泊,附上官方文檔介紹 Context caching

context-caching.png

根據(jù)文檔的描述丧蘸,不難知道application context cacheing是通過(guò)key:value方式進(jìn)行緩存的,唯一鍵為組合鍵遥皂,包含:locations力喷、classes刽漂、contextInitializerClasses、contextCustomizers弟孟、contextLoader贝咙、parent、activeProfiles拂募、propertySourceLocations庭猩、propertySourceProperties、resourceBasePath陈症。

@MockBean的使用會(huì)導(dǎo)致每個(gè)application contextcontextCustomizer的不同蔼水,從而導(dǎo)致存儲(chǔ)在context cache中的application contextuniquely key不同,最終導(dǎo)致application context在測(cè)試類之間不能共享录肯。雖然沒(méi)有官方文檔說(shuō)明這一點(diǎn)徙缴,不過(guò)在
org.springframework.boot.test.mock.mockito.MockitoContextCustomizerFactory 源代碼中可以找到一些痕跡:

mock-customizer.png

圖中所說(shuō)的MergedContextConfiguration就是application context cachinguniquely key

HOW

對(duì)于spring boot integration test 來(lái)說(shuō)嘁信,除了 external service(clients...) 需要被 Mock于样,其它的內(nèi)部依賴(service、repository…)都不應(yīng)該被Mock潘靖。external service 可以在配置層穿剖,進(jìn)行Mock,然后在測(cè)試類中卦溢,直接通過(guò)@Auotwrite方式注入:

RedisTemplateBeanConfigurationMocker

redis-configuration-mocker.png

RedisConfiguration

redis-configuration.png

TokenControllerTest:

token-controller-fixed.png

TokenControllerTest糊余,直接 @Autowrite RedisTemplateBeanConfigurationMocker 中配置的,RedisTemplate @Bean单寂。完成栗子贬芥,請(qǐng)查mockbean-annotation

寫(xiě)在最后

spring boot integration test 相對(duì)于 api test宣决,應(yīng)該更關(guān)注api功能的完整性蘸劈,了解依賴的邊界,不需要Mock的尊沸,就不要Mock威沫,比如:service, repository…。對(duì)于外部依賴洼专,統(tǒng)一在配置層完成 Mock棒掠,比如:client、redis屁商、rabbitmq...烟很。

原文鏈接

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子雾袱,更是在濱河造成了極大的恐慌恤筛,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,734評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件谜酒,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡妻枕,警方通過(guò)查閱死者的電腦和手機(jī)僻族,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,931評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)屡谐,“玉大人述么,你說(shuō)我怎么就攤上這事°堤停” “怎么了度秘?”我有些...
    開(kāi)封第一講書(shū)人閱讀 164,133評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)饵撑。 經(jīng)常有香客問(wèn)我剑梳,道長(zhǎng),這世上最難降的妖魔是什么滑潘? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,532評(píng)論 1 293
  • 正文 為了忘掉前任垢乙,我火速辦了婚禮,結(jié)果婚禮上语卤,老公的妹妹穿的比我還像新娘追逮。我一直安慰自己,他們只是感情好粹舵,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,585評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布钮孵。 她就那樣靜靜地躺著,像睡著了一般眼滤。 火紅的嫁衣襯著肌膚如雪巴席。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,462評(píng)論 1 302
  • 那天诅需,我揣著相機(jī)與錄音情妖,去河邊找鬼。 笑死诱担,一個(gè)胖子當(dāng)著我的面吹牛毡证,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播蔫仙,決...
    沈念sama閱讀 40,262評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼料睛,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起恤煞,我...
    開(kāi)封第一講書(shū)人閱讀 39,153評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤屎勘,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后居扒,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體概漱,經(jīng)...
    沈念sama閱讀 45,587評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,792評(píng)論 3 336
  • 正文 我和宋清朗相戀三年喜喂,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了瓤摧。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,919評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡玉吁,死狀恐怖照弥,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情进副,我是刑警寧澤这揣,帶...
    沈念sama閱讀 35,635評(píng)論 5 345
  • 正文 年R本政府宣布,位于F島的核電站影斑,受9級(jí)特大地震影響给赞,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜矫户,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,237評(píng)論 3 329
  • 文/蒙蒙 一塞俱、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧吏垮,春花似錦障涯、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,855評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至遗嗽,卻和暖如春粘我,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背痹换。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,983評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工征字, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人娇豫。 一個(gè)月前我還...
    沈念sama閱讀 48,048評(píng)論 3 370
  • 正文 我出身青樓匙姜,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親冯痢。 傳聞我的和親對(duì)象是個(gè)殘疾皇子氮昧,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,864評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容