IntelliJ IDEA的這個接口調試工具真是太好用了！

本文轉載自查看原文 2020-07-04 14:46 3935 IDEA

插播背景

在多個產品線上來回穿切換着開發功能，以前用Postman的場景是這樣的:

實際遠遠不止這幾個文件夾來歸類多個產品線的接口，Postman的功能非常強大，但是面對以下這些狀況時，我覺得調試一個接口太麻煩了（這里不討論工具的好壞，工具是幫助我們提高效率的，每個人的需求也不一樣，我只說明我個人遇到的一些情況，不喜請勿噴）

查找配置多數要通過鼠標點來點去, 與習慣文本和快捷鍵操作的便捷方式違背
調試別人接口要導入他們的一些數據，比較麻煩
多個產品線環境變量查看不直觀
寫完接口要來回切換應用進行測試，比如（IDEA <——> Postman）
快速定位接口比較麻煩
......

無意間發現 IntelliJ IDEA 的 HTTP Client 工具剛好能解決我上面提到的一些問題，簡單的說就是能直接在 IDEA 的代碼編輯器中 創建，編輯，執行 HTTP請求，就像這樣(如果你心動了，請繼續向下看吧)：

於是，去官網查看一番作出如下整理：

走進 Http Client

HTTP Client 是 IDEA 默認綁定好並啟用的插件，如果你那里沒有啟用，按照下圖啟用就好

點擊菜單：Tools — HTTP Client — Test RESTful Web Service

接下來進入下面的界面：

上圖已給出提示，REST Client 是被棄用的，點擊右側的 Convert request to new format , 進到下面界面：

默認會創建一個名為 rest-api.http 的文件，該文件被存儲在 Scratches 文件夾下，為了突出主角光環，關於 Scratch Files 請官網自行查看（繼續向下看不影響理解的），黃色框線的功能也非常有用，繼續向下看

創建 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 給我們提供了模版，我們只需要在 Examples 中找模版就可以啦，比如找 POST 請求的模版，選取合適的拷貝過去就可以，so easy～～～

到這里，就可以發送基本的請求了，但是，一個項目中接口眾多，如何快速生成參數？如何快速切換端口？如何讓登錄之后的每個請求自動攜帶成功返回的 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": "tanrgyb",
    "password": "iloveu"
  },
  "prod": {
    "host": "dayarch.top",
    "port": 8080,
    "identifier": "admin",
    "password": "admin"
  }
}

運行一下我們編寫的請求吧：

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);
 %}