基于SpringBoot實(shí)現單元測試的多種情境/方法（二）

本文分享自天翼云開(kāi)發(fā)者社區@《基于SpringBoot實(shí)現單元測試的多種情境/方法（二）》，  作者：才開(kāi)始學(xué)技術(shù)的小白

鏈接：

https://www.ctyun.cn/developer/article/361093168906309?track=|cp:cz_bk|tgdy:wenzhang|ttjh:bokeshequ|key:bw309|pf:PC

在上一篇分享中我們詳細介紹了簡(jiǎn)單的、用mock來(lái)模擬接口測試環(huán)境的方法，具體的使用樣例我們再回顧一下：

1.首先是最簡(jiǎn)單的不需要傳參的示例，需要注意的是，可能@Resource這個(gè)注解識別不了，沒(méi)關(guān)系，換成@Autowired通常是等效的

//進(jìn)行每一次mock模擬tomcat容器的時(shí)候，使用隨機端口啟動(dòng)，這樣不會(huì )有端口占用的問(wèn)題@SpringBootTest(classes = {Springboot01Application.class}, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)//自動(dòng)配置以及啟用mvc對象@AutoConfigureMockMvcpublic class MockMVCTester {

    //注入MockMVC對象，它是springtest依賴(lài)中自帶的

    @Resource

    private MockMvc mockMvc;

    @Test

    public void testMock() throws Exception {

        //獲取mock返回的對象

        MvcResult result = mockMvc.perform(MockMvcRequestBuilders.get("/user"))//perform模擬一個(gè)http請求,這里是get方法

                .andExpect(MockMvcResultMatchers.status().isOk())//添加預期，如果服務(wù)器返回的是200

                .andDo(MockMvcResultHandlers.print())//那我們就把請求和響應的信息在控制臺中打印輸出

                .andExpect(MockMvcResultMatchers.content().string("[{\"uid\":1001,\"uname\":\"wu\"," +

                        "\"password\":\"1212\",\"addrs\":[\"nanchang\",\"sichuan\",\"beijing\"]}," +

                        "{\"uid\":1002,\"uname\":\"du\",\"password\":\"1313\",\"addrs\"" +

                        ":[\"chang\",\"sica\",\"beng\"]}]"))//content表示對于返回的請求體數據進(jìn)行判斷，string表示進(jìn)行比對

                .andReturn();//將結果返回出來(lái)

    }}

2.如果get方法需要傳參，通常是在query中（也就是問(wèn)號傳參的形式），也有可能是正常傳參，而且這種通常有json返回，正常傳參的示例如下（.param也可以改為.params）；如果是query傳參，改用.queryparam即可

