SpringBoot測試之高級配置方式

更新時間：2024年04月19日 15:18:05 作者：.29.

這篇文章主要介紹了SpringBoot測試之高級配置方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

一、SpringBoot加載測試專用屬性

加載測試范圍的臨時屬性，應(yīng)用于小范圍測試環(huán)境

1.@SpringBootTest注解的properties參數(shù)

在啟動測試環(huán)境時，可以通過properties參數(shù)設(shè)置測試環(huán)境專用的屬性

/**
 * @author .29.
 * @create 2023-04-01 20:28
 */
//properties屬性，可以為當前測試用添加臨時的屬性配置
@SpringBootTest(properties = "test.prop=testValueByProperties")
public class PropertiesAndArgsTest {

    @Value("${test.prop}")
    private String msg;

    @Test
    public void testProperties(){
        System.out.println(msg);
    }
}

在這里插入圖片描述

對應(yīng)的application.yml配置文件內(nèi)容：

test:
  prop:

優(yōu)勢：比多環(huán)境開發(fā)中的測試環(huán)境影響范圍小，僅在當前測試類有效。

2.@SpringBootTest注解的args參數(shù)

在啟動測試環(huán)境時，可以通過args參數(shù)設(shè)置測試環(huán)境專用的傳入屬性

/**
 * @author .29.
 * @create 2023-04-01 20:28
 */

//args屬性，可以為當前測試用例添加臨時的命令行參數(shù)
@SpringBootTest(args = {"--test.prop=testValueByArgs"})
public class PropertiesAndArgsTest {

    @Value("${test.prop}")
    private String msg;

    @Test
    public void testProperties(){
        System.out.println(msg);
    }
}

在這里插入圖片描述

對應(yīng)的application.yml配置文件內(nèi)容：

test:
  prop:

二、SpringBoot加載測試專用配置

加載測試范圍配置，應(yīng)用于小范圍測試環(huán)境

專用的配置：

/**
 * @author .29.
 * @create 2023-04-01 21:27
 */
//專用的配置
@Configuration
public class MsgConfig {
    @Bean
    public String msg(){
        return "test @Import get msg";
    }
}

使用@Import注解，可以加載當前測試類專用的配置：

/**
 * @author .29.
 * @create 2023-04-01 21:30
 */
@SpringBootTest
@Import(MsgConfig.class)
public class ConfigurationTest {
    @Autowired
    private String msg;

    @Test
    public void testConfiguration(){
        System.out.println(msg);
    }
}

成功加載到專用配置中的內(nèi)容：

在這里插入圖片描述

三、SpringBoot 模擬測試Web環(huán)境

Web環(huán)境模擬測試

設(shè)置測試端口
模擬測試啟動
模擬測試匹配（各組成部分消息均可匹配）

1.啟動Web環(huán)境的不同方式

@SpringBootTest注解的webEnvironment屬性 提供了啟動Web環(huán)境的選擇：

在這里插入圖片描述

默認 webEnvironment = SpringBootTest.WebEnvironment.NONE：不啟動Web服務(wù)器

webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT：使用默認端口在測試類啟動Web服務(wù)器

/**
 * @author .29.
 * @create 2023-04-01 21:39
 */
//webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT：默認端口在測試類啟動Web服務(wù)器
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
public class WebTest {
    @Test
    public void test(){

    }
}

在這里插入圖片描述

webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT：使用隨機端口在測試類啟動Web服務(wù)器

/**
 * @author .29.
 * @create 2023-04-01 21:39
 */

//webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT： 隨機端口 在測試類啟動Web服務(wù)器
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class WebTest {
    @Test
    public void test(){

    }
}

在這里插入圖片描述

2.發(fā)起虛擬請求

控制層組件：

/**
 * @author .29.
 * @create 2023-04-01 22:38
 */
@RestController
@RequestMapping("/books")
public class BookController {
    @GetMapping
    public String get(){
        System.out.println("get() is running ...");
        return "Springboot";
    }
}

