Spring 單元測試中如何進行 mock的實現

Posted on by

我們在使用 Spring 開發項目時，都會用到依賴註入。如果程序依賴瞭外部系統或者不可控組件，比如依賴數據庫、網絡通信、文件系統等，我們在編寫單元測試時，並不需要實際對外部系統進行操作，這時就要將被測試代碼與外部系統進行解耦，而這種解耦方法就叫作 “mock”。所謂 “mock” 就是用一個“假”的服務代替真正的服務。

那我們如何來 mock 服務進行單元測試呢？mock 的方式主要有兩種：手動 mock 和利用單元測試框架 mock。其中，利用框架 mock 主要是為瞭簡化代碼編寫。我們這裡主要是介紹利用框架 mock，而手動 mock 隻是簡單介紹。

手動 mock

手動 mock 其實就是重新創建一個類繼承被 mock 的服務類，並重寫裡面的方法。在單元測試中，利用依賴註入的方式使用 mock 的服務類替換原來的服務類。具體代碼示列如下：

/**
 * UserRepository
 *
 * @author star
 */
@Repository
public class UserRepository {

  /**
   * 模擬從數據庫中獲取用戶信息，實際開發中需要連接真實的數據庫
   */
  public User getUser(String name) {
    User user = new User();
    user.setName("testing");
    user.setEmail("[email protected]");

    return user;
  }
}

/**
 * MockUserRepository
 *
 * @author star
 */
public class MockUserRepository extends UserRepository {

  /**
   * 模擬從數據庫中獲取用戶信息
   */
  @Override
  public User getUser(String name) {
    User user = new User();
    user.setName("mock-test-name");
    user.setEmail("mock-test-email");

    return user;
  }
}

// 進行單元測試
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceManualTest {

  @Autowired
  private UserService userService;

  @Test
  public void testGetUser_Manual() {
    // 將 MockUserRepository 註入到 UserService 中
    userService.setUserRepository(new MockUserRepository());
    User user = userService.getUser("mock-test-name");
    Assert.assertEquals("mock-test-name", user.getName());
    Assert.assertEquals("mock-test-email", user.getEmail());
  }
}

從上面的代碼中，我們可以看到手動 mock 需要編寫大量的額外代碼，同時被測試類也需要提供依賴註入的入口（setter 方法等）。如果被 mock 的類修改瞭函數名稱或者功能，mock 類也要跟著修改，增加瞭維護成本。

為瞭提高效率，減少維護成本，我們推薦使用單元測是框架進行 mock。

利用框架 mock

這裡我們主要介紹 Mokito.mock()、@Mock、@MockBean 這三種方式的 mock。

Mocito.mock()

Mocito.mock() 方法允許我們創建類或接口的 mock 對象。然後，我們可以使用 mock 對象指定其方法的返回值，並驗證其方法是否被調用。代碼示列如下：

@Test
public void testGetUser_MockMethod() {
  // 模擬 UserRepository，測試時不直接操作數據庫
  UserRepository mockUserRepository = Mockito.mock(UserRepository.class);
  // 將 mockUserRepository 註入到 UserService 類中
  userService.setUserRepository(mockUserRepository);

  User mockUser = mockUser();
  Mockito.when(mockUserRepository.getUser(mockUser.getName()))
      .thenReturn(mockUser);

  User user = userService.getUser(mockUser.getName());
  Assert.assertEquals(mockUser.getName(), user.getName());
  Assert.assertEquals(mockUser.getEmail(), user.getEmail());

  // 驗證 mockUserRepository.getUser() 方法是否執行
  Mockito.verify(mockUserRepository).getUser(mockUser.getName());
}

@Mock

@Mock 是 Mockito.mock() 方法的簡寫。同樣，我們應該隻在測試類中使用它。與 Mockito.mock() 方法不同的是，我們需要在測試期間啟用 Mockito 註解才能使用 @Mock 註解。

我們可以調用 MockitoAnnotations.initMocks(this) 靜態方法來啟用 Mockito 註解。為瞭避免測試之間的副作用，建議在每次測試執行之前先進行以下操作：

@Before
public void setup() {
  // 啟用 Mockito 註解
  MockitoAnnotations.initMocks(this);
}

我們還可以使用另一種方法來啟用 Mockito 註解。通過在 @RunWith() 指定 MockitoJUnitRunner 來運行測試：

@RunWith(MockitoJUnitRunner.class)
public class UserServiceMockTest { 

}

下面我們來看看如何使用 @Mock 進行服務 mock。代碼示列如下：

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceMockTest {

  @Mock
  private UserRepository userRepository;

  @Autowired
  @InjectMocks
  private UserService userService;

  private User mockUser() {
    User user = new User();
    user.setName("mock-test-name");
    user.setEmail("mock-test-email");

    return user;
  }

  @Before
  public void setup() {
    // 啟用 Mockito 註解
    MockitoAnnotations.initMocks(this);
  }

  @Test
  public void testGetUser_MockAnnotation() {
    User mockUser = mockUser();
    Mockito.when(userRepository.getUser(mockUser.getName()))
        .thenReturn(mockUser);

    User user = userService.getUser(mockUser.getName());
    Assert.assertEquals(mockUser.getName(), user.getName());
    Assert.assertEquals(mockUser.getEmail(), user.getEmail());

    // 驗證 mockUserRepository.getUser() 方法是否執行
    Mockito.verify(userRepository).getUser(mockUser.getName());
  }

}

Mockito 的 @InjectMocks 註解作用是將 @Mock 所修飾的 mock 對象註入到指定類中替換原有的對象。

@MockBean

@MockBean 是 Spring Boot 中的註解。我們可以使用 @MockBean 將 mock 對象添加到 Spring 應用程序上下文中。該 mock 對象將替換應用程序上下文中任何現有的相同類型的 bean。如果應用程序上下文中沒有相同類型的 bean，它將使用 mock 的對象作為 bean 添加到上下文中。

@MockBean 在需要 mock 特定 bean（例如外部服務）的集成測試中很有用。

要使用 @MockBean 註解，我們必須在 @RunWith() 中指定 SpringRunner 來運行測試。代碼示列如下：

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceMockBeanTest {

  @MockBean
  private UserRepository userRepository;

  private User mockUser() {
    User user = new User();
    user.setName("mock-test-name");
    user.setEmail("mock-test-email");

    return user;
  }

  @Test
  public void testGetUser_MockBean() {
    User mockUser = mockUser();
    // 模擬 UserRepository
    Mockito.when(userRepository.getUser(mockUser.getName()))
        .thenReturn(mockUser);
    // 驗證結果
    User user = userRepository.getUser(mockUser.getName());
    Assert.assertEquals(mockUser.getName(), user.getName());
    Assert.assertEquals(mockUser.getEmail(), user.getEmail());

    Mockito.verify(userRepository).getUser(mockUser.getName());
  }
}

這裡需要註意的是，Spring test 默認會重用 bean。如果 A 測試使用 mock 對象進行測試，而 B 測試使用原有的相同類型對象進行測試，B 測試在 A 測試之後運行，那麼 B 測試拿到的對象是 mock 的對象。一般這種情況是不期望的，所以需要用 @DirtiesContext 修飾上面的測試避免這個問題。

最後，小夥伴們可以在 GitHub 中獲取源碼。

到此這篇關於Spring 單元測試中如何進行 mock的實現的文章就介紹到這瞭,更多相關Spring 單元測試mock內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：