Java單元測驗---Junit5快速入門-有解無憂

前言

單元測驗是軟體開發中必不可少的一環，但是在平常開發中往往因為專案周期緊，作業量大而被選擇忽略，這樣往往導致軟體問題層出不窮，線上出現的不少問題其實在有單元測驗的情況下就可以及時發現和處理，因此培養自己在日常開發中寫單元測驗的能力是很有必要的，無論是對自己的編碼能力的提高，還是專案質量的提升，都是大有好處，本文將介紹 Java 單元測驗框架 JUnit 5 的基礎認識和使用來撰寫單元測驗，希望同樣對你有所幫助，

版本支持：

JDK 8

JUnit 5.7.0

認識 JUnit 5

要說什么是 JUnit 5，首先就得聊下 Java 單元測驗框架 JUnit，它與另一個框架 TestNG 占據了 Java領域里單元測驗框架的主要市場，其中 JUnit 有著較長的發展歷史和不斷演進的豐富功能，備受大多數 Java 開發者的青睞，

而說到 JUnit 的歷史，JUnit 起源于 1997年，最初版本是由兩位編程大師 Kent Beck 和 Erich Gamma 的一次飛機之旅上完成的，由于當時 Java 測驗程序中缺乏成熟的工具，兩人在飛機上就合作設計實作了 JUnit 雛形，旨在成為更好用的 Java 測驗框架，如今二十多年過去了，JUnit 經過各個版本迭代演進，已經發展到了 5.x 版本，為 JDK 8以及更高的版本上提供更好的支持 (如支持 Lambda ) 和更豐富的測驗形式 (如重復測驗，引數化測驗)，

了解過 JUint 之后，再回頭來看下 JUnit 5，這個版本可以說是 JUnit 單元測驗框架的一次重大升級，首先需要 Java 8 以上的運行環境，雖然在舊版本 JDK 也能編譯運行，但要完全使用 JUnit 5 功能， JDK 8 環境是必不可少的，

除此之外，JUnit 5 與以前版本的 JUnit 不同，拆分成由三個不同子專案的幾個不同模塊組成，

JUnit 5 = JUnit Platform + JUnit Jupiter + JUnit Vintage

JUnit Platform：用于JVM上啟動測驗框架的基礎服務，提供命令列，IDE和構建工具等方式執行測驗的支持，
JUnit Jupiter：包含 JUnit 5 新的編程模型和擴展模型，主要就是用于撰寫測驗代碼和擴展代碼，
JUnit Vintage：用于在JUnit 5 中兼容運行 JUnit3.x 和 JUnit4.x 的測驗用例，

基于上面的介紹，可以參考下圖對 JUnit 5 的架構和模塊有所了解：

為什么需要 JUnit 5

說完 JUnit 5 是什么之后，我們再來想一個問題：為什么需要一個 JUnit 5 呢？

自從有了類似 JUnit 之類的測驗框架，Java 單元測驗領域逐漸成熟，開發人員對單元測驗框架也有了更高的要求：更多的測驗方式，更少的其他庫的依賴，因此，大家期待著一個更強大的測驗框架誕生，JUnit 作為Java測驗領域的領頭羊，推出了 JUnit 5 這個版本，主要特性：

提供全新的斷言和測驗注解，支持測驗類內嵌
更豐富的測驗方式：支持動態測驗，重復測驗，引數化測驗等
實作了模塊化，讓測驗執行和測驗發現等不同模塊解耦，減少依賴
提供對 Java 8 的支持，如 Lambda 運算式，Sream API等，

JUnit 5 常見用法介紹

接下來，我們看下 JUni 5 的一些常見用法，來幫助我們快速掌握 JUnit 5 的使用，

首先，在 Maven 工程里引入 JUnit 5 的依賴坐標，需注意的是當前JDK 環境要在 Java 8 以上，

<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-engine</artifactId>
    <version>5.7.0</version>
    <scope>test</scope>
</dependency>

第一個測驗用例