@Test@DisplayName("get方法+有入參+有json返回")public void testMock1() throws Exception {

    //mock返回的對象可以不獲取，因為單純的判斷對錯用不上

    mockMvc.perform(MockMvcRequestBuilders.get("/user/para")//perform模擬一個(gè)http請求,這里是get方法

                    .header("token", "akakak")//請求頭

                    .param("id","wy")//請求參數

                    .param("password","asd"))//請求參數

            .andExpect(MockMvcResultMatchers.status().isOk())//添加預期，如果服務(wù)器回的是200

            .andDo(MockMvcResultHandlers.print())//那我們就把請求和響應的信息在控制臺中打印輸出

            .andExpect(MockMvcResultMatchers.jsonPath("ak").value("asd"))//獲取返回的json并核對對應的值是否一樣

            .andReturn();//將結果返回出來(lái)}

3.最后就是post方法的常用body傳參，一般都是json格式，示例如下；這里用到了IoC創(chuàng )建對象，不了解的讀者可以看看我專(zhuān)欄的IoC相關(guān)分享

@Test@DisplayName("post方法測試用例")public void testMock1() throws Exception {

    //IoC

    ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("IoC.xml");

    User user = context.getBean(User.class);

    ObjectMapper mapper = new ObjectMapper();

    user.setUname("wy");

    //mock返回的對象可以不獲取，因為單純的判斷對錯用不上

    mockMvc.perform(MockMvcRequestBuilders.post("/user")//perform模擬一個(gè)http請求,這里是get方法

                    .content(mapper.writeValueAsString(user))//用IoC建立一個(gè)User對象

                    .contentType(MediaType.APPLICATION_JSON_VALUE))//添加json類(lèi)數據，轉化為入參

            .andExpect(MockMvcResultMatchers.status().isOk())//添加預期，如果服務(wù)器回的是200

            .andDo(MockMvcResultHandlers.print())//那我們就把請求和響應的信息在控制臺中打印輸出

            .andExpect(MockMvcResultMatchers.jsonPath("uname").value("wy"))//獲取返回的json并核對對應的值是否一樣

            .andReturn();//將結果返回出來(lái)}

當然了，Mock不可能只有這些模擬接口的簡(jiǎn)單用法，本文就介紹一寫(xiě)些其他的常用模式

如果你使用的IDE和我一樣，是IDEA，那么你可以通過(guò)在需要寫(xiě)單元測試的方法上Ctrl+Shift+T來(lái)快捷創(chuàng )建

之后你當然可以選擇是否增加運行在測試之前的@Before、運行在測試之后的@After（即Junit的相關(guān)注解，在這里不贅述）

注：可以自行查閱JUnit文檔：https://junit.org/junit5/docs/current/user-guide/

有的時(shí)候我們需要測試的單元——比如說(shuō)某一個(gè)類(lèi)，可能依賴(lài)于其他的類(lèi)，而且這個(gè)被依賴(lài)的類(lèi)往往不是很好構造，因為他們可能又依賴(lài)于其他的類(lèi)、庫、底層資源等等，這個(gè)時(shí)候mock就幫上了大忙：

1.創(chuàng )建測試用的類(lèi)

同樣我們來(lái)舉例說(shuō)明一下，假設我們有一個(gè)UserInfo類(lèi)存儲了用戶(hù)信息，他長(cháng)這個(gè)樣子：

public class UserInfo {

    private UserRepository userRepository;

    private UserWord userWord;

    public String getUserAddr(){

        return userRepository.getUsrAddr();

    }}

非常簡(jiǎn)單的一個(gè)UserInfo類(lèi)，可以看到他依賴(lài)于兩個(gè)子類(lèi)，一個(gè)是用戶(hù)數據庫（UserRepository），一個(gè)是用戶(hù)詞（UserWord）

**都是隨便編的哈不要在意**

這兩個(gè)子類(lèi)長(cháng)這個(gè)樣子：

@Datapublic class UserWord {

    private String word1;

    private String word2;}

@Datapublic class UserRepository {

    private String repUUID;

    private String usrPassword;

    private String usrAddr = "Sichuan";}

也一樣非常簡(jiǎn)單，但大家可以看到我們把UserRepository的usrAddr這個(gè)屬性賦了一個(gè)默認值“Sichuan”，為什么呢？就是為了解釋@Spy和@Mock的作用

2.幾個(gè)重要注解的定義：

@Mock 非真實(shí)執行，用來(lái)模擬在測試中不好創(chuàng )建的類(lèi)

@Spy 真實(shí)執行，用來(lái)模擬需要真實(shí)執行的類(lèi)

@InjectMocks 真實(shí)執行，針對實(shí)現類(lèi)使用，不能作用在接口上

大家可能看的一頭霧水，但其實(shí)用我們剛剛的UserInfo示例來(lái)解釋?zhuān)头浅：?jiǎn)單：

UserRepository這個(gè)類(lèi)，雖然在我們這里很簡(jiǎn)單，但我們把他當做一個(gè)數據庫類(lèi)來(lái)理解——也就是說(shuō)，在真實(shí)開(kāi)發(fā)中，這樣的類(lèi)在單元測試中是不好處理的，因為你不可能為了測試UserInfo這個(gè)類(lèi)的方法，去專(zhuān)門(mén)建一個(gè)數據庫，這個(gè)太麻煩了。

那么@Mock就起到了這么一個(gè)作用，他相當于給所注解的實(shí)例套了一個(gè)外殼，我們不用關(guān)心里面是怎么樣的，系統將其全部設置為null

相當于我們在單元測試的時(shí)候，不管@Mock所在的類(lèi)究竟是什么樣子，也不需要專(zhuān)門(mén)為了他去建數據庫、建依賴(lài)。

這就是Mock的核心作用——依賴(lài)解耦，尤其是在單元測試中，我們要斬斷復雜的類(lèi)依賴(lài)關(guān)系，專(zhuān)心測試某一塊的功能。

