SpringBoot测试——高级配置

清疚 2023-10-12 09:12 5阅读 0赞

![在这里插入图片描述][8d8e0d8a542946af858489a536162608.gif_pic_center]

> 个人简介：Java领域新星创作者；阿里云技术博主、星级博主、专家博主；正在Java学习的路上摸爬滚打，记录学习的过程~  
> 个人主页：[.29.的博客][.29.]  
> 学习社区：[进去逛一逛~][Link 1]

![在这里插入图片描述][e66b8188276943119fee04d04f6287f5.png_pic_center]

#### SpringBoot测试——高级配置 ####

*  一、SpringBoot加载测试专用属性
 *   *  1.@SpringBootTest注解的properties参数
     *  2.@SpringBootTest注解的args参数
 *  二、SpringBoot加载测试专用配置
 *  三、SpringBoot 模拟测试Web环境
 *   *  1.启动Web环境的不同方式
     *  2.发起虚拟请求
     *  3.匹配响应的执行状态
     *  4.匹配响应体
     *  5.匹配响应头

## 一、SpringBoot加载测试专用属性 ##

加载测试范围的临时属性，应用于小范围测试环境

### 1.@SpringBootTest注解的properties参数 ###

--------------------

*  在启动测试环境时，可以通过properties参数设置测试环境专用的属性

/**
     * @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);
        }
    }

> ![在这里插入图片描述][681fc345d6c549418a424295fbde8db3.png_pic_center]

*  对应的application.yml配置文件内容：

test:
      prop:

`优势`：比多环境开发中的测试环境影响范围小，仅在当前测试类有效。

### 2.@SpringBootTest注解的args参数 ###

--------------------

*  在启动测试环境时，可以通过args参数设置测试环境专用的传入属性

/**
     * @author .29.
     * @create 2023-04-01 20:28
     */
    
    //args属性，可以为当前测试用例添加临时的命令行参数
    @SpringBootTest(args = {
        "--test.prop=testValueByArgs"})
    public class PropertiesAndArgsTest {
        
    
        @Value("${test.prop}")
        private String msg;
    
        @Test
        public void testProperties(){
        
            System.out.println(msg);
        }
    }

> ![在这里插入图片描述][f13a2a3ce981433a81a278a0b3279a5e.png_pic_center]

*  对应的application.yml配置文件内容：

test:
      prop:

## 二、SpringBoot加载测试专用配置 ##

加载测试范围配置，应用于小范围测试环境

*  专用的配置：

/**
     * @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);
        }
    }

> 成功加载到专用配置中的内容：
> 
> ![在这里插入图片描述][f75fbbfdf6de43d8a915345a22f1b776.png_pic_center]

## 三、SpringBoot 模拟测试Web环境 ##

Web环境模拟测试

1.  设置测试端口
2.  模拟测试启动
3.  模拟测试匹配（各组成部分消息均可匹配）

### 1.启动Web环境的不同方式 ###

--------------------

*  @SpringBootTest注解的`webEnvironment属性` 提供了启动Web环境的选择：

> ![在这里插入图片描述][c33c07a6c7ce4b71b3ca4af174016dee.png_pic_center]

*  **默认** webEnvironment = `SpringBootTest.WebEnvironment.NONE`：不启动Web服务器

*  webEnvironment = `SpringBootTest.WebEnvironment.DEFINED_PORT`：使用**默认端口**在测试类启动Web服务器

/**
     * @author .29.
     * @create 2023-04-01 21:39
     */
    //webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT：默认端口在测试类启动Web服务器
    @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
    public class WebTest {
        
        @Test
        public void test(){
        
    
        }
    }

> ![在这里插入图片描述][19886bc536574ac08c83862cafefe664.png_pic_center]

*  webEnvironment = `SpringBootTest.WebEnvironment.RANDOM_PORT`：使用**随机端口**在测试类启动Web服务器

/**
     * @author .29.
     * @create 2023-04-01 21:39
     */
    
    //webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT： 随机端口 在测试类启动Web服务器
    @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
    public class WebTest {
        
        @Test
        public void test(){
        
    
        }
    }

> ![在这里插入图片描述][b3cb6fc7e1f24aae99b5eed5b07fa7d2.png_pic_center]

### 2.发起虚拟请求 ###

--------------------

*  控制层组件：

/**
     * @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";
        }
    }

*  发起MVC虚拟调用，模拟发起请求

/**
     * @author .29.
     * @create 2023-04-01 21:39
     */
    
    @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
    //@AutoConfigureMockMvc注解：开启MVC虚拟调用
    @AutoConfigureMockMvc
    public class WebTest {
        
        @Test  //@Autowired注解，注入虚拟MVC调用对象
        public void testWeb(@Autowired MockMvc mockMvc) throws Exception {
        
            //创建虚拟请求，当前访问/books
            MockHttpServletRequestBuilder builder = MockMvcRequestBuilders.get("/books");
            //执行对应的请求
            mockMvc.perform(builder);
        }
    }

> 成功发起虚拟请求  
> ![在这里插入图片描述][7fd800c0547a481cbc4dc854ee79fbe7.png_pic_center]

### 3.匹配响应的执行状态 ###

--------------------

