说一说在SpringBoot写单元测试遇到的坑

近期，项目需要写单元测试。我着手的项目是用SpringBoot写的。所以就简单的研究了一下如何使用。在使用中遇到不少问题，不得已换了一种方式写测试用例，写完之后总感觉不太爽。今天在Spring官网上学一个新的用法，发现这种测试方法使用后没有问题。所以来写一点笔记。

一、SpringBoot怎么写单元测试

SpringBoot提供注解的方式编写单元测试，可以使用SpringBootTest注解来标示测试类。

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootTest{
@Test
public void method(){
}
}

这样写只能解决没有一些配置文件的测试逻辑，比如没有数据库配置、数据库连接池配置等。如果有这些配置，你就需要这样写了。

@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
@Test
public void method(){
}

这样就可以正常运行了。
测试controller类。使用了Mock，网上大多流传的是下面这种方法，添加@WebAppConfiguration，使用MockMvc去进行单元测试，但是我的项目如下使用就出现了问题，执行的时候找不到Controller类，网上百度了各种方法都不管用。都会报 no bean of 'controller' type found错误。

@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
@WebAppConfiguration
 public class ControllerTest {

    private MockMvc mockMvc;

    @Autowired
    private WebApplicationContext wac;

    @Before // 在测试开始前初始化工作
    public void setup() {
        this.mockMvc = MockMvcBuilders.webAppContextSetup(this.wac).build();
    }

    @Test
    public void getMessageTest() throws Exception {

        MvcResult mvcResult = mockMvc.perform(MockMvcRequestBuilders.get("/test/getMessage"))
                .andDo(MockMvcResultHandlers.print()).andReturn();

        int status = mvcResult.getResponse().getStatus();
        String content = mvcResult.getResponse().getContentAsString();

        Assert.assertTrue("success", status == 200);
        Assert.assertFalse("failed", status != 200);

        System.out.println("content" + content);


    }

后来换了一种方式直接new个controller。测试运行后不报no bean of 'controller' type found错误了，但是在controller中使用的service报了空指针异常NPE，传递性就很明显了，controller是new的一个对象，所以注解不起作用，service就为null。
最后通过使用@AutoConfigureMockMvc+@MockBean的方式可以实现简单的单元测试，并且不会对数据产生影响，且不会对数据库产生影响。

@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
@AutoConfigureMockMvc
public class ImkfMessageReportControllerTest {
    /**
     * 初始化MockMvc
     */
    @Autowired
    private MockMvc mvc;

    /**
     * 测试的controller
     */
    @MockBean
    private UserController userController;

    @Test
    public void getUserListTest() throws Exception {
        MvcResult mvcResult = mvc.perform(MockMvcRequestBuilders.get("/user/getUserList"))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andDo(MockMvcResultHandlers.print())
                .andReturn();
        String content = mvcResult.getResponse().getContentAsString();
        System.out.println("content" + content);

    }

二、SpringBoot使用Mockito进行单元测试

上面是使用MockMvc，虽然能够验证短链接甚至service代码逻辑的正确性，能够正常测试接口的问题。但是缺点也不少，比如，覆盖率并没有提升。Mockito是一个非常好用的单元测试工具，它的实现原理是继承要Mock的类，将所有的公有方法进行重写

@RunWith(MockitoJUnitRunner.class)
public class UserServiceTest {

    @Mock
    private UserMapper userMapper;

    @InjectMocks
    private UserService userService;

    @Test
    public void saveTest() throws Exception {
        User user = new User();
        user.setUserName(Long.valueOf("springBoot"));
        when(userMapper.insert(user)).thenReturn(user);
        int num = userService.save(user);
        Assert.assertEquals("success", 1, 1);
  
    }

}

使用RunwWith(MockitoJUnitRunner.class)（也可以使用SpringBootRunner.class）来进行mocktio测试，注解@Mock标记一个类或者接口是需要被mock的，在Mock的过程中就相当于@Resource，但是注意一点是Mock是继承or实现了Mock的类，所以Mock出来的方法，全是null或者返回值为null。@InjectMocks将所有的mock对象都放入需要测试的类的对象中。在上面的saveTest方法里面调用到UserMapper.insert()，那么需要对UserMapper.insert()进行打桩，设置预期返回值。
打桩的时候需要注意：传递的参数（如果有）必须为调用时的同一个对象或者相同值，如果传入的参数是一个对象，那么需要对这个对象进行打桩，再打桩这个方法。比如，when(userMapper.insert(user)).thenReturn(rUser)，插入一个user对象，如果user插入之前要进行校验或者其他操作，需要对这个对象进行打桩（当然pojp对象可以直接new）。

如果插入的对象非常复杂，用构造方法来构造一个空对象，或者构造方法所用的对象不能直接构造，但是没有public的方法来设置值，该如何解决这个问题？我们知道一个对象的类可能有get方法（不一定是get，但是只要我们想获取这个对象中的参数，那么就有public的方法获取），我们可以通过Mock这个对象，在将要测试的方法体内，如果某行调用了这个对象的任意方法(toString()、equals()、get())，我们都可以以相同的参数（如果遇到参数未知可以用any()，一般都能知道）进行打桩后设置返回值，这样就能通过参数校验等环节，执行后面的代码逻辑，同时能够提高覆盖率，伪代码如下。

 @Mock
 private User user; 

 when(user.get(eq("userName"))).thenReturn("testAdmin");
 when(user.get(eq("seq"))).thenReturn(4);
 when(user.get(eq("password"))).thenReturn("123456");
 when(user.get(eq("u_id"))).thenReturn("654321");
     

三、通过真实测试用例测试代码

Mockito测试需要设置参数和预期返回值，在方法体中遇到的所有未知对象（除了方法体中new的对象不需要）都需要进行模拟，但是在SpringBoot代码刚刚完成的初期时，跟想模拟真实场景下进行单元测试代码问题or配置问题，那么通过自动注入的方式引入对象是一种更好的选择。

ProviderServiceImpl.java   -----服务类

import com.alibaba.dubbo.config.annotation.Service;
import com.example.demo.service.DemoService;
@Service
public class ProviderServiceImpl implements DemoService {
    @Override
    public String sayHello(String name) {

        return "hello " + name + " !";
    }
}




DemoApplicationTests.java  -----测试类

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

    @Resource
    DemoService providerService;

    @Test
    public void contextLoads() {
        String result = providerService.sayHello("Spring Boot Test");
        System.out.println("result is "+result);
       Assert.assertEquals("success","hello Spring Boot Test !" ,result);
    }

}

这里需要注意的是DemoApplicationTests 需要跟启动类main在同一级目录下，如果跟mvc在同一层可以会出现部分bean扫描不到的情况。如目录层级很深或者程序启动比较慢的话，可以去掉SpringBootTest（去掉后就不启动程序，只会运行该测试），运行一下，测试结果如下：

通过这种注解的方式，可以测试dubbo连接（Refernce注解），可以测试controller层，redis数据，mysql数据，都会真实模拟，你只需要在注入你需要测试的类，在类的入口传入测试参数，在测试过程中，最好采用debug的方式，这样你可以看到每一步的数据，也便于定位程序的问题（当然也可以出现问题时使用debug）。

本博客仅供学习参考，如有疑问，请留言。