引入JUnit 5，我們可以先快速撰寫一個簡單的測驗用例，從這個測驗用例來認識初步下 JUnit 5：

@DisplayName("我的第一個測驗用例")
public class MyFirstTestCaseTest {

	@BeforeAll
    public static void init() {
        System.out.println("初始化資料");
    }

    @AfterAll
    public static void cleanup() {
        System.out.println("清理資料");
    }

    @BeforeEach
    public void tearup() {
        System.out.println("當前測驗方法開始");
    }

    @AfterEach
    public void tearDown() {
        System.out.println("當前測驗方法結束");
    }

    @DisplayName("我的第一個測驗")
    @Test
    void testFirstTest() {
        System.out.println("我的第一個測驗開始測驗");
    }

    @DisplayName("我的第二個測驗")
    @Test
    void testSecondTest() {
        System.out.println("我的第二個測驗開始測驗");
    }
}

直接運行這個測驗用例，可以看到控制臺日志如下：

可以看到左邊一欄的結果里顯示測驗項名稱就是我們在測驗類和方法上使用 @DisplayName 設定的名稱，這個注解就是 JUnit 5 引入，用來定義一個測驗類并指定用例在測驗報告中的展示名稱，這個注解可以使用在類上和方法上，在類上使用它就表示該類為測驗類，在方法上使用則表示該方法為測驗方法，

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@API(status = STABLE, since = "5.0")
public @interface DisplayName {
	String value();
}

再來看下示例代碼中使用到的一對注解 **@BeforeAll **和 @AfterAll *，它們定義了整個測驗類在開始前以及結束時的操作，只能修飾靜態方法，主要用于在測驗程序中所需要的全域資料和外部資源的初始化和清理，與它們不同，*@BeforeEach 和 @AfterEach 所標注的方法會在每個測驗用例方法開始前和結束時執行，主要是負責該測驗用例所需要的運行環境的準備和銷毀，

在測驗程序中除了這些基本的注解，還有更多豐富強大的注解，接下來就我們一一學習下吧，

禁用執行測驗：@Disabled

當我們希望在運行測驗類時，跳過某個測驗方法，正常運行其他測驗用例時，我們就可以用上 @Disabled 注解，表明該測驗方法處于不可用，執行測驗類的測驗方法時不會被 JUnit 執行，

下面看下使用 @Disbaled 之后的運行效果，在原來測驗類中添加如下代碼：

@DisplayName("我的第三個測驗")
@Disabled
@Test
void testThirdTest() {
	System.out.println("我的第三個測驗開始測驗");
}

運行后看到控制臺日志如下，用 @Disabled 標記的方法不會執行，只有單獨的方法資訊列印：

@Disabled 也可以使用在類上，用于標記類下所有的測驗方法不被執行，一般使用對多個測驗類組合測驗的時候，

內嵌測驗類：@Nested

當我們撰寫的類和代碼逐漸增多，隨之而來的需要測驗的對應測驗類也會越來越多，為了解決測驗類數量爆炸的問題，JUnit 5提供了@Nested 注解，能夠以靜態內部成員類的形式對測驗用例類進行邏輯分組，并且每個靜態內部類都可以有自己的生命周期方法，這些方法將按從外到內層次順序執行，此外，嵌套的類也可以用@DisplayName 標記，這樣我們就可以使用正確的測驗名稱，下面看下簡單的用法：

@DisplayName("內嵌測驗類")
public class NestUnitTest {
    @BeforeEach
    void init() {
        System.out.println("測驗方法執行前準備");
    }

    @Nested
    @DisplayName("第一個內嵌測驗類")
    class FirstNestTest {
        @Test
        void test() {
            System.out.println("第一個內嵌測驗類執行測驗");
        }
    }

    @Nested
    @DisplayName("第二個內嵌測驗類")
    class SecondNestTest {
        @Test
        void test() {
            System.out.println("第二個內嵌測驗類執行測驗");
        }
    }
}

運行所有測驗用例后，在控制臺能看到如下結果：

重復性測驗：@RepeatedTest

