基于spring-boot的應(yīng)用程序的單元測試方案

概述

本文主要介紹如何對基于spring-boot的web應(yīng)用編寫單元測試、集成測試的代碼。

此類應(yīng)用的架構(gòu)圖一般如下所示：

web-structure.png

我們項目的程序，對應(yīng)到上圖中的web應(yīng)用部分。這部分一般分為Controller層、service層、持久層。除此之外，應(yīng)用程序中還有一些數(shù)據(jù)封裝類，我們稱之為domain。上述各組件的職責(zé)如下：

  • Controller層/Rest接口層: 負(fù)責(zé)對外提供Rest服務(wù)，接收Rest請求，返回處理結(jié)果。
  • service層: 業(yè)務(wù)邏輯層，根據(jù)Controller層的需要，實現(xiàn)具體的邏輯。
  • 持久層: 訪問數(shù)據(jù)庫，進(jìn)行數(shù)據(jù)的讀寫。向上支撐service層的數(shù)據(jù)庫訪問需求。

在Spring環(huán)境中，我們通常會把這三層注冊到Spring容器，上圖中使用淺藍(lán)色背景就是為了表示這一點。

在本文的后續(xù)內(nèi)容，我們將介紹如何對應(yīng)用進(jìn)行集成測試，包括啟動web容器的請求測試、不啟動web容器而使用模擬環(huán)境的測試；介紹如何對應(yīng)用進(jìn)行單元測試，包括單獨測試Controller層、service層、持久層。

集成測試和單元測試的區(qū)別是，集成測試通常只需要測試最上面一層，因為上層會自動調(diào)用下層，所以會測試完整的流程鏈，流程鏈中每一個環(huán)節(jié)都是真實、具體的。單元測試是單獨測試流程鏈中的某一環(huán)，這一個環(huán)所直接依賴的下游環(huán)節(jié)使用模擬的方式來提供支撐，這一技術(shù)稱為Mock。在介紹單元測試的時候，我們會介紹如何mock依賴對象，并簡單對mock的原理進(jìn)行介紹。

本文所關(guān)注的另一個主題，是在持久層測試時，如何消除修改數(shù)據(jù)庫的副作用。

集成測試

集成測試是在所有組件都已經(jīng)開發(fā)完成之后，進(jìn)行組裝測試。有兩種測試方式：啟動web容器進(jìn)行測試，使用模擬環(huán)境測試。這兩種測試的效果沒有什么差別，只是使用模擬環(huán)境測試的話，可以不用啟動web容器，從而會少一些開銷。另外，兩者的測試API會有所不同。

啟動web容器進(jìn)行測試

我們通過測試最上層的Controller來實施集成測試，我們的測試目標(biāo)如下：

@RestController
public class CityController {

    @Autowired
    private CityService cityService;

    @GetMapping("/cities")
    public ResponseEntity<?> getAllCities() {
        List<City> cities = cityService.getAllCities();
        return ResponseEntity.ok(cities);
    }
}

這是一個Controller，它對外提供一個服務(wù)/cities，返回一個包含所有城市的列表。這個Controller通過調(diào)用下一層的CityService來完成自己的職責(zé)。

針對這個Controller的集成測試方案如下：

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class CityControllerWithRunningServer {

    @Autowired
    private TestRestTemplate restTemplate;

    @Test
    public void getAllCitiesTest() {
        String response = restTemplate.getForObject("/cities", String.class);
        Assertions.assertThat(response).contains("San Francisco");
    }
}

首先我們使用@RunWith(SpringRunner.class)聲明在Spring的環(huán)境中進(jìn)行單元測試，這樣Spring的相關(guān)注解才會被識別并起效。然后我們使用@SpringBootTest，它會掃描應(yīng)用程序的spring配置，并構(gòu)建完整的Spring Context。我們?yōu)槠鋮?shù)webEnvironment賦值為SpringBootTest.WebEnvironment.RANDOM_PORT，這樣就會啟動web容器，并監(jiān)聽一個隨機(jī)的端口，同時，為我們自動裝配一個TestRestTemplate類型的bean來輔助我們發(fā)送請求。