*  虚拟请求状态匹配：

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
    //开启MVC虚拟调用
    @AutoConfigureMockMvc
    public class WebTest {
        
        @Test
        public void testStatus(@Autowired MockMvc mockMvc) throws Exception {
        
            //创建虚拟请求，当前访问/books (这里故意写错，模拟匹配失败)
            MockHttpServletRequestBuilder builder = MockMvcRequestBuilders.get("/books1");
            //执行对应的请求
            ResultActions actions = mockMvc.perform(builder);
    
            //设定预期值 与真实值进行比较，成功测试通过，失败测试失败
            //定义本次调用的预期值
            StatusResultMatchers status = MockMvcResultMatchers.status();
            //预计本次调用是成功的：状态200
            ResultMatcher ok = status.isOk();
            //添加预期值到本次调用过程中，与真实执行结果进行匹配
            actions.andExpect(ok);
        }
    }

> 匹配失败时，输出匹配错误原因：
> 
> ![在这里插入图片描述][80dba971a2ed4927ac910282028feac0.png_pic_center]

### 4.匹配响应体 ###

--------------------

/**
     * @author .29.
     * @create 2023-04-01 21:39
     */
    
    @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
    //开启MVC虚拟调用
    @AutoConfigureMockMvc
    public class WebTest {
        
        
        @Test
        public void testBody(@Autowired MockMvc mockMvc) throws Exception {
        
            MockHttpServletRequestBuilder builder = MockMvcRequestBuilders.get("/books");
            ResultActions actions = mockMvc.perform(builder);
    
            //设定预期值 与真实值进行比较，成功测试通过，失败测试失败
            //定义本次调用的预期值
            ContentResultMatchers content = MockMvcResultMatchers.content();
            //预计请求体为控制层组件的返回值"Springboot 测试类启动web环境 发送虚拟请求"
            //如果请求体反馈JSON数据，string()改为json()
            ResultMatcher body = content.string("Springboot");
            //添加预期值到本次调用过程中，与真实执行结果进行匹配
            actions.andExpect(body);
        }
        
    }

### 5.匹配响应头 ###

--------------------

@Test
        public void testHeader(@Autowired MockMvc mockMvc) throws Exception {
        
            MockHttpServletRequestBuilder builder = MockMvcRequestBuilders.get("/books");
            ResultActions actions = mockMvc.perform(builder);
    
            //设定预期值 与真实值进行比较，成功测试通过，失败测试失败
            //定义本次调用的预期值
            HeaderResultMatchers header = MockMvcResultMatchers.header();
            //预计请求头的Content-Type 为 text/plain;charset=UTF-8
            ResultMatcher string = header.string("Content-Type", "text/plain;charset=UTF-8");
            //添加预期值到本次调用过程中，与真实执行结果进行匹配
            actions.andExpect(string);
        }
    }

--------------------

[![在这里插入图片描述][20a7f1b58dfb4660b75d7f021c157d57.png_pic_center]][20a7f1b58dfb4660b75d7f021c157d57.png_pic_center 1]

[8d8e0d8a542946af858489a536162608.gif_pic_center]: https://img-blog.csdnimg.cn/8d8e0d8a542946af858489a536162608.gif#pic_center
[.29.]: https://blog.csdn.net/ebb29bbe?spm=1018.2226.3001.5343
[Link 1]: https://bbs.csdn.net/forums/185241f773fb401b8ca7994dc3d02333?joinKey=cyru4ex9o7wq-mz6v1koj5x-1-add3ae8dc3827dbbd4360c79af92bbbe
[e66b8188276943119fee04d04f6287f5.png_pic_center]: https://img-blog.csdnimg.cn/e66b8188276943119fee04d04f6287f5.png#pic_center
[681fc345d6c549418a424295fbde8db3.png_pic_center]: https://img-blog.csdnimg.cn/681fc345d6c549418a424295fbde8db3.png#pic_center
[f13a2a3ce981433a81a278a0b3279a5e.png_pic_center]: https://img-blog.csdnimg.cn/f13a2a3ce981433a81a278a0b3279a5e.png#pic_center
[f75fbbfdf6de43d8a915345a22f1b776.png_pic_center]: https://img-blog.csdnimg.cn/f75fbbfdf6de43d8a915345a22f1b776.png#pic_center
[c33c07a6c7ce4b71b3ca4af174016dee.png_pic_center]: https://img-blog.csdnimg.cn/c33c07a6c7ce4b71b3ca4af174016dee.png#pic_center
[19886bc536574ac08c83862cafefe664.png_pic_center]: https://img-blog.csdnimg.cn/19886bc536574ac08c83862cafefe664.png#pic_center
[b3cb6fc7e1f24aae99b5eed5b07fa7d2.png_pic_center]: https://img-blog.csdnimg.cn/b3cb6fc7e1f24aae99b5eed5b07fa7d2.png#pic_center
[7fd800c0547a481cbc4dc854ee79fbe7.png_pic_center]: https://img-blog.csdnimg.cn/7fd800c0547a481cbc4dc854ee79fbe7.png#pic_center
[80dba971a2ed4927ac910282028feac0.png_pic_center]: https://img-blog.csdnimg.cn/80dba971a2ed4927ac910282028feac0.png#pic_center
[20a7f1b58dfb4660b75d7f021c157d57.png_pic_center]: https://img-blog.csdnimg.cn/20a7f1b58dfb4660b75d7f021c157d57.png#pic_center
[20a7f1b58dfb4660b75d7f021c157d57.png_pic_center 1]: https://blog.csdn.net/ebb29bbe?type=blog