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

那我們?nèi)绾蝸?mock 服務進行單元測試呢？mock 的方式主要有兩種：手動 mock 和利用單元測試框架 mock。其中，利用框架 mock 主要是為了簡化代碼編寫。我們這里主要是介紹利用框架 mock，而手動 mock 只是簡單介紹。

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

/** * UserRepository * * @author star */@Repositorypublic class UserRepository { /** * 模擬從數(shù)據(jù)庫中獲取用戶信息，實際開發(fā)中需要連接真實的數(shù)據(jù)庫 */ 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 { /** * 模擬從數(shù)據(jù)庫中獲取用戶信息 */ @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)@SpringBootTestpublic 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 的類修改了函數(shù)名稱或者功能，mock 類也要跟著修改，增加了維護成本。

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

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

Mocito.mock()

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

@Testpublic void testGetUser_MockMethod() { // 模擬 UserRepository，測試時不直接操作數(shù)據(jù)庫 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() 方法是否執(zhí)行 Mockito.verify(mockUserRepository).getUser(mockUser.getName());}

@Mock

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

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

@Beforepublic void setup() { // 啟用 Mockito 注解 MockitoAnnotations.initMocks(this);}

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

@RunWith(MockitoJUnitRunner.class)public class UserServiceMockTest { }

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

@RunWith(SpringRunner.class)@SpringBootTestpublic 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() 方法是否執(zhí)行 Mockito.verify(userRepository).getUser(mockUser.getName()); }}

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

@MockBean

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

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

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

@RunWith(SpringRunner.class)@SpringBootTestpublic 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); // 驗證結(jié)果 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 中獲取源碼。

到此這篇關(guān)于Spring 單元測試中如何進行 mock的實現(xiàn)的文章就介紹到這了,更多相關(guān)Spring 單元測試mock內(nèi)容請搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)！