Spring Cloud Config配置中心
Web應用模式
在開發Web應用中，有兩種應用模式：
- 前後端不分離
- 前後端分
1 前後端不分離
在前後端不分離的應用模式中，前端頁面看到的效果都是由後端控制，由後端渲染頁面或重定向，也就是後端需要控制前端的展示，前端與後端的耦合度很高。
這種應用模式比較適合純網頁應用，但是當後端對接App時，App可能並不需要後端返回一個HTML網頁，而僅僅是資料本身，所以後端原本返回網頁的介面不再適用於前端App應用，為了對接App後端還需再開發一套介面。
2 前後端分離
在前後端分離的應用模式中，後端僅返回前端所需的資料，不再渲染HTML頁面，不再控制前端的效果。至於前端使用者看到什麼效果，從後端請求的資料如何載入到前端中，都由前端自己決定，網頁有網頁的處理方式，App有App的處理方式，但無論哪種前端，所需的資料基本相同，後端僅需開發一套邏輯對外提供資料即可。
在前後端分離的應用模式中 ，前端與後端的耦合度相對較低。
在前後端分離的應用模式中，我們通常將後端開發的每個檢視都稱為一個介面，或者API，前端通過訪問介面來對資料進行增刪改查。
RESTful設計方法
1. 域名
應該儘量將API部署在專用域名之下。
https://api.example.com
如果確定API很簡單，不會有進一步擴充套件，可以考慮放在主域名下。
https://example.org/api/
2. 版本（Versioning）
應該將API的版本號放入URL。
http://www.example.com/app/1.0/foo http://www.example.com/app/1.1/foohttp://www.example.com/app/2.0/foo
另一種做法是，將版本號放在HTTP頭資訊中，但不如放入URL方便和直觀。Github採用這種做法。
因為不同的版本，可以理解成同一種資源的不同表現形式，所以應該採用同一個URL。版本號可以在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
3. 路徑（Endpoint）
路徑又稱"終點"（endpoint），表示API的具體網址，每個網址代表一種資源（resource）
(1) 資源作為網址，只能有名詞，不能有動詞，而且所用的名詞往往與資料庫的表名對應。
舉例來說，以下是不好的例子:
/getProducts /listOrders /retreiveClientByOrder?orderId=1
對於一個簡潔結構，你應該始終用名詞。 此外，利用的HTTP方法可以分離網址中的資源名稱的操作。
GET /products ：將返回所有產品清單 POST /products ：將產品新建到集合 GET /products/4 ：將獲取產品 4 PATCH（或）PUT /products/4 ：將更新產品 4
(2) API中的名詞應該使用複數。無論子資源或者所有資源。
舉例來說，獲取產品的API可以這樣定義
獲取單個產品：http://127.0.0.1:8080/AppName/rest/products/1 獲取所有產品: http://127.0.0.1:8080/AppName/rest/products
3. HTTP動詞
對於資源的具體操作型別，由HTTP動詞表示。
常用的HTTP動詞有下面四個（括號裡是對應的SQL命令）。
- GET（SELECT）：從伺服器取出資源（一項或多項）。
- POST（CREATE）：在伺服器新建一個資源。
- PUT（UPDATE）：在伺服器更新資源（客戶端提供改變後的完整資源）。
- DELETE（DELETE）：從伺服器刪除資源。
還有三個不常用的HTTP動詞。
- PATCH（UPDATE）：在伺服器更新(更新)資源（客戶端提供改變的屬性）。
- 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：刪除某個指定動物園的指定動物
4. 過濾資訊（Filtering）
如果記錄數量很多，伺服器不可能都將它們返回給使用者。API應該提供引數，過濾返回結果。
下面是一些常見的引數。
?limit=10：指定返回記錄的數量 ?offset=10：指定返回記錄的開始位置。 ?page=2&per_page=100：指定第幾頁，以及每頁的記錄數。 ?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序。 ?animal_type_id=1：指定篩選條件
引數的設計允許存在冗餘，即允許API路徑和URL引數偶爾有重複。比如，GET /zoos/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。
6. 狀態碼（Status Codes）
伺服器向用戶返回的狀態碼和提示資訊，常見的有以下一些（方括號中是該狀態碼對應的HTTP動詞）。
- 200 OK - [GET]：伺服器成功返回使用者請求的資料
- 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 - [*]：伺服器發生錯誤，使用者將無法判斷髮出的請求是否成功。
7. 錯誤處理（Error handling）
如果狀態碼是4xx，伺服器就應該向使用者返回出錯資訊。一般來說，返回的資訊中將error作為鍵名，出錯資訊作為鍵值即可。
{ error: "Invalid API key" }
8. 返回結果
針對不同操作，伺服器向用戶返回的結果應該符合以下規範。
9. 其他
GET /collection：返回資源物件的列表（陣列） GET /collection/resource：返回單個資源物件 POST /collection：返回新生成的資源物件 PUT /collection/resource：返回完整的資源物件 PATCH /collection/resource：返回完整的資源物件 DELETE /collection/resource：返回一個空文件
伺服器返回的資料格式，應該儘量使用JSON，避免使用XML。
使用Django開發REST 介面
我們以在Django框架中使用的圖書英雄案例來寫一套支援圖書資料增刪改查的REST API介面，來理解REST API的開發。
在此案例中，前後端均傳送JSON格式資料。
測試
# views.py from datetime import datetime class BooksAPIVIew(View): """ 查詢所有圖書、增加圖書 """ def get(self, request): """ 查詢所有圖書 路由：GET /books/ """ queryset = BookInfo.objects.all() book_list = [] for book in queryset: book_list.append({ 'id': book.id, 'btitle': book.btitle, 'bpub_date': book.bpub_date, 'bread': book.bread, 'bcomment': book.bcomment, 'image': book.image.url if book.image else '' }) return JsonResponse(book_list, safe=False) def post(self, request): """ 新增圖書 路由：POST /books/ """ json_bytes = request.body json_str = json_bytes.decode() book_dict = json.loads(json_str) # 此處詳細的校驗引數省略 book = BookInfo.objects.create( btitle=book_dict.get('btitle'), bpub_date=datetime.strptime(book_dict.get('bpub_date'), '%Y-%m-%d').date() ) return JsonResponse({ 'id': book.id, 'btitle': book.btitle, 'bpub_date': book.bpub_date, 'bread': book.bread, 'bcomment': book.bcomment, 'image': book.image.url if book.image else '' }, status=201) class BookAPIView(View): def get(self, request, pk): """ 獲取單個圖書資訊 路由： GET /books/<pk>/ """ try: book = BookInfo.objects.get(pk=pk) except BookInfo.DoesNotExist: return HttpResponse(status=404) return JsonResponse({ 'id': book.id, 'btitle': book.btitle, 'bpub_date': book.bpub_date, 'bread': book.bread, 'bcomment': book.bcomment, 'image': book.image.url if book.image else '' }) def put(self, request, pk): """ 修改圖書資訊 路由： PUT /books/<pk> """ try: book = BookInfo.objects.get(pk=pk) except BookInfo.DoesNotExist: return HttpResponse(status=404) json_bytes = request.body json_str = json_bytes.decode() book_dict = json.loads(json_str) # 此處詳細的校驗引數省略 book.btitle = book_dict.get('btitle') book.bpub_date = datetime.strptime(book_dict.get('bpub_date'), '%Y-%m-%d').date() book.save() return JsonResponse({ 'id': book.id, 'btitle': book.btitle, 'bpub_date': book.bpub_date, 'bread': book.bread, 'bcomment': book.bcomment, 'image': book.image.url if book.image else '' }) def delete(self, request, pk): """ 刪除圖書 路由： DELETE /books/<pk>/ """ try: book = BookInfo.objects.get(pk=pk) except BookInfo.DoesNotExist: return HttpResponse(status=404) book.delete() return HttpResponse(status=204) # urls.py urlpatterns = [ url(r'^books/$', views.BooksAPIVIew.as_view()), url(r'^books/(?P<pk>\d+)/$', views.BookAPIView.as_view()) ]
使用Postman測試上述介面
1） 獲取所有圖書資料
GET 方式訪問http://127.0.0.1:8000/books/，返回狀態碼200，資料如下
[ { "id": 1, "btitle": "射鵰英雄傳", "bpub_date": "1980-05-01", "bread": 12, "bcomment": 34, "image": "" }, { "id": 2, "btitle": "天龍八部", "bpub_date": "1986-07-24", "bread": 36, "bcomment": 40, "image": "" }, { "id": 3, "btitle": "笑傲江湖", "bpub_date": "1995-12-24", "bread": 20, "bcomment": 80, "image": "" }, { "id": 4, "btitle": "雪山飛狐", "bpub_date": "1987-11-11", "bread": 58, "bcomment": 24, "image": "" }, { "id": 5, "btitle": "西遊記", "bpub_date": "1988-01-01", "bread": 10, "bcomment": 10, "image": "booktest/xiyouji.png" }, { "id": 6, "btitle": "水滸傳", "bpub_date": "1992-01-01", "bread": 10, "bcomment": 11, "image": "" }, { "id": 7, "btitle": "紅樓夢", "bpub_date": "1990-01-01", "bread": 0, "bcomment": 0, "image": "" } ]
2）獲取單一圖書資料
GET 訪問http://127.0.0.1:8000/books/5/，返回狀態碼200， 資料如下
{ "id": 5, "btitle": "西遊記", "bpub_date": "1988-01-01", "bread": 10, "bcomment": 10, "image": "booktest/xiyouji.png" }
GET 訪問http://127.0.0.1:8000/books/100/，返回狀態碼404
3）新增圖書資料
POST 訪問http://127.0.0.1:8000/books/，傳送JSON資料：
{ "btitle": "三國演義", "bpub_date": "1990-02-03" }
返回狀態碼201，資料如下
{ "id": 8, "btitle": "三國演義", "bpub_date": "1990-02-03", "bread": 0, "bcomment": 0, "image": "" }
4）修改圖書資料
PUT 訪問http://127.0.0.1:8000/books/8/，傳送JSON資料：
{ "btitle": "三國演義（第二版）", "bpub_date": "1990-02-03" }
返回狀態碼200，資料如下
{ "id": 8, "btitle": "三國演義（第二版）", "bpub_date": "1990-02-03", "bread": 0, "bcomment": 0, "image": "" }
5）刪除圖書資料
DELETE 訪問http://127.0.0.1:8000/books/8/，返回204狀態碼
明確REST介面開發的核心任務
分析一下上節的案例，可以發現，在開發REST API介面時，檢視中做的最主要有三件事：
- 將請求的資料（如JSON格式）轉換為模型類物件
- 操作資料庫
- 將模型類物件轉換為響應的資料（如JSON格式）
序列化Serialization
維基百科中對於序列化的定義：
序列化（serialization）在電腦科學的資料處理中，是指將資料結構或物件狀態轉換成可取用格式（例如存成檔案，存於緩衝，或經由網路中傳送），以留待後續在相同或另一臺計算機環境中，能恢復原先狀態的過程。依照序列化格式重新獲取位元組的結果時，可以利用它來產生與原始物件相同語義的副本。對於許多物件，像是使用大量參照的複雜物件，這種序列化重建的過程並不容易。面向物件中的物件序列化，並不概括之前原始物件所關聯的函式。這種過程也稱為物件編組（marshalling）。從一系列位元組提取資料結構的反向操作，是反序列化（也稱為解編組, deserialization, unmarshalling）。
序列化在電腦科學中通常有以下定義:
在資料儲存與傳送的部分是指將一個物件)儲存至一個儲存媒介，例如檔案或是記億體緩衝等，或者透過網路傳送資料時進行編碼的過程，可以是位元組或是XML等格式。而位元組的或XML編碼格式可以還原完全相等的物件)。這程式被應用在不同應用程式之間傳送物件)，以及伺服器將物件)儲存到檔案或資料庫。相反的過程又稱為反序列化。
簡而言之，我們可以將序列化理解為：
將程式中的一個數據結構型別轉換為其他格式（字典、JSON、XML等），例如將Django中的模型類物件裝換為JSON字串，這個轉換過程我們稱為序列化。
如：
queryset = BookInfo.objects.all() book_list = [] # 序列化 for book in queryset: book_list.append({ 'id': book.id, 'btitle': book.btitle, 'bpub_date': book.bpub_date, 'bread': book.bread, 'bcomment': book.bcomment, 'image': book.image.url if book.image else '' }) return JsonResponse(book_list, safe=False)
反之，將其他格式（字典、JSON、XML等）轉換為程式中的資料，例如將JSON字串轉換為Django中的模型類物件，這個過程我們稱為反序列化。
如：
json_bytes = request.body json_str = json_bytes.decode() # 反序列化 book_dict = json.loads(json_str) book = BookInfo.objects.create( btitle=book_dict.get('btitle'), bpub_date=datetime.strptime(book_dict.get('bpub_date'), '%Y-%m-%d').date() )
我們可以看到，在開發REST API時，檢視中要頻繁的進行序列化與反序列化的編寫。
總結
在開發REST API介面時，我們在檢視中需要做的最核心的事是：
-
將資料庫資料序列化為前端所需要的格式，並返回；
-
將前端傳送的資料反序列化為模型類物件，並儲存到資料庫中。