RESTFul服務開發必備的一款IDEA插件!用了就離不開了

  • 2020 年 11 月 20 日
  • 筆記

我們經常談 RESTful Web 服務開發,但是我發現很多人實際就根本不懂這個概念。只是聽著大家都這麼說,也就跟著一起說了,哈哈哈!

因此,在開始推薦這個IDEA插件之前,非常有必要花一小會時間簡單聊聊 REST 相關的概念。這是一個看似高大上,實際上很容易理解的概念。

REST 相關概念解讀

何為 REST?

REST 即 REpresentational State Transfer 的縮寫。這個片語的翻譯過來就是”表現層狀態轉化“。

這樣理解起來甚是晦澀,實際上 REST 的全稱是 Resource Representational State Transfer ,直白地翻譯過來就是 「資源」在網路傳輸中以某種「表現形式」進行「狀態轉移」

有沒有感覺很難理解?

沒關係,看了我對 REST 涉及到的一些概念的解讀之後你沒準就能理解了!

  • 資源(Resource) :我們可以把真實的對象數據稱為資源。一個資源既可以是一個集合,也可以是單個個體。比如我們的班級 classes 是代表一個集合形式的資源,而特定的 class 代表單個個體資源。每一種資源都有特定的 URI(統一資源定位符)與之對應,如果我們需要獲取這個資源,訪問這個 URI 就可以了,比如獲取特定的班級:/class/12。另外,資源也可以包含子資源,比如 /classes/classId/teachers:列出某個指定班級的所有老師的資訊
  • 表現形式(Representational):”資源”是一種資訊實體,它可以有多種外在表現形式。我們把”資源”具體呈現出來的形式比如 json,xml,image,txt 等等叫做它的”表現層/表現形式”。
  • 狀態轉移(State Transfer) :大家第一眼看到這個詞語一定會很懵逼?內心 BB:這尼瑪是啥啊? 大白話來說 REST 中的狀態轉移更多地描述的伺服器端資源的狀態,比如你通過增刪改查(通過 HTTP 動詞實現)引起資源狀態的改變。 (HTTP 協議是一個無狀態的,所有的資源狀態都保存在伺服器端)

何為 RESTful 架構?

滿足 REST 風格的架構設計就可以稱為RESTful 架構:

  1. 每一個 URI 代表一種資源;
  2. 客戶端和伺服器之間,傳遞這種資源的某種表現形式比如 json,xml,image,txt 等等;
  3. 客戶端通過特定的 HTTP 動詞,對伺服器端資源進行操作,實現”表現層狀態轉化”。

何為 RESTful Web服務?

基於 REST 架構的 Web 服務就被稱為 RESTful Web 服務。

RESTful Web服務輔助開發工具

安裝

這個插件的名字叫做 「RestfulToolkit」 。我們直接在 IDEA 的插件市場即可找到這個插件。如下圖所示。

如果你因為網路問題沒辦法使用 IDEA 自帶的插件市場的話,也可以通過IDEA 插件市場的官網手動下載安裝。

簡單使用

URL 跳轉到對應方法

根據 URL 直接跳轉到對應的方法定義 (Windows: ctrl+\ or ctrl+alt+n Mac:command+\ or command+alt+n )並且提供了一個服務的樹形可視化顯示窗口。 如下圖所示。

作為HTTP請求工具

這個插件還可以作為一個簡單的 http 請求工具來使用。如下圖所示。

複製生成 URL、複製方法參數…

這個插件還提供了生成 URL、查詢參數、請求體(RequestBody)等功能。

舉個例子。我們選中 Controller 中的某個請求對應的方法右擊,你會發現多了幾個可選項。當你選擇Generate & Copy Full URL的話,就可以把整個請求的路徑直接複製下來。eg://localhost:9333/api/users?pageNum=1&pageSize=1

將Java類轉換為對應的JSON格式

這個插件還為 Java 類上添加了 Convert to JSON 功能 。

我們選中的某個類對應的方法然後右擊,你會發現多了幾個可選項。

當我們選擇Convert to JSON的話,你會得到如下 json 類型的數據:

{
  "username": "demoData",
  "password": "demoData",
  "rememberMe": true
}

後記

剛剛有小夥伴指出 2020 版本之後的 IDEA 已經無法正常使用這個插件了。不過,網上有人開發了一個替代品 RestfulTool

閑聊

昨晚邊看電視邊把之前寫的一個 RPC 框架給重構了一下。我平時經常會抽時間重構一下之前寫的東西,對自己負責也對別人負責。

之前說這個框架幫助很多校招的小夥伴找到了大廠Offer,真的不是我吹牛皮。今年就有很多小夥伴用這個項目當做自己的項目經驗。


不過,我在項目中也說了,你想用我的這個項目充當項目經驗的話,一定要自己搞懂項目,並對其進行簡單的完善。不然的話,真沒啥用,就是自己騙自己罷了。

說實話,這個項目今年還很好用,畢竟用的人很少。明年的話,應該也還好。重要的是自己搞懂其中的思想並進行完善。

項目地址://github.com/Snailclimb/guide-rpc-framework

圖解電腦基礎+個人原創的 Java 面試手冊PDF版。

微信搜「JavaGuide」回復「電腦基礎」即可獲取圖解電腦基礎+個人原創的 Java 面試手冊。