使用模擬環(huán)境測試

測試的目標(biāo)不變，測試的方案如下：

@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
public class CityControllerWithMockEnvironment {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void getAllCities() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.get("/cities"))
                .andDo(MockMvcResultHandlers.print())
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.content().string(Matchers.containsString("San Francisco")));
    }
}

我們依然使用@SpringBootTest，但是沒有設(shè)置其webEnvironment屬性，這樣依然會構(gòu)建完整的Spring Context，但是不會再啟動web容器。為了進(jìn)行測試，我們需要使用MockMvc實例發(fā)送請求，而我們使用@AutoConfigureMockMvc則是因為這樣可以獲得自動配置的MockMvc實例。

具體測試的代碼中出現(xiàn)很多新的API，對于API細(xì)節(jié)的研究不在本文計劃范圍內(nèi)。

單元測試

上文中描述的兩種集成測試的方案，相同的一點是都會構(gòu)建整個Spring Context。這表示所有聲明的bean，而不管聲明的方式為何，都會被構(gòu)建實例，并且都能被依賴。這里隱含的意思是從上到下整條依賴鏈上的代碼都已實現(xiàn)。

Mock技術(shù)

在開發(fā)的過程中進(jìn)行測試，無法滿足上述的條件，Mock技術(shù)可以讓我們屏蔽掉下層的依賴，從而專注于當(dāng)前的測試目標(biāo)。Mock技術(shù)的思想是，當(dāng)測試目標(biāo)的下層依賴的行為是可預(yù)期的，那么測試目標(biāo)本身的行為也是可預(yù)期的，測試就是把實際的結(jié)果和測試目標(biāo)的預(yù)期結(jié)果做比較，而Mock就是預(yù)先設(shè)定下層依賴的行為表現(xiàn)。

Mock的流程

  1. 將測試目標(biāo)的依賴對象進(jìn)行mock，設(shè)定其預(yù)期的行為表現(xiàn)。
  2. 對測試目標(biāo)進(jìn)行測試。
  3. 檢測測試結(jié)果，檢查在依賴對象的預(yù)期行為下，測試目標(biāo)的結(jié)果是否符合預(yù)期。

Mock的使用場景

  1. 多人協(xié)作時，可以通過mock進(jìn)行無等待的測試先行。
  2. 當(dāng)測試目標(biāo)的依賴對象需要訪問外部的服務(wù)，而外部服務(wù)不易獲得時，可以通過mock來模擬服務(wù)可用。
  3. 當(dāng)在排查不容易復(fù)現(xiàn)的問題場景時，通過mock來模擬問題。

測試web層

測試的目標(biāo)不變，測試的方案如下：

/**
 * 不構(gòu)建整個Spring Context，只構(gòu)建指定的Controller進(jìn)行測試。需要對相關(guān)的依賴進(jìn)行mock.<br>
 * Created by lijinlong9 on 2018/8/22.
 */
@RunWith(SpringRunner.class)
@WebMvcTest(CityController.class)
public class CityControllerWebLayer {

    @Autowired
    private MockMvc mvc;

    @MockBean
    private CityService service;

    @Test
    public void getAllCities() throws Exception {

        City city = new City();
        city.setId(1L);
        city.setName("杭州");
        city.setState("浙江");
        city.setCountry("中國");

        Mockito.when(service.getAllCities()).thenReturn(Collections.singletonList(city));

        mvc.perform(MockMvcRequestBuilders.get("/cities"))
                .andDo(MockMvcResultHandlers.print())
                .andExpect(MockMvcResultMatchers.content().string(Matchers.containsString("杭州")));
    }
}

這里不再使用@SpringBootTest，而代之以@WebMvcTest，這樣只會構(gòu)建web層或者指定的一到多個Controller的bean。@WebMvcTest同樣可以為我們自動配置MockMvc類型的bean，我們可以使用它來模擬發(fā)送請求。

