使用Spring Boot進行單元測試詳情

2022-09-24 14:00:11

前言

本文給你提供在Spring Boot 應用程式中編寫好的單元測試的機制，並且深入技術細節。

我們將帶你學習如何以可測試的方式建立Spring Bean範例，然後討論如何使用Mockito和AssertJ，這兩個包在Spring Boot中都為了測試預設參照了。

本文只討論單元測試。至於整合測試，測試web層和測試持久層將會在接下來的系列文章中進行討論。

使用 Spring Boot 進行測試系列文章

這個教學是一個系列：

使用 Spring Boot 進行單元測試（本文）
使用 Spring Boot 和 @WebMvcTest 測試SpringMVC controller層
使用 Spring Boot 和 @DataJpaTest 測試JPA持久層查詢
通過 @SpringBootTest 進行整合測試

如果你喜歡看視訊教學，可以看看Philip的課程：測試Spring Boot應用程式課程

依賴項

本文中，為了進行單元測試，我們會使用JUnit Jupiter（Junit 5），Mockito和AssertJ。此外，我們會參照Lombok來減少一些模板程式碼：

dependencies{
  compileOnly('org.projectlombok:lombok')
  testCompile('org.springframework.boot:spring-boot-starter-test')
  testCompile 'org.junit.jupiter:junit-jupiter-engine:5.2.0'
  testCompile('org.mockito:mockito-junit-jupiter:2.23.0')
}

Mockito和AssertJ會在spring-boot-test依賴中自動參照，但是我們需要自己參照Lombok。

不要在單元測試中使用Spring

如果你以前使用Spring或者Spring Boot寫過單元測試，你可能會說我們不要在寫單元測試的時候用Spring。但是為什麼呢？

考慮下面的單元測試類，這個類測試了RegisterUseCase類的單個方法：

@ExtendWith(SpringExtension.class)
@SpringBootTest
class RegisterUseCaseTest {

  @Autowired
  private RegisterUseCase registerUseCase;

  @Test
  void savedUserHasRegistrationDate() {
    User user = new User("zaphod", "zaphod@mail.com");
    User savedUser = registerUseCase.registerUser(user);
    assertThat(savedUser.getRegistrationDate()).isNotNull();
  }

}

這個測試類在我的電腦上需要大概4.5秒來執行一個空的Spring專案。

但是一個好的單元測試僅僅需要幾毫秒。否則就會阻礙TDD（測試驅動開發）流程，這個流程倡導“測試/開發/測試”。

但是就算我們不使用TDD，等待一個單元測試太久也會破壞我們的注意力。

執行上述的測試方法事實上僅需要幾毫秒。剩下的4.5秒是因為@SpringBootTest告訴了 Spring Boot 要啟動整個Spring Boot 應用程式上下文。

所以我們啟動整個應用程式僅僅是因為要把RegisterUseCase範例注入到我們的測試類中。啟動整個應用程式可能耗時更久，假設應用程式更大、Spring需要載入更多的範例到應用程式上下文中。

所以，這就是為什麼不要在單元測試中使用Spring。坦白說，大部分編寫單元測試的教學都沒有使用Spring Boot。

建立一個可測試的類範例

然後，為了讓Spring範例有更好的測試性，有幾件事是我們可以做的。

屬性注入是不好的

讓我們以一個反例開始。考慮下述類：

@Service
public class RegisterUseCase {

  @Autowired
  private UserRepository userRepository;

  public User registerUser(User user) {
    return userRepository.save(user);
  }

}

這個類如果沒有Spring沒法進行單元測試，因為它沒有提供方法傳遞UserRepository範例。因此我們只能用文章之前討論的方式-讓Spring建立UserRepository範例，並通過@Autowired註解注入進去。

這裡的教訓是：不要用屬性注入。

提供一個建構函式

實際上，我們根本不需要使用@Autowired註解：

@Service
public class RegisterUseCase {

  private final UserRepository userRepository;

