更新時間:2022-08-10 11:05:27 來源:動力節(jié)點 瀏覽1879次
了解如何使用 REST 范例設計 Web 服務

REST 或 REpresentational State Transfer 是一種架構風格,用于在 Web 上的計算機系統(tǒng)之間提供標準,使系統(tǒng)之間更容易相互通信。符合 REST 的系統(tǒng),通常稱為 RESTful 系統(tǒng),其特點是它們是無狀態(tài)的,并且將客戶端和服務器的關注點分開。我們將深入探討這些術語的含義以及為什么它們是 Web 服務的有益特征。
在 REST 架構風格中,客戶端的實現(xiàn)和服務器的實現(xiàn)可以獨立完成,彼此不知道對方。這意味著客戶端的代碼可以隨時更改而不影響服務器的運行,而服務器端的代碼可以更改而不影響客戶端的運行。
只要雙方都知道要發(fā)送給對方的消息格式,它們就可以保持模塊化和分離。將用戶界面關注點與數(shù)據(jù)存儲關注點分開,我們提高了跨平臺界面的靈活性,并通過簡化服務器組件來提高可擴展性。此外,分離允許每個組件獨立發(fā)展的能力。
通過使用 REST 接口規(guī)范,不同的客戶端訪問相同的 REST 端點、執(zhí)行相同的操作并接收相同的響應。
遵循 REST 范式的系統(tǒng)是無狀態(tài)的,這意味著服務器不需要知道客戶端處于什么狀態(tài),反之亦然。這樣,服務器和客戶端都可以理解收到的任何消息,即使沒有看到以前的消息。這種無狀態(tài)約束是通過使用資源而不是命令來實現(xiàn)的。資源是 Web 的名詞——它們描述 了您可能需要存儲或發(fā)送到其他服務的任何對象、文檔或事物。
因為 REST 系統(tǒng)通過對資源的標準操作進行交互,所以它們不依賴于接口的實現(xiàn)。
這些約束有助于 RESTful 應用程序實現(xiàn)可靠性、快速性能和可擴展性,作為可以在不影響整個系統(tǒng)的情況下進行管理、更新和重用的組件,即使在系統(tǒng)運行期間也是如此。
現(xiàn)在,我們將探討在實現(xiàn) RESTful 接口時客戶端和服務器之間的通信是如何實際發(fā)生的。
在 REST 架構中,客戶端發(fā)送請求以檢索或修改資源,服務器發(fā)送對這些請求的響應。讓我們看一下發(fā)出請求和發(fā)送響應的標準方法。
REST 要求客戶端向服務器發(fā)出請求,以便檢索或修改服務器上的數(shù)據(jù)。請求通常包括:
一個 HTTP 動詞,它定義了要執(zhí)行的操作類型
一個標頭,允許客戶端傳遞有關請求的信息
資源路徑
包含數(shù)據(jù)的可選消息正文
我們在請求中使用 4 個基本的 HTTP 動詞來與 REST 系統(tǒng)中的資源進行交互:
GET — 檢索特定資源(通過 id)或資源集合
POST — 創(chuàng)建一個新資源
PUT — 更新特定資源(按 id)
DELETE — 按 id 刪除特定資源
在請求的標頭中,客戶端發(fā)送它能夠從服務器接收的內容類型。這稱為Accept字段,它確保服務器不會發(fā)送客戶端無法理解或處理的數(shù)據(jù)
MIME 類型,用于指定Accept字段中的內容類型,由 atype和 a組成subtype。它們由斜線 (/) 分隔。
例如,包含 HTML 的文本文件將被指定為 type text/html。如果此文本文件包含 CSS,則將其指定為text/css. 通用文本文件將表示為text/plain. 但是,此默認值text/plain不是萬能的。如果客戶端期待text/css并接收text/plain,它將無法識別內容。
其他類型和常用的亞型:
image— image/png, image/jpeg,image/gif
audio — audio/wav,audio/mpeg
video— video/mp4,video/ogg
application — application/json, application/pdf, application/xml,application/octet-stream
例如,客戶端訪問服務器上資源中具有id23 的articles資源可能會發(fā)送如下 GET 請求:
GET /articles/23
Accept: text/html, application/xhtml
在這種情況下,Accept標頭字段表示客戶端將接受text/htmlor中的內容application/xhtml。
請求必須包含指向應該對其執(zhí)行操作的資源的路徑。在 RESTful API 中,應該設計路徑以幫助客戶端了解正在發(fā)生的事情。
按照慣例,路徑的第一部分應該是資源的復數(shù)形式。這使嵌套路徑易于閱讀和理解。
fashionboutique.com/customers/223/orders/12即使您以前從未見過此特定路徑,類似路徑的指向也很清楚,因為它是分層的和描述性的。我們可以看到,我們正在為223id的客戶訪問 12的訂單。id
路徑應包含定位具有所需特異性程度的資源所需的信息。在引用資源列表或資源集合時,并不總是需要添加id. 例如,對fashionboutique.com/customers路徑的 POST 請求不需要額外的標識符,因為服務器將為id新對象生成一個。
如果我們試圖訪問單個資源,我們需要id在路徑上附加一個。例如: GET fashionboutique.com/customers/:id— 檢索具有指定 的customers資源中的項目。— 刪除指定資源中的項目。idDELETE fashionboutique.com/customers/:idcustomersid
在服務器向客戶端發(fā)送數(shù)據(jù)有效負載的情況下,服務器必須content-type在響應的標頭中包含 a。此content-type標頭字段提醒客戶端它在響應正文中發(fā)送的數(shù)據(jù)類型。這些內容類型是 MIME 類型,就像它們在accept請求標頭的字段中一樣。服務器在響應中發(fā)回的content-type應該是客戶端在accept請求字段中指定的選項之一。
例如,當客戶端使用此 GET 請求訪問資源中的id23資源時:articles。
GET /articles/23 HTTP/1.1
Accept: text/html, application/xhtml
服務器可能會發(fā)送回帶有響應頭的內容:
HTTP/1.1 200 (OK)
Content-Type: text/html
這表示請求的內容在響應正文中以content-typeof形式返回text/html,客戶端表示它能夠接受。
來自服務器的響應包含狀態(tài)代碼以提醒客戶端有關操作成功的信息。作為開發(fā)人員,您不需要知道每個狀態(tài)碼(其中有很多),但您應該知道最常見的狀態(tài)碼以及它們的使用方式:
| 狀態(tài)碼 | 意義 |
|---|---|
| 200(好) | 這是成功的 HTTP 請求的標準響應。 |
| 201(已創(chuàng)建) | 這是成功創(chuàng)建項目的 HTTP 請求的標準響應。 |
| 204(無內容) | 這是成功 HTTP 請求的標準響應,響應正文中沒有返回任何內容。 |
| 400(錯誤請求) | 由于請求語法錯誤、大小過大或其他客戶端錯誤,無法處理該請求。 |
| 403(禁止) | 客戶端無權訪問此資源。 |
| 404(未找到) | 此時找不到資源。它可能已被刪除,或者尚不存在。 |
| 500內部服務器錯誤) | 如果沒有更具體的信息可用,則為意外失敗的通用答案。 |
對于每個 HTTP 動詞,服務器應在成功時返回預期的狀態(tài)代碼:
GET — 返回 200(確定)
POST — 返回 201(已創(chuàng)建)
PUT——返回 200(OK)
DELETE — 返回 204 (NO CONTENT) 如果操作失敗,返回與遇到的問題相對應的最具體的狀態(tài)碼。
假設我們有一個應用程序,允許您查看、創(chuàng)建、編輯和刪除托管在小型服裝店的客戶和訂單fashionboutique.com。我們可以創(chuàng)建一個允許客戶端執(zhí)行這些功能的 HTTP API:
如果我們想查看所有客戶,請求將如下所示:
GET http://fashionboutique.com/customers
Accept: application/json
可能的響應標頭如下所示:
Status Code: 200 (OK)
Content-type: application/json
其次是格式customers要求的數(shù)據(jù)application/json。
通過發(fā)布數(shù)據(jù)創(chuàng)建新客戶:
POST http://fashionboutique.com/customers
Body:
{
“customer”: {
“name” = “Scylla Buss”,
“email” = “scylla.buss@codecademy.org”
}
}
然后,服務器id為該對象生成一個并將其返回給客戶端,其標頭如下:
201 (CREATED)
Content-type: application/json
要查看單個客戶,我們通過指定該客戶的 id 來獲取它:
GET http://fashionboutique.com/customers/123
Accept: application/json
可能的響應標頭如下所示:
Status Code: 200 (OK)
Content-type: application/json
后面是格式為23的customer資源數(shù)據(jù)。idapplication/json
我們可以通過PUT新數(shù)據(jù)更新該客戶:
PUT http://fashionboutique.com/customers/123
Body:
{
“customer”: {
“name” = “Scylla Buss”,
“email” = “scyllabuss1@codecademy.com”
}
}
可能的響應標頭將具有Status Code: 200 (OK), 以通知客戶端帶有id123 的項目已被修改。
我們還可以通過指定其刪除該客戶id:
DELETE http://fashionboutique.com/customers/123
響應將有一個包含 的標頭Status Code: 204 (NO CONTENT),通知客戶端帶有id123 的項目已被刪除,而正文中沒有任何內容。如果大家想了解更多相關知識,可以關注一下動力節(jié)點的Java在線學習,里面的課程內容從入門到精通,很適合沒有基礎的小伙伴學習,希望對大家能夠有所幫助。