@MockBean是一個新接觸的注解，它表示對應(yīng)的bean是一個模擬的bean。因為我們要測試CityController，對其依賴的CityService，我們需要mock其預(yù)期的行為表現(xiàn)。在具體的測試方法中，使用Mockito的API對sercive的行為進(jìn)行mock，它表示當(dāng)調(diào)用service的getAllCities時，會返回預(yù)先設(shè)定的一個City對象的列表。

之后就是發(fā)起請求，并預(yù)測結(jié)果。

Mockito是Java語言的mock測試框架，spring以自己的方式集成了它。

測試持久層

持久層的測試方案跟具體的持久層技術(shù)相關(guān)。這里我們介紹基于Mybatis的持久層的測試。

測試目標(biāo)是：

@Mapper
public interface CityMapper {

    City selectCityById(int id);

    List<City> selectAllCities();

    int insert(City city);

}

測試方案是：

@RunWith(SpringRunner.class)
@MybatisTest
@FixMethodOrder(value = MethodSorters.NAME_ASCENDING)
// @Transactional(propagation = Propagation.NOT_SUPPORTED)
public class CityMapperTest {

    @Autowired
    private CityMapper cityMapper;

    @Test
    public void /*selectCityById*/ test1() throws Exception {
        City city = cityMapper.selectCityById(1);
        Assertions.assertThat(city.getId()).isEqualTo(Long.valueOf(1));
        Assertions.assertThat(city.getName()).isEqualTo("San Francisco");
        Assertions.assertThat(city.getState()).isEqualTo("CA");
        Assertions.assertThat(city.getCountry()).isEqualTo("US");
    }

    @Test
    public void /*insertCity*/ test2() throws Exception {
        City city = new City();
        city.setId(2L);
        city.setName("HangZhou");
        city.setState("ZheJiang");
        city.setCountry("CN");

        int result = cityMapper.insert(city);
        Assertions.assertThat(result).isEqualTo(1);
    }

    @Test
    public void /*selectNewInsertedCity*/ test3() throws Exception {
        City city = cityMapper.selectCityById(2);
        Assertions.assertThat(city).isNull();
    }
}

這里使用了@MybatisTest，它負(fù)責(zé)構(gòu)建mybatis-mapper層的bean，就像上文中使用的@WebMvcTest負(fù)責(zé)構(gòu)建web層的bean一樣。值得一提的是@MybatisTest來自于mybatis-spring-boot-starter-test項目，它是mybatis團(tuán)隊根據(jù)spring的習(xí)慣來實現(xiàn)的。Spring原生支持的兩種持久層的測試方案是@DataJpaTest和@JdbcTest，分別對應(yīng)JPA持久化方案和JDBC持久化方案。

@FixMethodOrder來自junit，目的是為了讓一個測試類中的多個測試方案按照設(shè)定的順序執(zhí)行。一般情況下不需要如此，我這里想確認(rèn)test2方法中插入的數(shù)據(jù)，在test3中是否還存在，所以需要保證兩者的執(zhí)行順序。

我們注入了CityMapper，因為其沒有更底層的依賴，所以我們不需要進(jìn)行mock。

@MybatisTest除了實例化mapper相關(guān)的bean之外，還會檢測依賴中的內(nèi)嵌數(shù)據(jù)庫，然后測試的時候使用內(nèi)嵌數(shù)據(jù)庫。如果依賴中沒有內(nèi)嵌數(shù)據(jù)庫，就會失敗。當(dāng)然，使用內(nèi)嵌數(shù)據(jù)庫是默認(rèn)的行為，可以使用配置進(jìn)行修改。

@MybatisTest還會確保每一個測試方法都是事務(wù)回滾的，所以在上述的測試用例中，test2插入了數(shù)據(jù)之后，test3中依然獲取不到插入的數(shù)據(jù)。當(dāng)然，這也是默認(rèn)的行為，可以改變。

測試任意的bean

service層并不作為一種特殊的層，所以沒有什么注解能表示“只構(gòu)建service層的bean”這種概念。