那么@Spy就很好理解了，有些我們需要用到其中功能的類(lèi)，或者說(shuō)比較簡(jiǎn)單的類(lèi)，就用@Spy來(lái)注入，@Mock和@Spy都是將實(shí)例注入到@InjectMocks所標注的地方，用一段測試代碼來(lái)展示這一點(diǎn)：

@SpringBootTest(classes = {Springboot01Application.class}, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)public class MockTest2 {

    @Mock

    private UserRepository userRepository;

    @Spy

    private UserWord userWord;

    @InjectMocks

    private UserInfo userInfo;

    @Test

    public void test1(){

        Assertions.assertEquals("Sichuan",userInfo.getUserAddr());

    }}

可以看到，我們并沒(méi)有專(zhuān)門(mén)創(chuàng )建UserInfo的子類(lèi)，而是直接用了注入的辦法；這其實(shí)跟Spring本身的@Component+@Autowired的方法有點(diǎn)類(lèi)似，

這里如果去運行test1，是不會(huì )通過(guò)的；因為UserRepository使用@Mock來(lái)注入的，里面的東西都是null，如果改成@Spy，測試就可以通過(guò)了。

有一種情況：UserRepository不好創(chuàng )建所以我們用Mock模擬一個(gè)，但萬(wàn)一我還是想要用里面的某個(gè)方法呢？萬(wàn)一UserInfo的某個(gè)方法依賴(lài)于UserRepository的某一個(gè)方法的返回呢？這種情況我顯然不能再返回null了，所以“樁”就用在了這種情況：

樁函數(stub)：使用一些自己定義的測試函數來(lái)替換當前需要測試的函數。被替換的函數可能是目前還沒(méi)寫(xiě)完的，這樣能夠加速開(kāi)發(fā)，或更好的找錯誤源。

打樁（存根）：模擬要調用的函數（打樁對象），給它提供樁函數，給樁函數返回一個(gè)值。簡(jiǎn)單的說(shuō)自定義輸入輸出，不打樁默認返回null。

也就是說(shuō)，我可以讓UserRepository去打樁來(lái)返回一個(gè)我需要的值?。?！

這樣一來(lái)就非常方便了，舉一個(gè)非常常用且經(jīng)典的例子：

    @Test

    public void test1(){

        Mockito.when(userRepository.getUsrAddr()).thenReturn("Beijing");

        Assertions.assertEquals("Beijing",userInfo.getUserAddr());

    }

可以看到，新的test1如上，when...thenReturn方法設置了這個(gè)Mock對象的方法被調用的時(shí)候應該返回一個(gè)什么樣的值，即我們自定義了Mock方法的出入參（當然了這里沒(méi)有入參），這個(gè)測試案例是可以通過(guò)的，因為方法被調用的時(shí)候不再返回默認值null了

when...thenReturn就是我們的樁函數，

Mockito.when(userRepository.getUsrAddr()).thenReturn("Beijing");就是我們的打樁過(guò)程

實(shí)際上Mockito庫有很多方法可以供我們調用，即使是@Spy注入的類(lèi)也可以使用，大家可以自行去查手冊，或者參考下表：

很多開(kāi)發(fā)都會(huì )接觸到Linux系統，如果有些功能是給Linux寫(xiě)的，集成測試、系統測試就需要去搭建一套測試環(huán)境，但怎么去做單元測試呢？單元測試就應該盡可能的簡(jiǎn)單和全面，搭建一套這個(gè)環(huán)境也太麻煩了吧

沒(méi)辦法這次還真得搭，Mock也模擬不了虛擬機

我們是可以在IDEA中借用一些xshell來(lái)使用bash命令，但真正要跑測試，比較方便的還是自己搭一臺虛擬機出來(lái)，如果有不熟悉的可以關(guān)注我的Linux專(zhuān)欄，有搭建虛擬機的經(jīng)驗分享。

搭建并配網(wǎng)好了之后需要給虛擬機安裝Java，這個(gè)過(guò)程就比較簡(jiǎn)單了，貼個(gè)鏈接的大家可以參考：https://blog.csdn.net/wcy1900353090/article/details/125121855

安裝好了之后就可以按如下流程用IDEA鏈接虛擬機進(jìn)行測試：