發(fā)起MVC虛擬調(diào)用，模擬發(fā)起請求

/**
 * @author .29.
 * @create 2023-04-01 21:39
 */

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
//@AutoConfigureMockMvc注解：開啟MVC虛擬調(diào)用
@AutoConfigureMockMvc
public class WebTest {
    @Test  //@Autowired注解，注入虛擬MVC調(diào)用對象
    public void testWeb(@Autowired MockMvc mockMvc) throws Exception {
        //創(chuàng)建虛擬請求，當前訪問/books
        MockHttpServletRequestBuilder builder = MockMvcRequestBuilders.get("/books");
        //執(zhí)行對應(yīng)的請求
        mockMvc.perform(builder);
    }
}

成功發(fā)起虛擬請求

在這里插入圖片描述

3.匹配響應(yīng)的執(zhí)行狀態(tài)

虛擬請求狀態(tài)匹配：

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
//開啟MVC虛擬調(diào)用
@AutoConfigureMockMvc
public class WebTest {
    @Test
    public void testStatus(@Autowired MockMvc mockMvc) throws Exception {
        //創(chuàng)建虛擬請求，當前訪問/books (這里故意寫錯，模擬匹配失敗)
        MockHttpServletRequestBuilder builder = MockMvcRequestBuilders.get("/books1");
        //執(zhí)行對應(yīng)的請求
        ResultActions actions = mockMvc.perform(builder);

        //設(shè)定預(yù)期值 與真實值進行比較，成功測試通過，失敗測試失敗
        //定義本次調(diào)用的預(yù)期值
        StatusResultMatchers status = MockMvcResultMatchers.status();
        //預(yù)計本次調(diào)用是成功的：狀態(tài)200
        ResultMatcher ok = status.isOk();
        //添加預(yù)期值到本次調(diào)用過程中，與真實執(zhí)行結(jié)果進行匹配
        actions.andExpect(ok);
    }
}

匹配失敗時，輸出匹配錯誤原因：

在這里插入圖片描述

4.匹配響應(yīng)體

/**
 * @author .29.
 * @create 2023-04-01 21:39
 */

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
//開啟MVC虛擬調(diào)用
@AutoConfigureMockMvc
public class WebTest {
    
    @Test
    public void testBody(@Autowired MockMvc mockMvc) throws Exception {
        MockHttpServletRequestBuilder builder = MockMvcRequestBuilders.get("/books");
        ResultActions actions = mockMvc.perform(builder);

        //設(shè)定預(yù)期值 與真實值進行比較，成功測試通過，失敗測試失敗
        //定義本次調(diào)用的預(yù)期值
        ContentResultMatchers content = MockMvcResultMatchers.content();
        //預(yù)計請求體為控制層組件的返回值"Springboot 測試類啟動web環(huán)境 發(fā)送虛擬請求"
        //如果請求體反饋JSON數(shù)據(jù)，string()改為json()
        ResultMatcher body = content.string("Springboot");
        //添加預(yù)期值到本次調(diào)用過程中，與真實執(zhí)行結(jié)果進行匹配
        actions.andExpect(body);
    }
    
}

5.匹配響應(yīng)頭

    @Test
    public void testHeader(@Autowired MockMvc mockMvc) throws Exception {
        MockHttpServletRequestBuilder builder = MockMvcRequestBuilders.get("/books");
        ResultActions actions = mockMvc.perform(builder);

        //設(shè)定預(yù)期值 與真實值進行比較，成功測試通過，失敗測試失敗
        //定義本次調(diào)用的預(yù)期值
        HeaderResultMatchers header = MockMvcResultMatchers.header();
        //預(yù)計請求頭的Content-Type 為 text/plain;charset=UTF-8
        ResultMatcher string = header.string("Content-Type", "text/plain;charset=UTF-8");
        //添加預(yù)期值到本次調(diào)用過程中，與真實執(zhí)行結(jié)果進行匹配
        actions.andExpect(string);
    }
}