单元测试的方法有很多种,比如使用Postman、SoapUI等工具测试,当然,这里的测试,主要使用的是基于RESTful风格的SpringMVC的测试,我们可以测试完整的Spring MVC流程,即从URL请求到控制器处理,再到视图渲染都可以测试。下面我主要总结下Spring Boot基于Mock的方式对控制层Controller和服务层Serivce的单元测试。尽管这种的文章已经有很多,我的总结只是作为自己学习的一个承载,总结有误的地方欢迎小伙伴们指正,同时也希望能帮助跟我一样还在学习的小伙伴们。

在介绍Mock API测试方法之前先介绍下Spring MVC测试框架提供的两种方式:

独立安装测试集成Web环境测试(此种方式并不会集成真正的web环境,而是通过相应的Mock API进行模拟测试,无须启动服务器)。

MockMvcBuilder介绍:

是用来构造MockMvc的构造器,其主要有两个实现:StandaloneMockMvcBuilder和DefaultMockMvcBuilder,StandaloneMockMvcBuilder继承了DefaultMockMvcBuilder。直接使用静态工厂MockMvcBuilders创建即可:

1. 集成Web环境测试:

    MockMvcBuilders.webAppContextSetup(WebApplicationContext context):指定WebApplicationContext,将会从该上下文获取相应的控制器并得到相应的MockMvc;

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes=MockServletContext.class)
@WebAppConfiguration
public class StudentControllerTest {
    
    @Autowired
    private WebApplicationContext wac;
    
    private MockMvc mockMvc;

    @Before
    public void setup() {
        this.mockMvc = MockMvcBuilders.webAppContextSetup(this.wac).build(); // 构造MockMvc
    }
    // ...
}

注意:

(1)@WebAppConfiguration:测试环境使用,用来表示测试环境使用的ApplicationContext将是WebApplicationContext类型的;value指定web应用的根;
(2)通过@Autowired WebApplicationContext wac:注入web环境的ApplicationContext容器;
(3)然后通过MockMvcBuilders.webAppContextSetup(wac).build()创建一个MockMvc进行测试;

2.独立测试方式

  MockMvcBuilders.standaloneSetup(Object... controllers):通过参数指定一组控制器,这样就不需要从上下文获取了;

 (SpringMVC测试需要添加:mockito-core和mockito-all依赖)

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration({"classpath*:/spring-context.xml"})
public class DemoTest {

    @Mock
    private StudentService studentService;
    
    @InjectMocks
    private StudentController studentController;
    
    private MockMvc mockMvc;
    
    @Before
    public void setup() {
        MockitoAnnotations.initMocks(this);
        this.mockMvc = MockMvcBuilders.standaloneSetup(bookController).build();
    }
    
    @Test
    public void testXX() throws Exception {
        //...
    }
}

主要是两个步骤:
(1)首先自己创建相应的控制器,注入相应的依赖
(2)通过MockMvcBuilders.standaloneSetup模拟一个Mvc测试环境,通过build得到一个MockMvc。

perform:执行一个RequestBuilder请求,会自动执行SpringMVC的流程并映射到相应的控制器执行处理;
andExpect:添加ResultMatcher验证规则,验证控制器执行完成后结果是否正确;
andDo:添加ResultHandler结果处理器,比如调试时打印结果到控制台;
andReturn:最后返回相应的MvcResult;然后进行自定义验证/进行下一步的异步处理;

MockMvcRequestBuilders主要API:

MockHttpServletRequestBuilder get(String urlTemplate, Object... urlVariables):根据uri模板和uri变量值得到一个GET请求方式的MockHttpServletRequestBuilder;如get("/user/{id}", 1L);

MockHttpServletRequestBuilder post(String urlTemplate, Object... urlVariables):同get类似,但是是POST方法;

MockHttpServletRequestBuilder put(String urlTemplate, Object... urlVariables):同get类似,但是是PUT方法;

MockHttpServletRequestBuilder delete(String urlTemplate, Object... urlVariables) :同get类似,但是是DELETE方法;

MockHttpServletRequestBuilder options(String urlTemplate, Object... urlVariables):同get类似,但是是OPTIONS方法;

Mock测试过程:

1、mockMvc.perform执行一个请求(MockMvcRequestBuilders.get("/user/1")构造一个请求).
2、设置参数(这一步其实可以设置很多参数,MockMvc提供了丰富的方法)
3、mockMvc调用perform,调用controller的业务处理逻辑
4、perform返回ResultActions,返回操作结果,通过ResultActions,提供了统一的验证方式。(

        ResultActions.andExpect添加执行完成后的断言,

       ResultActions.andDo添加一个结果处理器,表示要对结果做点什么事情,比如此处使用MockMvcResultHandlers.print()输出整个响应结果信息。

       ResultActions.andReturn表示执行完成后返回相应的结果。

测试说明:

1. 依赖包导入:pom.xml中仅依赖spring-boot-starter-test,它把会把测试相关的依赖全部引入。

2. 在测试类上的注解,常用的注解有三个:

 @RunWith(SpringJUnit4ClassRunner.class)//引用Spring-Test测试框架支持
 @SpringApplicationConfiguration(classes = StartApp.class) // StartApp :可以是Spring Boot的启动类,也可以使用MockServletContext来构建一个空的WebApplicationContext,这样我们创建的StudentController就可以在@Before函数中创建并传递到MockMvcBuilders.standaloneSetup()函数中。
 @WebAppConfiguration //用来表示测试环境使用的ApplicationContext将是WebApplicationContext类型的

3. 测试类的文件结构,保持src/test/java和src/main/java结构一致,即:包+文件夹。测试配置文件任然用src/main/resources的。

根据如上介绍看下如下案例:

定义Student实体类:

public class Student implements Serializable{

    /**
     * 
     */
    private static final long serialVersionUID = -9143765513634702342L;

    private Long id;
    
    private String name;
    
    private String age;
    
    private String address;

    public String getName() {
        return name;
    }
//省略get/set方法...
}
View Code

相关文章: