Springboot @Test 给Controller接口写单元测试

小咪咪 2023-09-24 19:31 45阅读 0赞

# 前言 #

最近有小伙伴问到怎么给 controller的接口写单元测试。

![97376e7ce5624b4c99e85821d0c2fa72.png][]

单元测试是开发必不可少的一个环节。

既然有人问到了，那我觉得可能不止一个人不会，那就按照惯例，出手。

# 正文 #

##    内容： ##

> 主要是get 和 post 两种请求方式的接口 的 单元测试写法。
> 
> get方式请求 介绍 3种传参：
> 
>   
> ①@PathVariable  
> ②@RequestParam("id")  
> ③类传参 如 User user
> 
> post方式请求 介绍 1种传参：  
> @RequestBody
> 
> @RequestHeader请求头参数添加参数

上代码 ：

先看GET方式请求，简单写三个示例接口

@GetMapping("/getId/{id}")
        public String pathVariableTest(@PathVariable Integer id) {
            return  "id:   "+id;
        }
    
        @GetMapping("/getId")
        public String requestParamTest( @RequestParam("id") Integer id) {
            return  "id:   "+id;
        }
    
        @GetMapping("/getUser")
        public String requestParamObjectTest( User user) {
            return  user.toString();
        }

然后我们来针对这三个get请求接口写单元测试

pom.xml 加入测试使用的jar依赖

>     <dependency>
>         <groupId>junit</groupId>
>         <artifactId>junit</artifactId>
>         <scope>test</scope>
>     </dependency>
>     
>     <dependency>
>         <groupId>org.springframework.boot</groupId>
>         <artifactId>spring-boot-starter-test</artifactId>
>         <scope>test</scope>
>     </dependency>

创建一个单元测试类 MyControllerTest.java

![e49cf313de144036a26028f39ea1a0d0.png][]

代码：

import org.junit.runner.RunWith;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    import org.springframework.test.context.web.WebAppConfiguration;
    
    
    @RunWith(SpringRunner.class)
    @SpringBootTest
    @WebAppConfiguration
    public class MyControllerTest {
    
        protected Logger logger = LoggerFactory.getLogger(MyControllerTest.class);
    }

写下来开始写 针对controller 的 单元测试代码：  
  
![83e098faf3d24a6c87538ac538d70c2b.png][]

代码：

@Autowired
        DoTestController doTestController;
    
        private MockMvc mockMvc;
    
        @Before
        public void setup() {
            mockMvc = MockMvcBuilders.standaloneSetup(doTestController).build();
        }

首先针对这种场景的GET请求，传入参数的，我们怎么写单测？  
  
 **@RequestParam("id")**  
  
![c86e9778c9d248f98b8f595e18cb722a.png][]

![5eeccbc1ec6e42f68f8ae3a2223011ea.png][]

代码：

@Test
        public void getTest() throws Exception {
            MvcResult mvcResult = mockMvc.perform(
                    MockMvcRequestBuilders.get("/getId")
                            .param("id", "123")
            )
                    .andExpect(MockMvcResultMatchers.status().isOk())
                    .andDo(MockMvcResultHandlers.print())
                    .andReturn();
            logger.info("调用返回的结果：{}", mvcResult.getResponse().getContentAsString());
        }

ps： 多个 @RequestParam 就同样 一直 .param即可

示例：

![38fa345f9f7040ec89070cb91cf402d5.png][]

当然也可以通过map传值，传多个：  
![0d4c899687914ece9cdb7b33785033fc.png][]

跑一下单测看看效果：  
![45d6b46cd168439c958361e7477eee07.png][]

然后是@PathVariable 传参方式：  
  
![ce8d172f1a9248d88f6a3326b14f47bf.png][]

单测写法：

![6a50cf8f332e44dd9fd68f70a216d6af.png][]

代码：

@Test
        public void pathVariableTest() throws Exception {
            Integer id = 888;
    
            MvcResult mvcResult = mockMvc.perform(
                    MockMvcRequestBuilders.get("/getId/" + id)
            )
                    .andExpect(MockMvcResultMatchers.status().isOk())
                    .andDo(MockMvcResultHandlers.print())
                    .andReturn();
            logger.info("调用返回的结果：{}", mvcResult.getResponse().getContentAsString());
        }

然后是传类的情景：

![6ea3c170f3ae4bff8a31c44e8749c45d.png][]

