RESTful三問

時間  2019-12-07
標籤 restful 简体版
原文   原文鏈接

我以爲學習一個技術，其實就是要弄明白三件事情：是什麼（what），爲何（why），怎麼用（how）。正是所謂的三W方法。javascript

因此打算總結一個「三問」系列。爲了本身學習，也分享給別人。html

RESTful是什麼？

REST是 REpresentational State Transfer的縮寫。可是representational state transfer仍然很難理解。直譯的話通常譯做表述性狀態轉移。什麼鬼？
實際上是由於前面主語被去掉了，應該是Resource Representational State Transfer。直譯的話，我以爲能夠譯做「 資源的具象化的狀態轉移」。仍然是什麼鬼？
這只是個人我的理解。由於這個原本就是老外的晦澀難懂的論文中的詞彙，並無一個準確的翻譯。
 
那麼什麼是資源的具象化的資源狀態轉移呢？
Resource：資源，即數據。
網絡上的因此數據均可以被看作是資源，而且能用一個惟一的URL表示。好比一條用戶信息數據，一張圖片，一個文件等等。
Representational：具象化的。
URL就像資源的ID，讓資源在網絡上有了統一的定位可以被獲取和訪問。那麼資源在網絡上怎麼描述呢，或者說資源的表現形式是什麼？
咱們有MIME media types，好比image/jpeg，multipart/encrypted，text/plain等等，來規定資源如何展示。
有HTTP中的具體動詞方法：GET，POST，PUT，PATCH，DELETE等等，來規定對資源的操做。
這些均可以認爲是資源的representations。
State Transfer：狀態轉移。
咱們知道HTTP協議是無狀態的。可是資源是有狀態的。
好比有一個資源是ID爲9527的員工，age是32歲。這都是資源的狀態。state transfer就是資源的狀態經過網絡來傳遞轉移。好比我經過操做把這個員工age變爲33歲，就是狀態轉移。
 
如今假設網絡上有一個資源，URL是localhost:8080//root/users。是一組用戶數據。
我經過HTTP的GET方法（representational）請求這個資源localhost:8080//root/users（resource），而後獲得的返回（transfer）是用application/json表示的（representational）這組用戶的數據（state）。
就是一次資源的具象化的狀態轉移。
我再經過PATCH - localhost:8080//root/users/9527 - {age:33} 把這個指定用戶的新狀態發送給服務器端的這個資源來進行狀態更新，就是又一次的resource representational state transfer。
 
若是你仍是沒看懂（應該是沒有），那能夠自行參考大神Roy Fielding的畢業論文。REST就是他提出的。這哥們參與設計HTTP協議，也是Apache Web Server項目的co-founder。
 
怎麼樣，看完是否是更懵了呢？
不要緊，一句話理解就是： 在HTTP請求中，用URL定位資源，用HTTP動詞（GET,POST,PUT,PATCH,DELETE）描述對資源進行什麼操做。
符合這種設計風格的架構設計，咱們就稱之爲RESTful風格的架構。

爲何要用RESTful？

首先要說明的一點就是，RESTful是一種設計風格，不是指導思想，也不是最佳實踐。只是有些狀況下選用符合RESTful的架構確實更好一些。不吹不黑。前端

如今的網絡時代，技術飛速發展。SOA啦，Web Service啦，微服務啦，各類概念各類思想層出不窮。客戶端也是瀏覽器，Android，iOS等都五花八門。java

那麼在先後端分離的思想下，通常咱們都是設計基於 HTTP API 的服務。這樣的好處是什麼呢？固然是一套API各類客戶端隨便用啦。git

設計API的時候，咱們通常有兩種方法：github

一種是隻要用 GET 請求和 POST 請求就足夠了，把操做放在URL上。數據庫

一種是RESTful的方式，URL只表示資源，用HTTP中不一樣的請求方法表明不一樣的操做。json

 

假設有一類資源 ResourceXYZ ，對其有增刪查改的操做。 若是隻使用 GET POST 之類的設計方式，那麼極可能會設計如下的請求接口：後端

POST .../addResourceXYZ //新增資源
POST .../delResourceXYZ  //刪除資源
GET .../getResourceXYZ?resourceId=resourceId  //獲取指定ID的資源
POST .../updateResourceXYZ  //更新資源

若是按照 RESTful 的 設計方式，極可能會設計如下的請求接口：api

