Spring Boot 编写Test测试用例的几种方式

本文主要介绍了 springboot 中测试的相关概念，测试的几种方式，包括 mock 测试、单元测试、基于容器的测试等。

Mock方式的测试

比如测试dao 接口：

@RunWith(SpringRunner.class)
public class UserDaoTest {

    //使用MockBean是因为此时容器中没有UserMapper这个对象
    @MockBean
    public UserDao userDao;

    //使用BDDMockito对行为进行预测，
    @Before
    public void init(){
        BDDMockito.given(userDao.createUser("test")).willReturn(1);
        BDDMockito.given(userDao.createUser("")).willReturn(0);
        BDDMockito.given(userDao.createUser(null)).willThrow(NullPointerException.class);
    }

    @Test(expected=NullPointerException.class)
    public void testCreateUser() {
        Assert.assertEquals(Integer.valueOf(1),userDao.createUser("test")) ;
        Assert.assertEquals(Integer.valueOf(0),userDao.createUser("")) ;
        Assert.assertEquals(Integer.valueOf(1),userDao.createUser(null)) ;
    }
}

基于spring容器的单元测试

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceTest {

    @Autowired
    private UserService userService;

    @Test
    public void addUser() throws Exception {
        Assert.assertEquals(Integer.valueOf(1),userService.addUser("test"));
        Assert.assertEquals(Integer.valueOf(0),userService.addUser(null));
    }
}

controller测试

第一种：使用测试类测试

@RunWith(SpringRunner.class)
//指定web环境，随机端口
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class UserControllerTest {
    @Autowired
    private TestRestTemplate testRestTemplate;

    @Test
    public void testHome(){
        String context = testRestTemplate.getForObject("/user/info",String.class);
        Assert.assertEquals("ok",context);
    }
}

第二种：使用@WebMvcTest注解

@WebMvcTest(controllers = UserController.class)
public class UserControllerTest2 {

    @Autowired
    public MockMvc mockMvc;

    @Test
    public void testHome() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.get("/user/info")).andExpect(MockMvcResultMatchers.status().isOk());
        mockMvc.perform(MockMvcRequestBuilders.get("/user/info")).andExpect(MockMvcResultMatchers.status().isOk()).andExpect(MockMvcResultMatchers.content().string("user home"));
    }
}

@WebMvcTest 不能与@SpringBootTest同时使用，不会加载整个spring容器，也不需要运行在web环境下。但是，需要指定controllers，表示需要测试哪些controllers，controller里面的依赖，需要自己去mock

第三种：使用@SpringBootTest()与@AutoConfigureMockMvc结合

@SpringBootTest使用@SpringBootTest加载测试的spring上下文环境，@AutoConfigureMockMvc自动配置MockMvc这个类

@RunWith(SpringRunner.class)
@SpringBootTest()
@AutoConfigureMockMvc
public class UserControllerTest3 {

    @Autowired
    private MockMvc mvc;

    @Test
    public void testHome() throws Exception {
        mvc.perform(MockMvcRequestBuilders.get("/user/info")).andExpect(MockMvcResultMatchers.status().isOk());
        mvc.perform(MockMvcRequestBuilders.get("/user/info")).andExpect(MockMvcResultMatchers.status().isOk()).andExpect(MockMvcResultMatchers.content().string("user home"));
    }
}

使用到相关注解概念

@RunWith：When a class is annotated with @RunWith or extends a class annotated with @RunWith, JUnit will invoke the class it references to run the tests in that class instead of the runner built into JUnit.
@SpringJUnit4ClassRunner：是JUnit's的BlockJUnit4ClassRunner类的一个常规扩展，提供了一些spring测试环境上下文去规范JUnit测试，意味着TestContextManager和支持相关的类和注解。
@SpringRunner：是SpringJUnit4ClassRunner的一个别名
@SpringBootTest：提供一个 spring 的测试环境。
其会自动检索程序的配置文件，检索顺序是从当前包开始，逐级向上查找被@SpringBootApplication或@SpringBootConfiguration注解的类，加载ApplicationContext，启动spring容器。
可以设置端口等 webEnvironment = SpringBootTest.WebEnvironment.NONE，NONE为非 web 环境，还有RANDOM_PORT、DEFINED_PORT。
@DirtiesContext：the application context cached should be removed and reloaded after each test run。application context在test class执行以后会被删除，这样可以保证每个test class的执行上下文的独立性、隔离性，但是会影响测试的效率。分为method-level和class-level。

测试环境配置文件的读取

springboot会只会读取到src/test/resources下的配置，不会读到正式环境下的配置文件
通过SpringBootTest注解可以注入属性：properties = {"app.version=1.0"}

@RunWith(SpringRunner.class)
@SpringBootTest(properties = {"hystrix.timeout=1000"})
public class EnvTest2 {

    @Autowired
    private ConfigurableEnvironment environment;

    @Before
    public void init(){
                            EnvironmentTestUtils.addEnvironment(environment,"user.name=test");
    }
}

只在测试环境有效的bean
使用@TestComponent和@TestConfiguration二个注解修饰，这些类只在测试环境生效

总结

通过springboot 提供的注解来编写测试用例非常方便，可以分别对dao、service、controller 测试，对业务逻辑使用 mock 依赖测试。