Spring Boot 集成测试

谁践踏了优雅 2022-05-31 09:00 192阅读 0赞

#### 一、测试一般程序 ####

##### 1.1 测试步骤 #####

1.   在`pom.xml` 中加入测试环境的依赖。
2.   在测试类上加入`@RunWith(SpringRunner.class)` 与`@SpringBootTest` 注解。

#### 1.2 简单测试例子 ####

在`pom.xml` 中引入相关依赖

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

要测试的程序代码

@Repository
    public class UserDao { 
        public void addUser(String username){
            if(username.equals("zhangsan")){
                System.out.println("===============");
            }else {
                System.out.println("---------------");
            }
        }
    }

测试代码

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringbootApplicationTests { 
    
        @Autowired
        private UserDao userDao;
    
        @Test
        public void testAddUser() {
            userDao.addUser("zhangsan");
        }
    
    }

测试结果  
![这里写图片描述][70]

#### 二、测试 Controller ####

##### 2.1 使用`TestRestTemplate` 对象测试 #####

测试步骤

1.   在`pom.xml` 中加入测试环境的依赖。
2.   在测试类上加入`@RunWith(SpringRunner.class)`与  
    `@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)` 注解。
3.   使用`TestRestTemplate` 完成测试

要测试的 controller

@RestController
    public class UserController{ 
    
        @GetMapping("/show/{id}")
        public String show(@PathVariable Integer id){
            return "show" + id; 
        }
    
    }

测试代码

/** TestRestTemplate 需要运行在 web 项目中 */
    @RunWith(SpringRunner.class)
    @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
    public class ControllerTest { 
    
        @Autowired
        private TestRestTemplate template;
    
        @Test
        public void testController(){
            // template.getForObject() 会得到 controller 返回的 json 值
            String content = template.getForObject("/show/100", String.class);
            // 使用断言测试，使用正确的断言
            Assert.assertEquals("show100", content);
        }
    }

正确的测试结果  
![这里写图片描述][70 1]

当断言不正确时，测试的结果  
![这里写图片描述][70 2]

#### 2.2 使用`@WebMvcTest` 注解测试 ####

测试步骤

1.   在`pom.xml` 中加入测试环境的依赖。
2.   在测试类上加入`@RunWith(SpringRunner.class)` 与`@WebMvcTest` 注解。

仍然使用`UserController` 控制器。

测试代码

/** @WebMvcTest 注解需要指定测试控制器所在的类 */
    @RunWith(SpringRunner.class)
    @WebMvcTest(UserController.class)
    public class ControllerTest2 { 
    
        @Autowired
        private MockMvc mvc;
    
        @Test
        public void testController() throws Exception {
            // 模拟请求，并期望执行成功
            mvc.perform(MockMvcRequestBuilders.get("/show/100").param("id", "100")).
                    andExpect(MockMvcResultMatchers.status().isOk());
    
            // 模拟请求，并期望执行成功，以及期望其返回的值是“show100”
            mvc.perform(MockMvcRequestBuilders.get("/show/100").param("id", "100")).
                    andExpect(MockMvcResultMatchers.content().string("show100"));
        }
    }

正确的测试结果  
![这里写图片描述][70 3]  
当期望返回的结果与请求的数据不一致时，测试的结果  
![这里写图片描述][70 4]

#### 2.3`@WebMvcTest` 与`@SpringBootTest` 注解总结 ####

`@WebMvcTest` 与`@SpringBootTest` 注解不能在一起使用。

还需要注意的地方是在使用`@WebMvcTest` 注解进行测试时，该注解不会加载在 controller 中的其他依赖。也就是说这个注解不会加载整个 Spring 容器，它只会加载在`@WebMvcTest()` 中配置的 bean。

`@SpringBootTest` 注解会加载所有被 Spring 容器管理的 bean。

`MockMvc` 对象并不常常与`@WebMvcTest()` 注解在一起使用，在你想使用`MockMvc` 对象时，又希望会加载被 Spring 容器管理的 bean，你可以这样做。

@RunWith(SpringRunner.class)
    @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
    @AutoConfigureMockMvc
    public class TestController3 { 
    
        @Autowired
        private MockMvc mockMvc;
    }

[70]: /images/20220531/ec20a6dee9c2439e8edc050bbd13b778.png
[70 1]: /images/20220531/aa7471600d144a8c8cafaec0b49b5332.png
[70 2]: /images/20220531/2eccc6ed511341489b8dc47086577343.png
[70 3]: /images/20220531/8aae590016924cc59c447737abb7796e.png
[70 4]: /images/20220531/1344bd693ff74cfaa28a5d1b6d27db6e.png