POST .../ResourceXYZs  //新增資源
DELETE .../ResourceXYZ/{resourceId}  //刪除資源
GET .../ResourceXYZ/{resourceId}  //獲取指定ID的資源
PUT .../ResourceXYZ/{resourceId}  //更新資源

那麼使用RESTful風格有什麼好處呢？

如今假設，客戶端要獲取該資源，其 ID 爲 resourceId 。 若是成功，那麼一切都好說。 若是失敗， Restful 的處理方式是，經過 HTTP status 返回錯誤碼來表示緣由，例如 404 表示該資源不存在。

那麼只用 GET POST 兩種方法的方式呢？ 響應請求

GET .../getResourceXYZ?resourceId=resourceId

的時候能不能也用 404 呢？

按照 404 的語義，響應 404 是不對的： 由於客戶端請求的 URL 其實是正確的，只是對應的參數沒有找到對應的結果。不少時候，就只能靠響應 200 而後返回空數據或者空對象來處理了。例如 Content-type 爲 application/json 時，能夠返回 {} 或者

{
    "error": "not found",
    "code": 404
}

這樣就會要求客戶端，必須處理 HTTP 回覆的具體內容，而不能只處理頭部。 那麼客戶端要怎麼處理這個 json 呢？要先解析 json ，而後嘗試區分這是一個資源的內容，仍是一個錯誤提示。

這樣前端的人就比較容易罵街了。

 

如何設計一個RESTful的架構呢？

我以爲這篇寫的很詳細很好了，這裏全文轉載阮一峯的RESTful API 設計指南。

如下爲轉載開始：

1、協議

API與用戶的通訊協議，老是使用HTTPs協議。

2、域名

應該儘可能將API部署在專用域名之下。

https://api.example.com

若是肯定API很簡單，不會有進一步擴展，能夠考慮放在主域名下。

https://example.org/api/

3、版本（Versioning）

應該將API的版本號放入URL。

https://api.example.com/v1/

另外一種作法是，將版本號放在HTTP頭信息中，但不如放入URL方便和直觀。Github採用這種作法。

4、路徑（Endpoint）

路徑又稱"終點"（endpoint），表示API的具體網址。

在RESTful架構中，每一個網址表明一種資源（resource），因此網址中不能有動詞，只能有名詞，並且所用的名詞每每與數據庫的表格名對應。通常來講，數據庫中的表都是同種記錄的"集合"（collection），因此API中的名詞也應該使用複數。

舉例來講，有一個API提供動物園（zoo）的信息，還包括各類動物和僱員的信息，則它的路徑應該設計成下面這樣。

  • https://api.example.com/v1/zoos
  • https://api.example.com/v1/animals
  • https://api.example.com/v1/employees

5、HTTP動詞

對於資源的具體操做類型，由HTTP動詞表示。

經常使用的HTTP動詞有下面五個（括號裏是對應的SQL命令）。

  • GET（SELECT）：從服務器取出資源（一項或多項）。
  • POST（CREATE）：在服務器新建一個資源。
  • PUT（UPDATE）：在服務器更新資源（客戶端提供改變後的完整資源）。
  • PATCH（UPDATE）：在服務器更新資源（客戶端提供改變的屬性）。
  • DELETE（DELETE）：從服務器刪除資源。

還有兩個不經常使用的HTTP動詞。

  • HEAD：獲取資源的元數據。
  • OPTIONS：獲取信息，關於資源的哪些屬性是客戶端能夠改變的。

下面是一些例子。

  • GET /zoos：列出全部動物園
  • POST /zoos：新建一個動物園
  • GET /zoos/ID：獲取某個指定動物園的信息
  • PUT /zoos/ID：更新某個指定動物園的信息（提供該動物園的所有信息）
  • PATCH /zoos/ID：更新某個指定動物園的信息（提供該動物園的部分信息）
  • DELETE /zoos/ID：刪除某個動物園
  • GET /zoos/ID/animals：列出某個指定動物園的全部動物
  • DELETE /zoos/ID/animals/ID：刪除某個指定動物園的指定動物

6、過濾信息（Filtering）

若是記錄數量不少，服務器不可能都將它們返回給用戶。API應該提供參數，過濾返回結果。

下面是一些常見的參數。

  • ?limit=10：指定返回記錄的數量
  • ?offset=10：指定返回記錄的開始位置。
  • ?page=2&per_page=100：指定第幾頁，以及每頁的記錄數。
  • ?sortby=name&order=asc：指定返回結果按照哪一個屬性排序，以及排序順序。
  • ?animal_type_id=1：指定篩選條件