  public RegisterUseCase(UserRepository userRepository) {
    this.userRepository = userRepository;
  }

  public User registerUser(User user) {
    return userRepository.save(user);
  }

}

這個版本通過提供一個允許傳入UserRepository範例引數的建構函式來允許建構函式注入。在這個單元測試中，我們現在可以建立這樣一個範例（或者我們之後要討論的Mock範例）並通過建構函式注入了。

當建立生成應用上下文的時候，Spring會自動使用這個建構函式來初始化RegisterUseCase物件。注意，在Spring 5 之前，我們需要在建構函式上增加@Autowired註解，以便讓Spring找到這個建構函式。

還要注意的是，現在UserRepository屬性是final修飾的。這很重要，因為這樣的話，應用程式生命週期時間內這個屬性內容不會再變化。此外，它還可以幫我們避免變成錯誤，因為如果我們忘記初始化該屬性的話，編譯器就報錯。

減少模板程式碼

通過使用Lombok的@RequiredArgsConstructor註解，我們可以讓建構函式自動生成:

@Service
@RequiredArgsConstructor
public class RegisterUseCase {

  private final UserRepository userRepository;

  public User registerUser(User user) {
    user.setRegistrationDate(LocalDateTime.now());
    return userRepository.save(user);
  }

}

現在，我們有一個非常簡潔的類，沒有樣板程式碼，可以在普通的 java 測試用例中很容易被範例化：

class RegisterUseCaseTest {

  private UserRepository userRepository = ...;

  private RegisterUseCase registerUseCase;

  @BeforeEach
  void initUseCase() {
    registerUseCase = new RegisterUseCase(userRepository);
  }

  @Test
  void savedUserHasRegistrationDate() {
    User user = new User("zaphod", "zaphod@mail.com");
    User savedUser = registerUseCase.registerUser(user);
    assertThat(savedUser.getRegistrationDate()).isNotNull();
  }

}

還有部分確實，就是如何模擬測試類所依賴的UserReposity範例，我們不想依賴真實的類，因為這個類需要一個資料庫連線。

使用Mockito來模擬依賴項

現在事實上的標準模擬庫是 Mockito。它提供至少兩種方式來建立一個模擬UserRepository範例，來填補前述程式碼的空白。

使用普通`Mockito`來模擬依賴

第一種方式是使用Mockito程式設計：

private UserRepository userRepository = Mockito.mock(UserRepository.class);

這會從外界建立一個看起來像UserRepository的物件。預設情況下，方法被呼叫時不會做任何事情，如果方法有返回值，會返回null。

因為userRepository.save(user)返回null，現在我們的測試程式碼assertThat(savedUser.getRegistrationDate()).isNotNull()會報空指標異常（NullPointerException）。

所以我們需要告訴Mockito，當userRepository.save(user)呼叫的時候返回一些東西。我們可以用靜態的when方法實現：

@Test
void savedUserHasRegistrationDate() {
  User user = new User("zaphod", "zaphod@mail.com");
  when(userRepository.save(any(User.class))).then(returnsFirstArg());
  User savedUser = registerUseCase.registerUser(user);
  assertThat(savedUser.getRegistrationDate()).isNotNull();
}

這會讓userRepository.save()返回和傳入物件相同的物件。

Mockito為了模擬物件、匹配引數以及驗證方法呼叫，提供了非常多的特性。想看更多，檔案

通過`Mockito`的`@Mock`註解模擬物件

建立一個模擬物件的第二種方式是使用Mockito的@Mock註解結合 JUnit Jupiter的MockitoExtension一起使用：

@ExtendWith(MockitoExtension.class)
class RegisterUseCaseTest {

  @Mock
  private UserRepository userRepository;

  private RegisterUseCase registerUseCase;

  @BeforeEach
  void initUseCase() {
    registerUseCase = new RegisterUseCase(userRepository);
  }

  @Test
  void savedUserHasRegistrationDate() {
    // ...
  }

}