单测写法：

![6a7e5bc71659428389cf44abba4dc78a.png][]

代码：

@Test
        public void getTestObject() throws Exception {
    
            MvcResult mvcResult = mockMvc.perform(
                    MockMvcRequestBuilders.get("/getUser")
                            .param("userId", "123")
                            .param("name", "JCccc")
                            .param("age", "18")
                            .param("userCode", "100244")
                            .contentType(MediaType.APPLICATION_FORM_URLENCODED_VALUE)
            )
                    .andExpect(MockMvcResultMatchers.status().isOk())
                    .andDo(MockMvcResultHandlers.print())
                    .andReturn();
            logger.info("调用返回的结果：{}", mvcResult.getResponse().getContentAsString());
    
        }

然后看下POST 请求方式的接口 单测写法

![3fe22726320d472083f93e8a817ed9de.png][]

顺便把请求头参数方式一并写了：  
  
![824be203c6d0461a8562808305e6ff33.png][]

代码：

@Test
        public void postTest() throws Exception {
            User user = new User();
            user.setUserId(100011L);
            user.setName("JCccc");
            user.setUserCode("100244");
            user.setAge(18);
            String strJson = JSON.toJSONString(user);
            MvcResult mvcResult = mockMvc.perform(
                    MockMvcRequestBuilders.post("/getRequestBodyValue")
                            .header("token", "收藏点赞")
                            .accept(MediaType.parseMediaType("application/json;charset=UTF-8"))
                            .contentType(MediaType.APPLICATION_JSON)
                            .content(strJson)
            )
                    .andExpect(MockMvcResultMatchers.status().isOk())
                    .andDo(MockMvcResultHandlers.print())
                    .andReturn();
            logger.info("调用返回的结果：{}", mvcResult.getResponse().getContentAsString());
        }

效果：  
![3253c48591db4339a38b7e86ce3b7812.png][]

[97376e7ce5624b4c99e85821d0c2fa72.png]: https://img-blog.csdnimg.cn/97376e7ce5624b4c99e85821d0c2fa72.png
[e49cf313de144036a26028f39ea1a0d0.png]: https://img-blog.csdnimg.cn/e49cf313de144036a26028f39ea1a0d0.png
[83e098faf3d24a6c87538ac538d70c2b.png]: https://img-blog.csdnimg.cn/83e098faf3d24a6c87538ac538d70c2b.png
[c86e9778c9d248f98b8f595e18cb722a.png]: https://img-blog.csdnimg.cn/c86e9778c9d248f98b8f595e18cb722a.png
[5eeccbc1ec6e42f68f8ae3a2223011ea.png]: https://img-blog.csdnimg.cn/5eeccbc1ec6e42f68f8ae3a2223011ea.png
[38fa345f9f7040ec89070cb91cf402d5.png]: https://img-blog.csdnimg.cn/38fa345f9f7040ec89070cb91cf402d5.png
[0d4c899687914ece9cdb7b33785033fc.png]: https://img-blog.csdnimg.cn/0d4c899687914ece9cdb7b33785033fc.png
[45d6b46cd168439c958361e7477eee07.png]: https://img-blog.csdnimg.cn/45d6b46cd168439c958361e7477eee07.png
[ce8d172f1a9248d88f6a3326b14f47bf.png]: https://img-blog.csdnimg.cn/ce8d172f1a9248d88f6a3326b14f47bf.png
[6a50cf8f332e44dd9fd68f70a216d6af.png]: https://img-blog.csdnimg.cn/6a50cf8f332e44dd9fd68f70a216d6af.png
[6ea3c170f3ae4bff8a31c44e8749c45d.png]: https://img-blog.csdnimg.cn/6ea3c170f3ae4bff8a31c44e8749c45d.png
[6a7e5bc71659428389cf44abba4dc78a.png]: https://img-blog.csdnimg.cn/6a7e5bc71659428389cf44abba4dc78a.png
[3fe22726320d472083f93e8a817ed9de.png]: https://img-blog.csdnimg.cn/3fe22726320d472083f93e8a817ed9de.png
[824be203c6d0461a8562808305e6ff33.png]: https://img-blog.csdnimg.cn/824be203c6d0461a8562808305e6ff33.png
[3253c48591db4339a38b7e86ce3b7812.png]: https://img-blog.csdnimg.cn/3253c48591db4339a38b7e86ce3b7812.png