參數的設計容許存在冗餘，即容許API路徑和URL參數偶爾有重複。好比，GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。

7、狀態碼（Status Codes）

服務器向用戶返回的狀態碼和提示信息，常見的有如下一些（方括號中是該狀態碼對應的HTTP動詞）。

  • 200 OK - [GET]：服務器成功返回用戶請求的數據，該操做是冪等的（Idempotent）。
  • 201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數據成功。
  • 202 Accepted - [*]：表示一個請求已經進入後臺排隊（異步任務）
  • 204 NO CONTENT - [DELETE]：用戶刪除數據成功。
  • 400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發出的請求有錯誤，服務器沒有進行新建或修改數據的操做，該操做是冪等的。
  • 401 Unauthorized - [*]：表示用戶沒有權限（令牌、用戶名、密碼錯誤）。
  • 403 Forbidden - [*] 表示用戶獲得受權（與401錯誤相對），可是訪問是被禁止的。
  • 404 NOT FOUND - [*]：用戶發出的請求針對的是不存在的記錄，服務器沒有進行操做，該操做是冪等的。
  • 406 Not Acceptable - [GET]：用戶請求的格式不可得（好比用戶請求JSON格式，可是隻有XML格式）。
  • 410 Gone -[GET]：用戶請求的資源被永久刪除，且不會再獲得的。
  • 422 Unprocesable entity - [POST/PUT/PATCH] 當建立一個對象時，發生一個驗證錯誤。
  • 500 INTERNAL SERVER ERROR - [*]：服務器發生錯誤，用戶將沒法判斷髮出的請求是否成功。

狀態碼的徹底列表參見這裏。

8、錯誤處理（Error handling）

若是狀態碼是4xx，就應該向用戶返回出錯信息。通常來講，返回的信息中將error做爲鍵名，出錯信息做爲鍵值便可。

{ error: "Invalid API key" }

9、返回結果

針對不一樣操做，服務器向用戶返回的結果應該符合如下規範。

  • GET /collection：返回資源對象的列表（數組）
  • GET /collection/resource：返回單個資源對象
  • POST /collection：返回新生成的資源對象
  • PUT /collection/resource：返回完整的資源對象
  • PATCH /collection/resource：返回完整的資源對象
  • DELETE /collection/resource：返回一個空文檔

10、Hypermedia API

RESTful API最好作到Hypermedia，即返回結果中提供連接，連向其餘API方法，使得用戶不查文檔，也知道下一步應該作什麼。

好比，當用戶向api.example.com的根目錄發出請求，會獲得這樣一個文檔。

{"link": { "rel": "collection https://www.example.com/zoos", "href": "https://api.example.com/zoos", "title": "List of zoos", "type": "application/vnd.yourformat+json" }}

上面代碼表示，文檔中有一個link屬性，用戶讀取這個屬性就知道下一步該調用什麼API了。rel表示這個API與當前網址的關係（collection關係，並給出該collection的網址），href表示API的路徑，title表示API的標題，type表示返回類型。

Hypermedia API的設計被稱爲HATEOAS。Github的API就是這種設計，訪問api.github.com會獲得一個全部可用API的網址列表。

{ "current_user_url": "https://api.github.com/user", "authorizations_url": "https://api.github.com/authorizations",  // ... }

從上面能夠看到，若是想獲取當前用戶的信息，應該去訪問api.github.com/user，而後就獲得了下面結果。

{ "message": "Requires authentication", "documentation_url": "https://developer.github.com/v3" }

上面代碼表示，服務器給出了提示信息，以及文檔的網址。

11、其餘

（1）API的身份認證應該使用OAuth 2.0框架。

（2）服務器返回的數據格式，應該儘可能使用JSON，避免使用XML。

轉載結束。

 

支持RESTful的Java開發框架，有SpringMVC，Oracle的Jersey等。關於Jersey我還在學習，之後會寫專門的文章來總結。

 

參考文章：

知乎用戶覃超的回答：https://www.zhihu.com/question/28557115/answer/48094438

V2EX用戶noli的文章：https://www.v2ex.com/t/340607?p=2

阮一峯的博客：http://www.ruanyifeng.com/blog/2014/05/restful_api

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程