Java單元測試之JUnit 5快速上手

  • 2019 年 10 月 3 日
  • 筆記

前言

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

本文所涉及所有程式碼片段均在下面倉庫中，感興趣的小夥伴歡迎參考學習：

https://github.com/wrcj12138aaa/junit5-actions

版本支援：

  • JDK 8
  • JUnit 5.5.2
  • Lomok 1.18.8

認識 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.5.2</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 = 3)  public void i_am_a_repeated_test() {      System.out.println("執行測試");  }

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

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

@DisplayName("自定義名稱重複測試")  @RepeatedTest(value = 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.5.2</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<Arguments> ，作為測試方法所需要的數據使用。

對上面三種數據源註解感興趣的同學可以參考示例工程的 ParameterizedUnitTest 類，這裡就不一一再介紹了。

結語

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

推薦閱讀

參考資料

  • https://junit.org/junit5/docs/current/user-guide/#overview-getting-started-junit-artifacts

  • A Guide to JUnit 5

  • https://zhuanlan.zhihu.com/p/43902194
  • https://dev.to/stealthmusic/why-you-should-start-using-junit-5-5gk2

  • 《Java Unit Testing with JUnit 5》

VirMach 便宜 VPS

QNews

QNews