@Mock註解指明那些屬性需要Mockito注入模擬物件。由於JUnit不會自動實現，MockitoExtension則告訴Mockito來評估這些@Mock註解。

這個結果和呼叫Mockito.mock()方法一樣，憑個人品味選擇即可。但是請注意，通過使用 MockitoExtension，我們的測試用例被繫結到測試框架。

我們可以在RegisterUseCase屬性上使用@InjectMocks註解來注入範例，而不是手動通過建構函式構造。Mockito會使用特定的演演算法來幫助我們建立相應範例物件：

@ExtendWith(MockitoExtension.class)
class RegisterUseCaseTest {

  @Mock
  private UserRepository userRepository;

  @InjectMocks
  private RegisterUseCase registerUseCase;

  @Test
  void savedUserHasRegistrationDate() {
    // ...
  }

}

使用AssertJ建立可讀斷言

Spring Boot 測試包自動附帶的另一個庫是AssertJ。我們在上面的程式碼中已經用到它進行斷言：

assertThat(savedUser.getRegistrationDate()).isNotNull();

然而，有沒有可能讓斷言可讀性更強呢？像這樣，例子：

assertThat(savedUser).hasRegistrationDate();

有很多測試用例，只需要像這樣進行很小的改動就能大大提高可理解性。所以，讓我們在test/sources中建立我們自定義的斷言吧：

class UserAssert extends AbstractAssert<UserAssert, User> {

  UserAssert(User user) {
    super(user, UserAssert.class);
  }

  static UserAssert assertThat(User actual) {
    return new UserAssert(actual);
  }

  UserAssert hasRegistrationDate() {
    isNotNull();
    if (actual.getRegistrationDate() == null) {
      failWithMessage(
        "Expected user to have a registration date, but it was null"
      );
    }
    return this;
  }
}

現在，如果我們不是從AssertJ庫直接匯入，而是從我們自定義斷言類UserAssert引入assertThat方法的話，我們就可以使用新的、更可讀的斷言。

建立一個這樣自定義的斷言類看起來很費時間，但是其實幾分鐘就完成了。我相信，將這些時間投入到建立可讀性強的測試程式碼中是值得的，即使之後它的可讀性只有一點點提高。我們編寫測試程式碼就一次，但是之後，很多其他人（包括未來的我）在軟體生命週期中，需要閱讀、理解然後操作這些程式碼很多次。

如果你還是覺得很費事，可以看看斷言生成器

結論

儘管在測試中啟動Spring應用程式也有些理由，但是對於一般的單元測試，它不必要。有時甚至有害，因為更長的週轉時間。換言之，我們應該使用更容易支援編寫普通單元測試的方式構建Spring範例。

Spring Boot Test Starter附帶Mockito和AssertJ作為測試庫。讓我們利用這些測試庫來建立富有表現力的單元測試!

到此這篇關於使用Spring Boot進行單元測試詳情的文章就介紹到這了,更多相關Spring Boot單元測試內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

使用Spring Boot進行單元測試詳情

目錄

前言

使用 Spring Boot 進行測試系列文章

依賴項

不要在單元測試中使用Spring

建立一個可測試的類範例

屬性注入是不好的

提供一個建構函式

減少模板程式碼

使用Mockito來模擬依賴項

使用普通`Mockito`來模擬依賴

通過`Mockito`的`@Mock`註解模擬物件

使用AssertJ建立可讀斷言

結論

熱門文章

使用Spring Boot進行單元測試詳情

目錄

前言

使用 Spring Boot 進行測試系列文章

依賴項

不要在單元測試中使用Spring

建立一個可測試的類範例

屬性注入是不好的

提供一個建構函式

減少模板程式碼

使用Mockito來模擬依賴項

使用普通Mockito來模擬依賴

通過Mockito的@Mock註解模擬物件

使用AssertJ建立可讀斷言

結論

熱門文章

使用普通`Mockito`來模擬依賴

通過`Mockito`的`@Mock`註解模擬物件