這里將介紹另一種通用的測試場景，我要測試的是一個普通的bean，沒有什么特殊的角色，比如不是擔(dān)當(dāng)特殊處理的controller，也不是負(fù)責(zé)持久化的dao組件，我們要測試的只是一個普通的bean。

上文中我們使用@SpringBootTest的默認(rèn)機(jī)制，它去查找@SpringBootApplication的配置，據(jù)此構(gòu)建Spring的上下文。查看@SpringBootTest的doc，其中有一句是：

Automatically searches for a @SpringBootConfiguration when nested @Configuration is not used, and no explicit classes are specified.

這表示我們可以通過classes屬性來指定Configuration類，或者定義內(nèi)嵌的Configuration類來改變默認(rèn)的配置。

在這里我們通過內(nèi)嵌的Configuration類來實現(xiàn)，先看下測試目標(biāo) - CityService:

@Service
public class CityService {

    @Autowired
    private CityMapper cityMapper;

    public List<City> getAllCities() {
        return cityMapper.selectAllCities();
    }
}

測試方案：

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

    @Configuration
    static class CityServiceConfig {
        @Bean
        public CityService cityService() {
            return new CityService();
        }
    }

    @Autowired
    private CityService cityService;

    @MockBean
    private CityMapper cityMapper;

    @Test
    public void getAllCities() {
        City city = new City();
        city.setId(1L);
        city.setName("杭州");
        city.setState("浙江");
        city.setCountry("CN");

        Mockito.when(cityMapper.selectAllCities())
                .thenReturn(Collections.singletonList(city));

        List<City> result = cityService.getAllCities();
        Assertions.assertThat(result.size()).isEqualTo(1);
        Assertions.assertThat(result.get(0).getName()).isEqualTo("杭州");
    }
}

同樣的，對于測試目標(biāo)的依賴，我們需要進(jìn)行mock。

Mock操作

單元測試中，需要對測試目標(biāo)的依賴進(jìn)行mock，這里有必要對mock的細(xì)節(jié)介紹下。上文單元測試部分已對Mock的邏輯、流程和使用場景進(jìn)行了介紹，此處專注于實踐層面進(jìn)行說明。

根據(jù)方法參數(shù)設(shè)定預(yù)期行為

一般的mock是對方法級別的mock，在方法有入?yún)⒌那闆r下，方法的行為可能會跟方法的具體參數(shù)值有關(guān)。比如一個除法的方法，傳入?yún)?shù)4、2得結(jié)果2，傳入?yún)?shù)8、2得結(jié)果4，傳入?yún)?shù)2、0得異常。

mock可以針對不同的參數(shù)值設(shè)定不同的預(yù)期，如下所示：

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

    @Configuration
    static class ConfigTest {}

    @MockBean
    private MathService mathService;

    @Test
    public void testDivide() {
        Mockito.when(mathService.divide(4, 2))
                .thenReturn(2);

        Mockito.when(mathService.divide(8, 2))
                .thenReturn(4);

        Mockito.when(mathService.divide(ArgumentMatchers.anyInt(), ArgumentMatchers.eq(0))) // 必須同時用matchers語法
                .thenThrow(new RuntimeException("error"));

        Assertions.assertThat(mathService.divide(4, 2))
                .isEqualTo(2);

        Assertions.assertThat(mathService.divide(8, 2))
                .isEqualTo(4);

        Assertions.assertThatExceptionOfType(RuntimeException.class)
                .isThrownBy(() -> {
                    mathService.divide(3, 0);
                })
                .withMessageContaining("error");
    }
}

上面的測試可能有些奇怪，mock的對象也同時作為測試的目標(biāo)。這是因為我們的目的在于介紹mock，所以簡化了測試流程。

從上述測試用例可以看出，我們除了可以指定具體參數(shù)時的行為，也可以指定參數(shù)滿足一定匹配規(guī)則時的行為。

有返回的方法

對于有返回的方法，mock時可以設(shè)定的行為有：

