IDEA HTTP Client 工具使用

使用 IntelliJ IDEA HTTP Client 编写请求、切换环境并复用响应中的令牌。

阅读说明：菜单和截图来自原笔记使用的 IDEA 版本。登录请求与环境配置已换成示例值；私有环境文件请同时检查 Git 忽略规则，避免把实际令牌或口令提交到仓库。

走进 Http Client

HTTP Client 是 IDEA 默认绑定好并启用的插件，如果你那里没有启用，按照下图启用就好

IDEA http client工具使用配图 1

点击菜单：Tools — HTTP Client — Test RESTful Web Service

IDEA http client工具使用配图 2

接下来进入下面的界面：

IDEA http client工具使用配图 3

上图已给出提示，REST Client 是被弃用的，点击右侧的 Convert request to new format , 进到下面界面：

IDEA http client工具使用配图 4

默认会创建一个名为 rest-api.http 的文件，该文件被存储在 Scratches 文件夹下，为了突出主角光环，关于 Scratch Files 请官网自行查看（继续向下看不影响理解的），黄色框线的功能也非常有用，继续向下看

语法部分

首先通过 ### 三个井号键来分开每个请求体，然后请求url和header参数是紧紧挨着的，请求参数不管是POST的body传参还是GET的parameter传参，都是要换行的

创建 HTTP request 文件

刚刚提到的 rest-api.http 就是 HTTP request 文件，可以通过两种方式创建：

通过快捷键 ⇧⌘N 然后选择 HTTP Request. （文件存放在Scratches 文件夹）
通过菜单操作 File—New—HTTP Request （文件存放在我们指定的目录下，就和我们平时创建class/package是一样一样滴）

如果在项目中使用，这里推荐使用第二种方式，因为它可以作为项目文件，通过 Git 提交到仓库，大家共享文件，共同维护接口请求数据，自然就不会出现调试别人接口还要导入他人数据的情况啦

编辑 HTTP request 文件

我们模拟实际项目中场景来编辑文件

用户登录，成功后获取 Token，通常是 POST 请求
用户后续访问行为都要在请求头中携带登录成功返回的 Token

通过点击 Add Request，选择相应的方法就可以编写啦

IDEA http client工具使用配图 5

都知道，通常写一个完整的请求需要写好多内容，贴心的 IDEA 给我们提供了模版，我们只需要在 Examples 中找模版就可以啦，比如找 POST 请求的模版，选取合适的拷贝过去就可以，so easy～～～

IDEA http client工具使用配图 6

到这里，就可以发送基本的请求了，但是，一个项目中接口众多，如何快速生成参数？如何快速切换端口？如何让登录之后的每个请求自动携带成功返回的 Token？我们需要更高级的玩法

HTTP Client 进阶玩法

使用环境变量

在编写HTTP请求时，可以使用变量对其元素进行参数化。变量可以保存请求的host、port和path、查询参数或值、请求头值或请求体值等.

使用变量的方式非常简单，就用两个大括号包围定义好的变量就可以了，就像这样：

当然我们也要有地方定义变量

定义环境变量

环境变量需要定义在环境文件中，环境文件有两种：

创建名为 rest-client.env.json 或者 http-client.env.json 的环境文件(其实里面就是保存 JSON 数据)，该文件里可以定义用在整个项目上的所有常规变量
创建名为rest-client.private.env.json 或者 http-client.private.env.json，看文件名你应该也猜到这是保存敏感数据的，比如密码，token等，该文件默认是被加入到 VCS 的 ignore文件中的，同时优先级高于其他环境文件，也就是说，该文件的变量会覆盖其他环境文件中的变量值

里面的文件内容就像这样

{
  "dev": {
    "host": "localhost",
    "port": 8081,
    "identifier": "demo",
    "password": "CHANGE_ME"
  },
  "prod": {
    "host": "api.example.com",
    "port": 8080,
    "identifier": "demo",
    "password": "CHANGE_ME"
  }
}

运行一下我们编写的请求吧：

IDEA自动识别多个环境，这样就可以轻而易举的切换环境，使用不同的变量值了（这皮鞋，你说亮不亮，还有更亮的）

巧用 response handler 脚本

上面提到，我们要让登录成功后的所有请求都自动携带成功返回的 Token，这样不用我们每次都手动将其添加到header中，同样有两种方式将脚本插入到请求中

内嵌方式

GET host/api/test

> {%
response 脚本
%}

外部文件方式（就是将内嵌的脚本抽离出到文件中）

GET host/api/test

> scripts/my-script.js

以登录返回获取的token设置到变量中为例，看代码：

POST http://{{host}}:{{port}}/login
Content-Type: application/json
Accept: application/json

> {%
client.global.set("auth_token", response.body.result.token);
 %}