Spring MVC 教程-接口测试利器

作者简介：大家好，我是smart哥，前中兴通讯、美团架构师，现某互联网公司CTO

联系qq：184480602，加我进群，大家一起学习，一起进步，一起对抗互联网寒冬

学习必须往深处挖，挖的越深，基础越扎实！

阶段1、深入多线程

阶段2、深入多线程设计模式

阶段3、深入juc源码解析

阶段4、深入jdk其余源码解析

阶段5、深入jvm源码解析

码哥源码部分

码哥讲源码-原理源码篇【2024年最新大厂关于线程池使用的场景题】

码哥讲源码【炸雷啦！炸雷啦！黄光头他终于跑路啦！】

码哥讲源码-【jvm课程前置知识及c/c++调试环境搭建】

​​​​​​码哥讲源码-原理源码篇【揭秘join方法的唤醒本质上决定于jvm的底层析构函数】

码哥源码-原理源码篇【Doug Lea为什么要将成员变量赋值给局部变量后再操作？】

码哥讲源码【你水不是你的错,但是你胡说八道就是你不对了！】

码哥讲源码【谁再说Spring不支持多线程事务，你给我抽他！】

终结B站没人能讲清楚红黑树的历史，不服等你来踢馆！

打脸系列【020-3小时讲解MESI协议和volatile之间的关系，那些将x86下的验证结果当作最终结果的水货们请闭嘴】

SpringMVC系列或者是SpringBoot系列中都会有大量的案例，这些案例都需要运行来验证效果，所以急需一款高效的接口测试工具。

可能大家用的比较多的是swagger或者postman，这2个确实不错，不过今天今天给大家推荐一种更简单的接口测试工具。

这款工具就是idea中的自带的： HTTP Client ，这款工具特别好用，主要的优点：

1、若想测试一个接口，只需要几行代码

2、运行特别容易

3、方便切换各种环境

1、创建一个springboot项目

idea中创建一个springboot项目，来个controller，内容如下，模拟了5种常见的情况，基本上包含了我们开发中所有的场景

    @RestController
    public class IndexController {
        //get请求
        @RequestMapping("/get")
        public String get() {
            return "get";
        }
    
        //post请求，模拟表单提交
        @PostMapping("/post")
        public Map<String, String[]> post(HttpServletRequest request) {
            return request.getParameterMap();
        }
    
        //post请求json数据
        @PostMapping("/body")
        public List<Integer> body(@RequestBody List<Integer> list) {
            return list;
        }
    
        //put请求
        @PutMapping("/put")
        public String put() {
            return "put";
        }
    
        //模拟多文件上传，顺便带上表单数据
        @PostMapping("/upload")
        public Map<String, Object> upload(@RequestParam("file1") MultipartFile file1,
                                          @RequestParam("file2") MultipartFile file2,
                                          User user,
                                          HttpServletRequest request) {
            Map<String, Object> result = new HashMap<>();
            result.put("file1.size", file1.getSize());
            result.put("file1.name", file1.getName());
            result.put("file2.originalFilename", file1.getOriginalFilename());
            result.put("file2.size", file2.getSize());
            result.put("file2.name", file2.getName());
            result.put("file2.originalFilename", file2.getOriginalFilename());
            result.put("params", request.getParameterMap());
            result.put("user", user);
            return result;
        }
    
        static class User {
            private String userName;
            private int age;
    
            public String getUserName() {
                return userName;
            }
    
            public void setUserName(String userName) {
                this.userName = userName;
            }
    
            public int getAge() {
                return age;
            }
    
            public void setAge(int age) {
                this.age = age;
            }
        }
    }

项目结构如下图

启动项目，下面我们来对这几个接口进行测试。

2、测试上面5个接口

下面我们通过HTTP Client工具来对上面几个接口进测试。

2.1、创建http后缀的文件

文件必须以http为后缀，这种文件会自动被 HTTP Client 插件识别，效果如下