在 JUnit 5 里新增了對測驗方法設定運行次數的支持，允許讓測驗方法進行重復運行，當要運行一個測驗方法 N次時，可以使用 @RepeatedTest 標記它，如下面的代碼所示：

@DisplayName("重復測驗")
@RepeatedTest(value = https://www.cnblogs.com/MessiXiaoMo3334/archive/2020/10/12/3)
public void i_am_a_repeated_test() {
	System.out.println("執行測驗");
}

運行后測驗方法會執行3次，在 IDEA 的運行效果如下圖所示：

這是基本的用法，我們還可以對重復運行的測驗方法名稱進行修改，利用 @RepeatedTest 提供的內置變數，以占位符方式在其 name 屬性上使用，下面先看下使用方式和效果：

@DisplayName("自定義名稱重復測驗")
@RepeatedTest(value = https://www.cnblogs.com/MessiXiaoMo3334/archive/2020/10/12/3, name ="{displayName} 第 {currentRepetition} 次")
public void i_am_a_repeated_test_2() {
	System.out.println("執行測驗");
}

@RepeatedTest 注解內用 currentRepetition 變數表示已經重復的次數，totalRepetitions 變數表示總共要重復的次數，displayName 變數表示測驗方法顯示名稱，我們直接就可以使用這些內置的變數來重新定義測驗方法重復運行時的名稱，

新的斷言

在斷言 API 設計上，JUnit 5 進行顯著地改進，并且充分利用 Java 8 的新特性，特別是 Lambda 運算式，最終提供了新的斷言類: org.junit.jupiter.api.Assertions ，許多斷言方法接受 Lambda 運算式引數，在斷言訊息使用 Lambda 運算式的一個優點就是它是延遲計算的，如果訊息構造開銷很大，這樣做一定程度上可以節省時間和資源，

現在還可以將一個方法內的多個斷言進行分組，使用 assertAll 方法如下示例代碼：

@Test
void testGroupAssertions() {
    int[] numbers = {0, 1, 2, 3, 4};
    Assertions.assertAll("numbers",
            () -> Assertions.assertEquals(numbers[1], 1),
            () -> Assertions.assertEquals(numbers[3], 3),
            () -> Assertions.assertEquals(numbers[4], 4)
    );
}

如果分組斷言中任一個斷言的失敗，都會將以 MultipleFailuresError 錯誤進行拋出提示，

超時操作的測驗：assertTimeoutPreemptively

當我們希望測驗耗時方法的執行時間，并不想讓測驗方法無限地等待時，就可以對測驗方法進行超時測驗，JUnit 5 對此推出了斷言方法 assertTimeout，提供了對超時的廣泛支持，

假設我們希望測驗代碼在一秒內執行完畢，可以寫如下測驗用例：

@Test
@DisplayName("超時方法測驗")
void test_should_complete_in_one_second() {
  Assertions.assertTimeoutPreemptively(Duration.of(1, ChronoUnit.SECONDS), () -> Thread.sleep(2000));
}

這個測驗運行失敗，因為代碼執行將休眠兩秒鐘，而我們期望測驗用例在一秒鐘之內成功，但是如果我們把休眠時間設定一秒鐘，測驗仍然會出現偶爾失敗的情況，這是因為測驗方法執行程序中除了目標代碼還有額外的代碼和指令執行會耗時，所以在超時限制上無法做到對時間引數的完全精確匹配，

例外測驗：assertThrows

我們代碼中對于帶有例外的方法通常都是使用 try-catch 方式捕獲處理，針對測驗這樣帶有例外拋出的代碼，而 JUnit 5 提供方法 Assertions.assertThrows(Class<T>, Executable) 來進行測驗，第一個引數為例外型別，第二個為函式式介面引數，跟 Runnable 介面相似，不需要引數，也沒有回傳，并且支持 Lambda運算式方式使用，具體使用方式可參考下方代碼：

@Test
@DisplayName("測驗捕獲的例外")
void assertThrowsException() {
  String str = null;
  Assertions.assertThrows(IllegalArgumentException.class, () -> {
    Integer.valueOf(str);
  });
}

當Lambda運算式中代碼出現的例外會跟首個引數的例外型別進行比較，如果不屬于同一類例外，就會控制臺輸出如下類似的提示：org.opentest4j.AssertionFailedError: Unexpected exception type thrown ==> expected: <IllegalArgumentException> but was: <...Exception>

JUnit 5 引數化測驗

要使用 JUnit 5 進行引數化測驗，除了 junit-jupiter-engine 基礎依賴之外，還需要另個模塊依賴：junit-jupiter-params，其主要就是提供了撰寫引數化測驗 API，同樣方式，把相同版本的對應依賴引入 Maven 工程中：

<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-params</artifactId>
    <version>5.7.0</version>
    <scope>test</scope>
</dependency>

基本資料源測驗： @ValueSource

@ValueSource 是 JUnit 5 提供的最簡單的資料引數源，支持 Java 的八大基本型別和字串，Class，使用時賦值給注解上對應型別屬性，以陣列方式傳遞，示例代碼如下：

public class ParameterizedUnitTest {
    @ParameterizedTest
    @ValueSource(ints = {2, 4, 8})
    void testNumberShouldBeEven(int num) {
        Assertions.assertEquals(0, num % 2);
    }

    @ParameterizedTest
    @ValueSource(strings = {"Effective Java", "Code Complete", "Clean Code"})
    void testPrintTitle(String title) {
        System.out.println(title);
    }
}

@ParameterizedTest 作為引數化測驗的必要注解，替代了 @Test 注解，任何一個引數化測驗方法都需要標記上該注解，

運行測驗，結果如下圖所示，針對 @ValueSource 里每個引數都會運行目標方法，一旦哪個引數運行測驗失敗，就意味著該測驗方法不通過，

CSV 資料源測驗：@CsvSource

通過 @CsvSource 可以注入指定 CSV 格式 (comma-separated-values) 的一組資料，用每個逗號分隔的值來匹配一個測驗方法對應的引數，下面是使用示例：

@ParameterizedTest
@CsvSource({"1,One", "2,Two", "3,Three"})
void testDataFromCsv(long id, String name) {
	System.out.printf("id: %d, name: %s", id, name);
}

運行結果如圖所示，除了用逗號分隔引數外，@CsvSource 還支持自定義符號，只要修改它的 delimiter 即可，默認為 ，，

JUnit 還提供了讀取外部 CSV 格式檔案資料的方式作為資料源的實作，我們只要用 @CsvFileSource 指定資源檔案路徑即可，使用起來跟 @CsvSource 一樣簡單這里就不再重復演示了，

@CsvFileSource 指定的資源檔案路徑時要以 / 開始，尋找當前測驗資源目錄下檔案，

除了上面提到的三種資料源方式外，JUnit 還提供了以下三種資料源：

@EnumSource：允許我們通過引數值，給指定 Enum 列舉型別傳入，構造出列舉型別中特定的值，
@MethodSource：指定一個回傳的 Stream / Array / 可迭代物件的方法作為資料源，需要注意的是該方法必須是靜態的，并且不能接受任何引數，
@ArgumentSource：通過實作 ArgumentsProvider 介面的引數類來作為資料源，重寫它的 provideArguments 方法可以回傳自定義型別的 Stream ，作為測驗方法所需要的資料使用，

對上面三種資料源注解感興趣的同學可以參考示例工程的 ParameterizedUnitTest 類，這里就不一一再介紹了，

結語

到這里，想必你對 JUnit 5 也有了基本的了解和掌握，都說單元測驗是提升軟體質量，提升研發效率的必備環節，從會用 JUnit 5 寫單元測驗開始，培養寫測驗代碼的習慣，在不斷實踐中提升自身的開發效率，讓寫出來的代碼有更質量的保證，

轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/169013.html

標籤：其他

上一篇：在 Minecraft 中管理 Kubernetes 集群

下一篇：OpenWrite 創始人 DD