天天看點

了解restful協定

原文

越來越多的人開始意識到,網站即軟體,而且是一種新型的軟體。

這種"網際網路軟體"采用用戶端/伺服器模式,建立在分布式體系上,通過網際網路通信,具有高延時(high latency)、高并發等特點。

網站開發,完全可以采用軟體開發的模式。但是傳統上,軟體和網絡是兩個不同的領域,很少有交集;軟體開發主要針對單機環境,網絡則主要研究系統之間的通信。網際網路的興起,使得這兩個領域開始融合,現在我們必須考慮,如何開發在網際網路環境中使用的軟體。

了解restful協定

RESTful架構,就是目前最流行的一種網際網路軟體架構。它結構清晰、符合标準、易于了解、擴充友善,是以正得到越來越多網站的采用。

但是,到底什麼是RESTful架構,并不是一個容易說清楚的問題。下面,我就談談我了解的RESTful架構。

一、起源

REST這個詞,是Roy Thomas Fielding在他2000年的博士論文中提出的。

了解restful協定

Fielding是一個非常重要的人,他是HTTP協定(1.0版和1.1版)的主要設計者、Apache伺服器軟體的作者之一、Apache基金會的第一任主席。是以,他的這篇論文一經發表,就引起了關注,并且立即對網際網路開發産生了深遠的影響。

他這樣介紹論文的寫作目的:

“本文研究計算機科學兩大前沿----軟體和網絡----的交叉點。長期以來,軟體研究主要關注軟體設計的分類、設計方法的演化,很少客觀地評估不同的設計選擇對系統行為的影響。而相反地,網絡研究主要關注系統之間通信行為的細節、如何改進特定通信機制的表現,常常忽視了一個事實,那就是改變應用程式的互動風格比改變互動協定,對整體表現有更大的影響。我這篇文章的寫作目的,就是想在符合架構原理的前提下,了解和評估以網絡為基礎的應用軟體的架構設計,得到一個功能強、性能好、适宜通信的架構。”

(This dissertation explores a junction on the frontiers of two research disciplines in computer science: software and networking. Software research has long been concerned with the categorization of software designs and the development of design methodologies, but has rarely been able to objectively evaluate the impact of various design choices on system behavior. Networking research, in contrast, is focused on the details of generic communication behavior between systems and improving the performance of particular communication techniques, often ignoring the fact that changing the interaction style of an application can have more impact on performance than the communication protocols used for that interaction. My work is motivated by the desire to understand and evaluate the architectural design of network-based application software through principled use of architectural constraints, thereby obtaining the functional, performance, and social properties desired of an architecture. )

二、名稱

Fielding将他對網際網路軟體的架構原則,定名為REST,即Representational State Transfer的縮寫。我對這個詞組的翻譯是"表現層狀态轉化"。

如果一個架構符合REST原則,就稱它為RESTful架構。

**要了解RESTful架構,最好的方法就是去了解Representational State Transfer這個詞組到底是什麼意思,它的每一個詞代表了什麼涵義。**如果你把這個名稱搞懂了,也就不難體會REST是一種什麼樣的設計。

三、資源(Resources)

REST的名稱"表現層狀态轉化"中,省略了主語。“表現層"其實指的是"資源”(Resources)的"表現層"。

**所謂"資源",就是網絡上的一個實體,或者說是網絡上的一個具體資訊。**它可以是一段文本、一張圖檔、一首歌曲、一種服務,總之就是一個具體的實在。你可以用一個URI(統一資源定位符)指向它,每種資源對應一個特定的URI。要擷取這個資源,通路它的URI就可以,是以URI就成了每一個資源的位址或獨一無二的識别符。

所謂"上網",就是與網際網路上一系列的"資源"互動,調用它的URI。

四、表現層(Representation)

"資源"是一種資訊實體,它可以有多種外在表現形式。我們把"資源"具體呈現出來的形式,叫做它的"表現層"(Representation)。

比如,文本可以用txt格式表現,也可以用HTML格式、XML格式、JSON格式表現,甚至可以采用二進制格式;圖檔可以用JPG格式表現,也可以用PNG格式表現。

URI隻代表資源的實體,不代表它的形式。嚴格地說,有些網址最後的".html"字尾名是不必要的,因為這個字尾名表示格式,屬于"表現層"範疇,而URI應該隻代表"資源"的位置。它的具體表現形式,應該在HTTP請求的頭資訊中用Accept和Content-Type字段指定,這兩個字段才是對"表現層"的描述。

五、狀态轉化(State Transfer)

通路一個網站,就代表了用戶端和伺服器的一個互動過程。在這個過程中,勢必涉及到資料和狀态的變化。

網際網路通信協定HTTP協定,是一個無狀态協定。這意味着,所有的狀态都儲存在伺服器端。是以,如果用戶端想要操作伺服器,必須通過某種手段,讓伺服器端發生"狀态轉化"(State Transfer)。而這種轉化是建立在表現層之上的,是以就是"表現層狀态轉化"。

用戶端用到的手段,隻能是HTTP協定。具體來說,就是HTTP協定裡面,四個表示操作方式的動詞:GET、POST、PUT、DELETE。它們分别對應四種基本操作:GET用來擷取資源,POST用來建立資源(也可以用于更新資源),PUT用來更新資源,DELETE用來删除資源。

六、綜述

綜合上面的解釋,我們總結一下什麼是RESTful架構:

(1)每一個URI代表一種資源;

(2)用戶端和伺服器之間,傳遞這種資源的某種表現層;

(3)用戶端通過四個HTTP動詞,對伺服器端資源進行操作,實作"表現層狀态轉化"。

七、誤區

RESTful架構有一些典型的設計誤區。

**最常見的一種設計錯誤,就是URI包含動詞。**因為"資源"表示一種實體,是以應該是名詞,URI不應該有動詞,動詞應該放在HTTP協定中。

舉例來說,某個URI是/posts/show/1,其中show是動詞,這個URI就設計錯了,正确的寫法應該是/posts/1,然後用GET方法表示show。

如果某些動作是HTTP動詞表示不了的,你就應該把動作做成一種資源。比如網上彙款,從賬戶1向賬戶2彙款500元,錯誤的URI是:

POST /accounts/1/transfer/500/to/2
           

正确的寫法是把動詞transfer改成名詞transaction,資源不能是動詞,但是可以是一種服務:

POST /transaction HTTP/1.1
Host: 127.0.0.1
from=1&to=2&amount=500.00
           

另一個設計誤區,就是在URI中加入版本号:

http://www.example.com/app/1.0/foo
http://www.example.com/app/1.1/foo
http://www.example.com/app/2.0/foo
           

因為不同的版本,可以了解成同一種資源的不同表現形式,是以應該采用同一個URI。版本号可以在HTTP請求頭資訊的Accept字段中進行區分(參見Versioning REST Services):

Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0
           

Reference

  • 了解RESTful架構
  • API 設計參考

寫在最後

歡迎大家關注鄙人的公衆号【麥田裡的守望者zhg】,讓我們一起成長,謝謝。

了解restful協定