返回設(shè)定的結(jié)果，如：

when(taskService.findResourcePool(any()))
        .thenReturn(resourcePool);

直接拋出異常，如：

when(taskService.createTask(any(), any(), any()))
        .thenThrow(new RuntimeException("zz"));

實際調(diào)用真實的方法，如：

when(taskService.createTask(any(), any(), any()))
        .thenCallRealMethod();

注意，調(diào)用真實的方法有違mock的本義，應(yīng)該盡量避免。如果要調(diào)用的方法中調(diào)用了其他的依賴，需要自行注入其他的依賴，否則會空指針。

無返回的方法

對于無返回的方法，mock時可以設(shè)定的行為有：

直接拋出異常，如：

doThrow(new RuntimeException("test"))
        .when(taskService).saveToDBAndSubmitToQueue(any());

實際調(diào)用（下列為Mockito類的doc中給出的示例，我并沒有遇到此需求），如：

doAnswer(new Answer() {
    public Object answer(InvocationOnMock invocation) {
        Object[] args = invocation.getArguments();
        Mock mock = invocation.getMock();
        return null;
    }})
.when(mock).someMethod();

附錄

相關(guān)注解的匯總

annotations.png
  • @RunWith:
    junit的注解，通過這個注解使用SpringRunner.class，能夠?qū)unit和spring進(jìn)行集成。后續(xù)的spring相關(guān)注解才會起效。
  • @SpringBootTest:
    spring的注解，通過掃描應(yīng)用程序中的配置來構(gòu)建測試用的Spring上下文。
  • @AutoConfigureMockMvc:
    spring的注解，能夠自動配置MockMvc對象實例，用來在模擬測試環(huán)境中發(fā)送http請求。
  • @WebMvcTest:
    spring的注解，切片測試的一種。使之替換@SpringBootTest能將構(gòu)建bean的范圍限定于web層，但是web層的下層依賴bean，需要通過mock來模擬。也可以通過參數(shù)指定只實例化web層的某一個到多個controller。具體可參考Auto-configured Spring MVC Tests。
  • @RestClientTest:
    spring的注解，切片測試的一種。如果應(yīng)用程序作為客戶端訪問其他Rest服務(wù)，可以通過這個注解來測試客戶端的功能。具體參考Auto-configured REST Clients。
  • @MybatisTest:
    mybatis按照spring的習(xí)慣開發(fā)的注解，切片測試的一種。使之替換@SpringBootTest，能夠?qū)?gòu)建bean的返回限定于mybatis-mapper層。具體可參考mybatis-spring-boot-test-autoconfigure。
  • @JdbcTest:
    spring的注解，切片測試的一種。如果應(yīng)用程序中使用Jdbc作為持久層（spring的JdbcTemplate），那么可以使用該注解代替@SpringBootTest，限定bean的構(gòu)建范圍。官方參考資料有限，可自行網(wǎng)上查找資料。
  • @DataJpaTest:
    spring的注解，切片測試的一種。如果使用Jpa作為持久層技術(shù)，可以使用這個注解，參考Auto-configured Data JPA Tests。
  • @DataRedisTest:
    spring的注解，切片測試的一種。具體內(nèi)容參考Auto-configured Data Redis Tests。

設(shè)置測試數(shù)據(jù)庫

給持久層測試類添加注解@AutoConfigureTestDatabase(replace = Replace.NONE)可以使用配置的數(shù)據(jù)庫作為測試數(shù)據(jù)庫。同時，需要在配置文件中配置數(shù)據(jù)源，如下：

spring:
  datasource:
      url: jdbc:mysql://127.0.0.1/test
      username: root
      password: root
      driver-class-name: com.mysql.jdbc.Driver

事務(wù)不回滾

可以在測試方法上添加@Rollback(false)來設(shè)置不回滾，也可以在測試類的級別上添加該注解，表示該類所有的測試方法都不會回滾。

參考

  1. Spring Boot Testing
  2. Spring Boot Test博客
  3. Mybatis Spring Boot Test官方資料
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容