2.2、将下面内容丢到创建好的文件中

    ### get 请求
    GET http://localhost:8080/get
    
    ### post 提交表单
    POST http://localhost:8080/post
    Content-Type: application/x-www-form-urlencoded
    
    name=张三&age=23
    
    ### body 中传递json数据
    POST http://localhost:8080/body
    Content-Type: application/json
    
    [3,10,40]
    
    ### put请求
    PUT http://localhost:8080/put
    
    
    ### 多文件上传文件接口测试
    POST http://localhost:8080/upload
    Content-Type: multipart/form-data; boundary=WebAppBoundary
    
    --WebAppBoundary
    Content-Disposition: form-data; name="file1"; filename="pic_1.jpeg"
    
    < C:\Users\Think\Desktop\1.jpeg
    --WebAppBoundary--
    
    --WebAppBoundary
    Content-Disposition: form-data; name="file2"; filename="pic_2.jpeg"
    
    < C:\Users\Think\Desktop\2.jpeg
    --WebAppBoundary--
    
    --WebAppBoundary--
    Content-Disposition: form-data;name=userName
    
    tom
    --WebAppBoundary--
    
    --WebAppBoundary--
    Content-Disposition: form-data;name=age
    
    23
    --WebAppBoundary--
    ###

接口格式很简单，如下

    请求方式 地址
    header部分，key=value格式，每个一行
    
    参数部分(注意这个上面要有个空行)

此时文件的效果是下面这样，点击红框中的按钮，即可以运行这个测试用例

2.3、运行接口

3、http文件内容如何写？

HTTP Client 提供了很多案例，点击 Examples 案例可以看到各种请求案例，这里就不细说了，大家一看就懂。

4、文件上传的写法

多文件上传且携带表单数据，这个比较特别，下面是接口代码

    //模拟多文件上传，顺便带上表单数据
    @PostMapping("/upload")
    public Map<String, Object> upload(@RequestParam("file1") MultipartFile file1,
                                      @RequestParam("file2") MultipartFile file2,
                                      User user,
                                      HttpServletRequest request) {
    }

对应的 HTTP Client 的写法如下：

    ### 多文件上传文件接口测试
    POST http://localhost:8080/upload
    Content-Type: multipart/form-data; boundary=WebAppBoundary
    
    --WebAppBoundary
    Content-Disposition: form-data; name="file1"; filename="pic_1.jpeg"
    
    < C:\Users\Think\Desktop\1.jpeg
    --WebAppBoundary--
    
    --WebAppBoundary
    Content-Disposition: form-data; name="file2"; filename="pic_2.jpeg"
    
    < C:\Users\Think\Desktop\2.jpeg
    --WebAppBoundary--
    
    --WebAppBoundary--
    Content-Disposition: form-data;name=userName
    
    tom
    --WebAppBoundary--
    
    --WebAppBoundary--
    Content-Disposition: form-data;name=age
    
    23
    --WebAppBoundary--
    ###

你可以把这个请求想象为页面中的一个表单，表单有4个元素：2个File元素，用来选择需要上传的2个文件，2个输入框，分别用来输入userName和age，用--WebAppBoundary来隔离每个元素，如果有多个元素，都需要用--WebAppBoundary隔离开来，如下：

5、环境切换

我们测试接口的时候，有开发环境、测试环境、UAT环境，生产环境，每个环境的接口信息都不一样，比如接口地址。

HTTP Client 中可以创建环境配置文件，来对不同的环境信息进行配置，操作如下

5.1、创建环境配置文件

生成了一个环境配置文件，如下

文件内容格式

    {
      "环境名称": {环境参数json格式},
      "环境名称": {环境参数json格式}
    }

如

    {
      "dev": {
        "url": "http://localhost:8080",
        "name": "张三"
      },
      "test": {
        "url": "http://localhost:9090",
        "name": "李四"
      }
    }

5.2、http文件中引用环境配置信息

通过{{key}}可以引用环境中的信息，运行的时候会被替换，如：

    GET {{url}}/get

5.3、运行的时候选择环境

运行的时候会提示你选择环境，此时环境中的配置信息就被用上了

大家赶紧去体验一下。