Idea自带的http client工具使用攻略

2023-11-16

平时都是用postman来调接口，有时候也会用到swagger。用swagger还可以，直接在浏览器上开个页面即可，但是postman就不行了，需要单独的运行，个人感觉postman还是比较占内存的。最近和一个其他组同事联调，发现他们使用的是idea自带的HTTP Client工具，感觉挺好用的，调接口不需要切浏览器，切应用。直接在idea中可以完成。挺酷(zhuang)炫(bi)的，所以准备学习一下，在网上也找到了这方面的很多文章，在研究的时候都有借鉴，多谢各位爱分享的博友们。

界面化调试

界面化操作很简单，都是类似postman等其他发送请求的客户端工具，这里就不具体介绍使用规则啦。

打开入口：工具栏(idea顶上的一行工具里面)->Tools->HTTP Client

文件形式调试

在文件里面编写请求所需要的地址、参数、请求头等信息，还可以通过全局变量来设置共用的信息。既然是使用idea，可以使用快捷键是必须滴。下面来一一的介绍。

首先需要创建一个编写http请求信息的文件，可以在resources目录下建一个目录http，右击http->New->HTTP Request，输入文件名称即可创建文件。具体这个文件放在什么地方没有特殊的要求，但是个人习惯方在resources目录下，再有个http目录便于管理，下面也基于这个目录来说。建好的文件名是httpClient.http。

创建文件成功后，文件上面会有几行注释，这几行注释不多做解释，自己翻译一下即可。里面有快捷键的说明，下面我会再具体使用的时候说明。

附文件初始注释说明信息：

# For a quick start check out our HTTP Requests collection (Tools|HTTP Client|Open HTTP Requests Collection).
#
# Following HTTP Request Live Templates are available:
# * 'gtrp' and 'gtr' create a GET request with or without query parameters;
# * 'ptr' and 'ptrp' create a POST request with a simple or parameter-like body;
# * 'mptr' and 'fptr' create a POST request to submit a form with a text or file field (multipart/form-data);

POST请求之JSON数据

接口代码：

@PostMapping("addArticle")
@ResponseBody
public String addArticle(@RequestBody ArticleReqDTO reqDTO) {
    log.info("Execute ArticleController.addArticle，reqDTO=【{}】", reqDTO);
    return "add success";
}

httpClient.http内代码：

### 第一行：POST请求，请求地址
### 第二行：请求头信息，多个请求头信息依次写下去(第三行、第四行……)
### 第N行：写具体的请求体，这里是JSON串，请求头和请求体之间要空出一行
POST http://localhost:8282/api/addArticle
Content-Type: application/json

{
    "title":"文章标题",
    "abst":"文章摘要",
    "categoryId":1,
    "authorName":"IT-CRUD"
}

书写是很简单的，httpClient.http编写也不难，细节注意点就可以。

快捷键ptr，输入会有提示，直接回车即可。

POST请求之FORM表单

接口代码：

@PostMapping(value = "updateArticle_form", produces = MediaType.APPLICATION_FORM_URLENCODED_VALUE) //指定请求数据格式是form表单
@ResponseBody
public String updateArticle_form(@ModelAttribute ArticleReqDTO reqDTO) {
    log.info("Execute ArticleController.updateArticle_form，reqDTO=【{}】", reqDTO);
    return "update success";
}

httpClient.http内代码：

### 修改文章(form表单提交)
POST http://localhost:8282/api/updateArticle_form
Content-Type: application/x-www-form-urlencoded

id=1&title=文章标题&abst=文章摘要&categoryId=1&authorName=IT-CRUD

这个具体的说明就没写了，基本都是相同的格式，参考上一个示例，但是这里需要注意的是字段名和字段值不能加引号。如"id"=1&"title"="文章标题"，这样会报错的。生成此结构使用快捷键ptrp。

另外一个注意点： 每个请求后面都要加###结束，换句话说，就是两个请求之间用###分隔，否则会直接报错。

GET请求

接口代码：

@GetMapping("getList")
@ResponseBody
public List<ArticleVO> getList(@RequestParam("keywords") String keywords
        , @RequestParam("categoryId") Integer categoryId) {
    log.info("Execute ArticleController.updateArticle_form，keywords=【{}】,categoryId=【{}】", keywords, categoryId);
    List<ArticleVO> vos = Lists.newArrayList();
    vos.add(ArticleVO.builder().abst("这是个摘要--1").authorName("IT-CRUD")
            .categoryId(1).categoryName("Spring").createTime(new Date()).title("这是一个标题--1")
            .build());
    vos.add(ArticleVO.builder().abst("这是个摘要--2").authorName("IT-CRUD")
            .categoryId(1).categoryName("Spring").createTime(new Date()).title("这是一个标题--2")
            .build());
    vos.add(ArticleVO.builder().abst("这是个摘要--3").authorName("IT-CRUD")
            .categoryId(1).categoryName("Spring").createTime(new Date()).title("这是一个标题--3")
            .build());
    return vos;
}

httpClient.http内代码：

### 查询文章列表
GET http://localhost:8282/api/getList?keywords=标题&categoryId=1
Accept: application/json

GET请求和POST请求一样，也是有两个快捷键，分别是gtr和gtrp，第一个是生成无参数的模板，第二个是生成有参数。区别就是第二种会在请求地址后面加上?id=xx这种参数。

全局变量配置

常用的几种请求方式上面已经清楚啦，下面来看一下全局变量配置。这个全局的变量和spring的配置文件是完全分开的，没有关联。

配置文件的名称和内容格式都有特殊要求，名称必须是rest-client.env.json或者http-client.env.json。

配置文件格式：

{
  "dev":{
    "host":"http://localhost:8282"
    ## 其他属性 ……
  },
  "st":{
    "host":"http://cs.itcrud.com"
    ## 其他属性 ……
  }
}

格式不多说，官方规定，就如同spring的yml配置文件，就要按照它的来，没商量。

从json串可以看出这里可以配置多个环境，这个就很方便啦。在使用postman的时候就会有环境地址切换的问题，本地、测试等环境来回切换地址很头疼，如果直接配置两套，又感觉很傻。如果使用idea的这个http client就方便，提前配好，一劳永逸。

具体怎么使用呢？很简单，在httpClient.http文件里面修改如下：

# 修改前
GET http://localhost:8282/api/getList?keywords=标题&categoryId=1
# 修改后，这个host就指向配置文件中的host对应的值
GET {{host}}/api/getList?keywords=标题&categoryId=1

httpClient.http文件中每个请求前面都有个绿色的三角形（运行按钮），可以直接点击运行，点击后会提示你选择哪个环境的配置运行。如图：

在这里插入图片描述

总结

整体基本写完啦，但是细心的可能会注意到还有两个快捷键没有介绍，那就是mptr和fptr，都是文件上传的快捷键，具体待研究，尝试了一次没有弄好，请求是通的，但是接口接受文件的对象是空。(研究完后期会在这篇文章里面更新)

另外还有一个挺酷的功能，可以自己写脚本，对执行的结果进行处理，如响应是500，控制台应该显示什么信息；还可以根据响应的值给予特殊的处理等。自动义脚本功能感觉用不上，就没有多去研究，脚本看起来并不是很难，如果你很感兴趣可以研究一下官方文档。

官方文档：https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html

Source Code

码云（gitee）：https://gitee.com/itcrud/itcrud-note/tree/master/itcrud-note-1-2

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)