Springboot集成JUnit5優雅進行單元測試

2020 年 10 月 13 日
筆記
SpringBoot開發

為什麼使用JUnit5

JUnit4被廣泛使用，但是許多場景下使用起來語法較為繁瑣，JUnit5中支援lambda表達式，語法簡單且程式碼不冗餘。
JUnit5易擴展，包容性強，可以接入其他的測試引擎。
功能更強大提供了新的斷言機制、參數化測試、重複性測試等新功能。
ps：開發人員為什麼還要測試，單測寫這麼規範有必要嗎？其實單測是開發人員必備技能，只不過很多開發人員開發任務太重導致調試完就不管了，沒有系統化得單元測試，單元測試在系統重構時能發揮巨大的作用，可以在重構後快速測試新的介面是否與重構前有出入。

簡介

如圖，JUnit5結構如下：

JUnit Platform：這是Junit提供的平台功能模組，通過它，其它的測試引擎都可以接入Junit實現介面和執行。
JUnit JUpiter：這是JUnit5的核心，是一個基於JUnit Platform的引擎實現，它包含許多豐富的新特性來使得自動化測試更加方便和強大。
JUnit Vintage：這個模組是兼容JUnit3、JUnit4版本的測試引擎，使得舊版本的自動化測試也可以在JUnit5下正常運行。

依賴引入

我們以SpringBoot2.3.1為例，引入如下依賴，防止使用舊的junit4相關介面我們將其依賴排除。

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

常用註解

@BeforeEach：在每個單元測試方法執行前都執行一遍
@BeforeAll：在每個單元測試方法執行前執行一遍（只執行一次）
@DisplayName(“商品入庫測試”)：用於指定單元測試的名稱
@Disabled：當前單元測試置為無效，即單元測試時跳過該測試
@RepeatedTest(n)：重複性測試，即執行n次
@ParameterizedTest：參數化測試，
@ValueSource(ints = {1, 2, 3})：參數化測試提供數據

斷言

JUnit Jupiter提供了強大的斷言方法用以驗證結果，在使用時需要藉助java8的新特性lambda表達式，均是來自org.junit.jupiter.api.Assertions包的static方法。

assertTrue與assertFalse用來判斷條件是否為true或false

    @Test
    @DisplayName("測試斷言equals")
    void testEquals() {
        assertTrue(3 < 4);
    }

assertNull與assertNotNull用來判斷條件是否為·null

    @Test
    @DisplayName("測試斷言NotNull")
    void testNotNull() {
        assertNotNull(new Object());
    }

assertThrows用來判斷執行拋出的異常是否符合預期，並可以使用異常類型接收返回值進行其他操作

    @Test
    @DisplayName("測試斷言拋異常")
    void testThrows() {
        ArithmeticException arithExcep = assertThrows(ArithmeticException.class, () -> {
            int m = 5/0;
        });
        assertEquals("/ by zero", arithExcep.getMessage());
    }

assertTimeout用來判斷執行過程是否超時

    @Test
    @DisplayName("測試斷言超時")
    void testTimeOut() {
        String actualResult = assertTimeout(ofSeconds(2), () -> {
            Thread.sleep(1000);
            return "a result";
        });
        System.out.println(actualResult);
    }

assertAll是組合斷言，當它內部所有斷言正確執行完才算通過

    @Test
    @DisplayName("測試組合斷言")
    void testAll() {
        assertAll("測試item商品下單",
                () -> {
                    //模擬用戶餘額扣減
                    assertTrue(1 < 2, "餘額不足");
                },
                () -> {
                    //模擬item資料庫扣減庫存
                    assertTrue(3 < 4);
                },
                () -> {
                    //模擬交易流水落庫
                    assertNotNull(new Object());
                }
        );
    }

重複性測試

在許多場景中我們需要對同一個介面方法進行重複測試，例如對冪等性介面的測試。

JUnit Jupiter通過使用@RepeatedTest(n)指定需要重複的次數

    @RepeatedTest(3)
    @DisplayName("重複測試")
    void repeatedTest() {
        System.out.println("調用");
    }

參數化測試

參數化測試可以按照多個參數分別運行多次單元測試這裡有點類似於重複性測試，只不過每次運行傳入的參數不用。需要使用到@ParameterizedTest，同時也需要@ValueSource提供一組數據，它支援八種基本類型以及String和自定義對象類型，使用極其方便。

    @ParameterizedTest
    @ValueSource(ints = {1, 2, 3})
    @DisplayName("參數化測試")
    void paramTest(int a) {
        assertTrue(a > 0 && a < 4);
    }

內嵌測試

JUnit5提供了嵌套單元測試的功能，可以更好展示測試類之間的業務邏輯關係，我們通常是一個業務對應一個測試類，有業務關係的類其實可以寫在一起。這樣有利於進行測試。而且內聯的寫法可以大大減少不必要的類，精簡項目，防止類爆炸等一系列問題。

@SpringBootTest
@AutoConfigureMockMvc
@DisplayName("Junit5單元測試")
public class MockTest {
    //....
    @Nested
    @DisplayName("內嵌訂單測試")
    class OrderTestClas {
        @Test
        @DisplayName("取消訂單")
        void cancelOrder() {
            int status = -1;
            System.out.println("取消訂單成功,訂單狀態為:"+status);
        }
    }
}

Tags: SpringBoot開發