微服务单元测试 Mock使用与详解

·  阅读 5195

最近在搞微服务的项目,搞完后发现内部需要调用别的服务的接口,可是另一个服务还没有写完我还调不通,哪这就非常尴尬了。这种情况下要怎么测试呢?这时就需要引入Mock的概念。

1 什么是Mock

mock是在测试过程中,对于一些不容易构造/获取的对象,创建一个mock对象来模拟对象的行为。比如说你需要调用B服务,可是B服务还没有开发完成,那么你就可以将调用B服务的那部分给Mock掉,并编写你想要的返回结果。

2 Spring Boot的测试类库

现在绝大多数的java服务都是Spring框架搭建的,并且也会使用到Spring boot来进行快速搭建开发,在Spring Boot提供了许多实用工具和注解来帮助测试应用程序,主要包括以下两个模块:

  • spring-boot-test:支持测试的核心内容。
  • spring-boot-test-autoconfigure:支持测试的自动化配置。

开发进行只要使用 spring-boot-starter-test 启动器就能引入这些 Spring Boot 测试模块,还能引入一些像 JUnit, AssertJ, Hamcrest 及其他一些有用的类库,具体如下所示:

  • JUnit:Java 应用程序单元测试标准类库。
  • Spring Test & Spring Boot Test:Spring Boot 应用程序功能集成化测试支持。
  • AssertJ:一个轻量级的断言类库。
  • Mockito:一个Java Mock测试框架,默认支付 1.x,可以修改为 2.x。
  • JsonPath:一个JSON操作类库。

3 编写测试用例

1 引入pom依赖

再IDEA中创建一个普通的maven项目即可,然后导入pom依赖:

<parent>
        <groupId> org.springframework.boot </groupId>
        <artifactId> spring-boot-starter-parent </artifactId>
        <version>2.1.7.RELEASE </version>
    </parent>

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

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.20</version>
        </dependency>
    </dependencies>
复制代码

3.2 MockMVC基于RESTful风格的测试

对于前后端分离的项目而言,无法直接从前端静态代码中测试接口的正确性,因此可以通过MockMVC来模拟HTTP请求。基于RESTful风格的SpringMVC的测试,我们可以测试完整的Spring MVC流程,即从URL请求到控制器处理,再到视图渲染都可以测试。

首先创建一个超简单的controller

@RestController
@RequestMapping(value = "/web")
public class WebController {

    @PostMapping(value = "/create")
    public WebResponse<String> ping(@RequestBody WebRequest webRequest){
        System.out.println(webRequest);
        WebResponse<String> response = new WebResponse<>();
        response.setBody("create 完成---");
        response.setCode("00000");
        response.setMessage("成功");
        return response;
    }
}
复制代码

request和response

@Data
@ToString
@EqualsAndHashCode
public class WebRequest {
    private String name;
    
    private String mobile;
}
复制代码
@Data
@ToString
@EqualsAndHashCode
public class WebResponse<T> {
    private String code;

    private String message;

    private T body;
}
复制代码

然后创建一个测试用例类

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

    @Autowired
    private WebApplicationContext mac;

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void ping() throws Exception {
        //请求的json
        String json = "{\"name\":\"王五\",\"mobile\":\"12345678901\"}";

        //perform,执行一个RequestBuilders请求,会自动执行SpringMVC的流程并映射到相应的控制器执行处理
        mockMvc.perform(MockMvcRequestBuilders
                //构造一个post请求
                .post("/web/create")
                //json类型
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                //使用writeValueAsString()方法来获取对象的JSON字符串表示
                .content(json))
                //andExpect,添加ResultMathcers验证规则,验证控制器执行完成后结果是否正确,【这是一个断言】
                .andExpect(MockMvcResultMatchers.status().is(200))
                .andExpect(MockMvcResultMatchers.status().isOk())
                //使用jsonPaht验证返回的json中code字段的返回值
                .andExpect(MockMvcResultMatchers.jsonPath("$.code").value("00000"))
                .andExpect(MockMvcResultMatchers.jsonPath("$.message").value("成功"))
                //body属性不为空
                .andExpect(MockMvcResultMatchers.jsonPath("$.body").isNotEmpty())
                //添加ResultHandler结果处理器,比如调试时 打印结果(print方法)到控制台
                .andDo(MockMvcResultHandlers.print())
                //返回相应的MvcResult
                .andReturn();
    }

}
复制代码

其中MockMvcRequestBuilders 写好后直接运行就可以了,从控制台就可以看到详细信息。

4 Mockito

4.1 Mockito是什么

Mockito是mocking框架,它让你用简洁的API做测试。而且Mockito简单易学,它可读性强和验证语法简洁。 Mockito是GitHub上使用最广泛的Mock框架,并与JUnit结合使用.Mockito框架可以创建和配置mock对象.使用Mockito简化了具有外部依赖的类的测试开发!

4.2 使用Mockito

加入一个service

public interface WebService {

    String web(String string);
}
复制代码
@Service
public class WebServiceImpl implements WebService {

    @Override
    public String web(String string) {
        return "WebServiceImpl 运行成功";
    }
}
复制代码

修改controller

@RestController
@RequestMapping(value = "/web")
public class WebController {

    @Autowired
    private WebService webService;

    @PostMapping(value = "/create")
    public WebResponse<String> ping(@RequestBody WebRequest webRequest){

        //调用service
        String str = webService.web(webRequest.getMobile());

        WebResponse<String> response = new WebResponse<>();
        response.setBody(str);
        response.setCode("00000");
        response.setMessage("成功");
        return response;
    }
}
复制代码

修改测试用例

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

    @Autowired
    private WebApplicationContext mac;

    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private WebService webService;

    @Test
    public void ping() throws Exception {

        doReturn("Mockito WebServiceImpl 运行完成").when(webService).web(anyString());

        //请求的json
        String json = "{\"name\":\"王五\",\"mobile\":\"12345678901\"}";

        //perform,执行一个RequestBuilders请求,会自动执行SpringMVC的流程并映射到相应的控制器执行处理
        mockMvc.perform(MockMvcRequestBuilders
                //构造一个post请求
                .post("/web/create")
                //json类型
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                //使用writeValueAsString()方法来获取对象的JSON字符串表示
                .content(json))
                //andExpect,添加ResultMathcers验证规则,验证控制器执行完成后结果是否正确,【这是一个断言】
                .andExpect(MockMvcResultMatchers.status().is(200))
                .andExpect(MockMvcResultMatchers.status().isOk())
                //使用jsonPaht验证返回的json中code字段的返回值
                .andExpect(MockMvcResultMatchers.jsonPath("$.code").value("00000"))
                .andExpect(MockMvcResultMatchers.jsonPath("$.message").value("成功"))
                //body属性不为空
                .andExpect(MockMvcResultMatchers.jsonPath("$.body").isNotEmpty())
                //添加ResultHandler结果处理器,比如调试时 打印结果(print方法)到控制台
                .andDo(MockMvcResultHandlers.print())
                //返回相应的MvcResult
                .andReturn();
    }

}
复制代码

输出结果:

从上面的代码可以看到,我们新增了一个webService,并增加了@MockBean注解,表示将webService给mock调,这样我们就可以增加自己想要得webService返回结果。 在测试用例中我们增加了doReturn()方法,这段代码的含义是当调用WebService中的web()方法时(anyString()表示传入web()方法中的参数是任意的String类型,当然还有个anyInt()等方法),返回Mockito WebServiceImpl 运行完成。当然你也可以不将WebService给mock掉,这样拿到的就是正常的返回值。

分类:
后端
标签:
收藏成功!
已添加到「」, 点击更改