SpringBoot MockMvc单元测试入门

1. 介绍

1.1 为什么需要测试

测试是软件开发不可或缺的一部分。 在实际应用程序中,服务通常依赖于访问外部系统,因此提供适当的隔离测试非常重要,这样我们就可以专注于测试给定单元的功能,而无需涉及整个类层次结构。

1.2 Spring解决方案

Spring提供了spring-test包用于测试,在Spring Boot中通过引入spring-boot-starter-test依赖以启用。Spring提供了三种测试方案来针对不同场景下的测试。

1.2.1 MockMvc

针对Controller的接口测试,我们可以使用MockMvc进行,本节也将介绍此种框架的使用。

1.2.2 HtmlUnit

HtmlUnit与MockMvc结合,实现了Html页面中表单的测试。可以通过获取某个网页的内容,操作其中的元素,模拟事件。实现针对网页的测试。

1.2.3 RestTemplate

适用于完全模拟客户端的请求测试,无须关心服务器端的运行(即服务器端在其他服务器已经运行,本地无须启动)。此种方式一般不适用于后端开发人员的单元测试(因为后端开发的单元测试其实是在开发过程中的,必然需要在本地运行服务端)。

2. MockMvc的使用

2.1 基本组成与流程

MockMvc的几个重要组件如下:

2.1.1 MockHttpServletRequestBuilder

创建请求,可以设置参数、头信息、编码、Cookies等基本http请求所含的所有信息。

2.1.2 MockMvc

客户端,主要入口,执行请求。

2.1.3 ResultActions

结果与动作,MockMvc将MockHttpServletRequestBuilder构造的请求发出后,返回的结果。并且可以在此基础上,针对结果添加一些动作。包含:

  1. andExpect:预期结果是否与真实结果一致
  2. andDo:针对结果执行脚本,常用的为print(),打印结果
  3. andReturn:获取结果
    其中andExpect与andDo返回的类型扔为ResultActions,故可以使用链式的方式添加多个动作。

2.1.4 基本流程图

基本流程

2.2 SpringBoot中的MockMvc使用

SpringBoot中的MockMvc使用相对简单

2.2.1 编写Controller接口

@RestController
@RequestMapping("/demo")
public class DemoController {

    @PostMapping("testPost")
    public String testPost(@RequestBody String request) {
        System.out.println(request);
        return "{\"code\":\"0000\"}";
    }

    @GetMapping("/testGet/{id}")
    public String testGet(@PathVariable String id, @RequestParam("name") String name) {
        System.out.println(id);
        System.out.println(name);
        return "{\"code\":\"0000\"}";
    }
}

2.2.2 创建BaseTest

为了简化代码,我们创建一个BaseTest来封装基础的测试流程。

@RunWith(SpringJUnit4ClassRunner.class)
public abstract class BaseTest {
    @Autowired
    protected WebApplicationContext wac;
    protected MockMvc mockMvc;
    @Before
    public void setup() {
        this.mockMvc = MockMvcBuilders.webAppContextSetup(wac).build();
    }
    public ResultActions buildRequest(Supplier<MockHttpServletRequestBuilder> method) throws Exception {
        String header = getBaseHeader();
        header = header == null ? "" : header;
        return this.mockMvc.perform(method.get().characterEncoding(StandardCharsets.UTF_8.name())
                .contentType(MediaType.APPLICATION_JSON)
                .header(HttpHeaders.AUTHORIZATION, header)).andDo(print()).andExpect(status().is2xxSuccessful());
    }
    public abstract String getBaseHeader();
}

2.2.3 单元测试示例

 @SpringBootTest(classes = TestApplication.class)
public class ApiTest extends BaseTest {
    @Override
    public String getBaseHeader() {
        return null;
    }

    /**
     * get请求测试
     */
    @Test
    public void testGet() throws Exception {
        MockHttpServletRequestBuilder mockHttpServletRequestBuilder = MockMvcRequestBuilders
                .get("/demo/testGet/{id}", 1111);
        mockHttpServletRequestBuilder.param("name", "张三");
        super.buildRequest(() -> mockHttpServletRequestBuilder)
                .andExpect(jsonPath("$.code", is("0000")));
    }

    /**
     * post请求测试
     */
    @Test
    public void testPost() throws Exception {
        MockHttpServletRequestBuilder mockHttpServletRequestBuilder = MockMvcRequestBuilders
                .post("/demo/testPost");
        Map<String,Object> requestMap = new HashMap<>();
        requestMap.put("name","张三");
        mockHttpServletRequestBuilder.content(JSON.toJSONString(requestMap));
        super.buildRequest(() -> mockHttpServletRequestBuilder)
                .andExpect(jsonPath("$.code", is("0000")));
    }
}

2.2.4 JsonPath

JsonPath是一个用于读取JSON文档的Java DSL。,
MockMvc引入它用于andExpect中来读取、比对json结果。通过表达式读取文档,并传入比对的方法以此进行判断。
写法可以是

$.store.book[0].title

$['store']['book'][0]['title']

JsonPath的表达式的语法类似于jquery:

操作符 描述
$ 要查询的根元素。所有表达式开始元素。
@ 根据过滤表达式查询节点
* 通配符。可在任何名称或数字需要的地方使用。
.. 深层扫描。可在任何需要名称的地方使用。
.<name> 获取节点
['<name>' (, '<name>')] 根据名称获取子节点$['store']['book']
[<number> (, <number>)] 根据索引获取子节点$['store'][0]
[start:end] 获取从start到end的节点列表
[?(<expression>)] 过滤表达式。表达式必须求值为布尔值。

JsonPath地址了解更多

快速开发框架
高质量图片压缩工具

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,298评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,701评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,078评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,687评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,018评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,410评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,729评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,412评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,124评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,268评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,894评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2 260

推荐阅读更多精彩内容