springboot集成測試容器重啟問題的處理

背景

spring boot test的項目中常用的測試框架， 最近在寫集成測試的時候發現一個比較奇怪的問題，當我在運行多個測試用例的時候會偶爾重新啟動整個容器上下文，由於後期業務逐漸復雜，大量的測試用例需要運行，這個問題直接導致回歸測試的效率降低。

舉個例子：

幾個類：

@RunWith(SpringRunner.class)
@SpringBootTest(classes = TestApplication.class)
public class BaseApiTest {
    @Test
    public void init() {
    }
}
public class ApiTest1 extends BaseApiTest {
    @MockBean
    private Service service;
    @Test
    public void test1() {
        service.call();
    }
}
public class ApiTest2 extends BaseApiTest {
    @Autowired
    private Service service;
    @Test
    public void test2() {
        service.call();
    }
}
@SpringBootApplication
@Slf4j
public class TestApplication {
    public static void main(String[] args) {
        log.info("啟動容器");
        new SpringApplication(TestApplication.class).run(args);
    }
}
@Component
public class Service {
    public void call() {
        System.out.println("service called");
    }
}

運行test包下所有測試：

發現容器重復啟動瞭。

測試用例的運行流程

可以開啟idea的線程堆棧跟蹤，觀察整個容器的啟動路徑

com.intellij.rt.junit是idea內部的實現，點擊idea的運行單測會觸發JunitStarter的main函數去啟動，可以去GitHub找到源碼：

做一些準備工作找到指定的runner就開始調用junit的包去執行編寫的單測，junit為瞭靈活的擴展不同的測試運行環境，類似SPI機制動態獲取Runner去運行單測。例如我的例子裡指定瞭SpringRunner就是需要依賴Spring容器的一個實現，這樣就讓測試用例可以運行在Spring環境中。

junit的入口也支持在測例前後去插入一些操作，自己去實現RunnerListener即可。junit默認實現瞭監聽器去記錄測例的耗時，失敗的數量等信息。

我指定的Runner是SpringRunner，其與SpringJUnit4ClassRunner並沒什麼區別，可以看其實現完全繼承瞭SpringJUnit4ClassRunner的實現。

所以我們直接看SpringJUnit4ClassRunner的runner實現：

它首先判斷瞭當前的環境是否需要忽略單測。如果忽略會在通知裡得到通知。關於環境的指定控制可以參考註解@IfProfileValue，判斷環境正確之後繼續調用junit包父類ParentRunner的方法執行。

其定義瞭執行的基本的模板：

classBlock裡面定義線程池執行和測例執行的一些before和after邏輯，裡面的runChild是抽象方法，也是留給各個Runner實現的鉤子。getFilteredChildren能夠根據@Test註解拿到所有需要運行的用例方法，然後每個方法去調用具體的Runner運行。

其流程圖如下

SpringJUnit4ClassRunner的運行每個方法會給每個測例方法進行一個封裝成Statement。關鍵就在methodBlock方法，它實現瞭Spring boot對方法運行的封裝

createTest會在測試的上下文裡維護一個配置，然後會用通知機制一樣去依次調用需要準備的東西，其中就包含spring容器的上下文。

其會執行injectDependencies，處理依賴的bean準備。TestContext是每個單測方法需要運行的上下文，在Spring boot的測試環境下，其維護瞭Spring的上下文，每個方法的執行都會去獲取Spring的上下文

根據單測的相關信息文獲取上spring的上下文，為瞭避免每次都去加載容器，TestContext會維護一個spring容器的緩存，CacheAwareContextLoaderDelegate

CacheAwareContextLoaderDelegate其內部的獲取又是通過單測配置信息去ContextCache獲取的，其內部是一個同步SynchronizedMap去保存的。

其內部實現看測例的配置信息去獲取加載過的容器，如果沒獲取到就會觸發重新加載新容器的流程，所以關鍵就是看key在Map中的獲取邏輯，其底層是spring test自己實現一個的Map

可以看到其是基於HashMap的一個哈希結構，根據Jdk的源碼，我們可以知道HashMap的key是根據hashCode與equals去比較key，那可以確定，要想復用同一個容器就得看Key值的hashCode和equals實現。接下來我們看MergedContextConfiguration源碼.

可以發現其比較的值是：

 	 * @param testClass the test class for which the configuration was merged
	 * @param locations the merged context resource locations
	 * @param classes the merged annotated classes
	 * @param contextInitializerClasses the merged context initializer classes
	 * @param activeProfiles the merged active bean definition profiles
	 * @param propertySourceLocations the merged {@code PropertySource} locations
	 * @param propertySourceProperties the merged {@code PropertySource} properties
	 * @param contextCustomizers the context customizers
	 * @param contextLoader the resolved {@code ContextLoader}
	 * @param cacheAwareContextLoaderDelegate a cache-aware context loader
	 * delegate with which to retrieve the parent context
	 * @param parent the parent configuration or {@code null} if there is no parent

這些參數確定瞭能否共享SpringApplication，那兩個測試類一個@Autowired，另一個使用@MockBean，肯定是改變這裡面某個值，我們可以回溯這個MergedContextConfiguration是在什麼時候被初始化的。這個還要追溯到idea的啟動類，找到Runner的時候，SpringJUnit4ClassRunner的初始化的過程。

在每個測試類的運行都會喚起SpringJUnit4ClassRunner初始化，調用構造函數的時候會去加載測試類的上下文

去創建這個TextContextManager

這裡首先會根據被測試類的繼承關系和註解的遞歸去找到固定包下面被註解@BootstrapWith修飾的類，因為是Spring boot test這裡會根據@SpringBootTest 註解找到SpringBootTestContextBootstrapper類，找到這個引導類之後就會去初始化MergedContextConfiguration瞭。

引導類通過SPI機制加載到所有的Customizer，並根據需要DefinitionsParser，進行轉換，保存在MergedContextConfiguration的一個字段，mock的一個屬性會在轉換的時候記錄到，而非mock的contextCustomizers則不會記錄。

註意這裡提到的

兩個類一個用mock的字段，一個用非mock的字段，兩個MockitoContextCustomizer的definitions就不一樣，因此無法共享上下文，因此需要重新啟動一個Spring容器，並存放到CacheAwareContextLoaderDelegate，以便後面共享。

結論

分析源碼的設計，發現應用瞭很多SPI與可擴展的設計，idea與junit的解耦，junit的抽象與模板定義與各個測試框架的擴展。

針對容器重啟的角度，對於一個類來說，一定是共享一個spring上下文，但是不同的類可能由於註入的bean的方式不同導致無法共享spring上下文，所以導致重啟會浪費掉一些時間，因此建議確定好mock的邊界，對盡量多的測例共享一個容器視角可以提高單測效率，基於此可以設計多繼承關系的單測結構，並把註入的bean向上共享，避免各個測試子類自己去註入出現不一致的情況。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：

• 單元測試 @mock與@SpringBootTest的使用
• springBoot Junit測試用例出現@Autowired不生效的解決
• 解決Spring boot 整合Junit遇到的坑
• 如何使用Spring-Test對Spring框架進行單元測試
• SpringBoot與單元測試JUnit的結合操作