四十五、python學習之Djnago(DRF框架一):介紹及環境搭建

阿新 • • 發佈：2018-12-22

引入DjangoRESTframework

一、Web應用模式:

在開發Web應用中,有兩種應用模式:

前後端不分離
前後端分離

1.前後端不分離:

在這裡插入圖片描述
在前後端不分離的應用模式中,前端頁面看到的效果都是有後端控制的,有後端渲染頁面重定向,也就是後端需要控制前端的展示,前後端的耦合度很高.
這種應用模式比較適合純網頁應用,但是當後端對接App時,App可能並不需要後端返回一個html頁面,而僅僅是資料本身,所以你後端原本返回頁面的介面不再適合前端的App應用,為了對接App後端好需要開發一套介面.

2.前後端分離:

在這裡插入圖片描述
在前後端分離的應用模式中,後端僅返回前端所需要的資料,不再渲染html頁面,不再控制前端效果. 至於前端使用者看到什麼效果,從後端請求的資料如何載入到前端中,都由自己決定,網頁有網頁的處理方式,App有App的處理方式,但無論那種前端,所需要的資料基本相同,後端僅需要開發一套邏輯對外提供資料即可.
在前後端分離的應用模式中,前端和後端的耦合度相對較低.
在前後端分離的應用模式中,我們通常將後端開發的每一個檢視都成為一個***介面***,或者***API***,前端通過訪問介面來對資料就你增刪改查.

二、認識ERSTful風格:

在前後端分離的應用模式中,後端API介面如何定義

例如對於後端資料庫中儲存了商品的資訊,前端可能需要對商品資料進行增刪改查,那相應的每個操作後端都需要提供一個API介面:

1.POST/ add-goods : 增加商品
2.POST /delete-goods : 刪除商品
3.POST /update-goods : 修改商品
1. GET /get-goods : 查詢商品資訊
  對於介面的請求方式與路徑,每個後端開發人員可能都有自己的定義方式，風格迥異。
  是否存在一種統一的定義方式，被廣大開發人員接受認可的方式呢？
  這就是被普遍採用的API的RESTful設計風格。

二、RESTful設計風格:

1. 域名:

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

如果確定API很簡單, 不會有進一步擴充套件,可以考慮放在主域名下.

2.版本(versioning)

應該將API的版本號放在URL中:

另一種做法是, 將版本號放在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)

3.1 資源作為網址,只能有名詞,不能有動詞,而且所有的名詞往往與資料庫的表名對應.

舉例來說，以下是不好的例子:

/getProducts
/listOrders
/retreiveClientByOrder?orderId=1

對於一個簡潔結構，你應該始終用名詞。此外，利用的HTTP方法可以分離網址中的資源名稱的操作。

GET /products ：將返回所有產品清單
POST /products ：將產品新建到集合
GET /products/4 ：將獲取產品 4
PATCH（或）PUT /products/4 ：將更新產品 4

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.狀態碼:

伺服器向用戶返回的狀態碼和提示資訊，常見的有以下一些（方括號中是該狀態碼對應的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.返回結果:

針對不同操作，伺服器向用戶返回的結果應該符合以下規範。

GET /collection：返回資源物件的列表（陣列）
GET /collection/resource：返回單個資源物件
POST /collection：返回新生成的資源物件
PUT /collection/resource：返回完整的資源物件
PATCH /collection/resource：返回完整的資源物件
DELETE /collection/resource：返回一個空文件

9.其他:

伺服器返回的資料格式,應該儘量使用JSON, 避免使用XML

三、使用Djnago開發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）獲取所有圖書資料

[
    {
        "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）獲取單一圖書資料

{
    "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介面開發的核心任務:

1. 明確REST介面開發的核心任務:

在開發REST API介面時,檢視中做的最主要的三件事:

將請求的資料(json資料)轉換為模型類物件
操作資料庫
將模型類物件轉化為相應資料(json格式)

2. 序列化(Serialization)與反序列化(Deserialize):

將程式中的一個數據結構型別轉換為其他格式(字典、JSON、XML等), 例如將Django中模型類物件轉換為JSON字串,這個轉換過程我們稱為序列化

例如:

queryset = BookInfo.objects.all()
book_list = []
# 序列化
for book in queryset:
book_list.appemd({
	'id':book.id,
	'btitle': book.btitle,
	'bpub_date': book.bpub_date,
    'bread': book.bread,
     'bcomment': book.bcomment
})
return JsonResponse(book_list, safe = False)

反之,將其他格式(字典、JSON、XML等)轉換為程式中的資料, 例如將JSON字串轉化成Django中的模型類物件,這個過程我們稱為是反序列化。
如:

json_bytes = request.body
json_str = json_btyes.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時, 檢視中要頻繁的進行序列化與反序列化的編寫.

2. 總結:

在開發REST API介面時, 我們在檢視中需要做的最核心的事情是:

將資料庫資料序列化為前端鎖足要的格式,並返回
將前端傳送的資料反序列化為模型類物件,並儲存到資料庫中

三、Django REST framework 簡介:

在序列化與反序列化時，雖然操作的資料不盡相同，但是執行的過程卻是相似的，也就是說這部分程式碼是可以複用簡化編寫的。
在開發REST API的檢視中，雖然每個檢視具體操作的資料不同，但增、刪、改、查的實現流程基本套路化，所以這部分程式碼也是可以複用簡化編寫的：
- 增：校驗請求資料 -> 執行反序列化過程 -> 儲存資料庫 -> 將儲存的物件序列化並返回
- 刪：判斷要刪除的資料是否存在 -> 執行資料庫刪除
- 改：判斷要修改的資料是否存在 -> 校驗請求的資料 -> 執行反序列化過程 -> 儲存資料庫 -> 將儲存的物件序列化並返回
- 查：查詢資料庫 -> 將資料序列化並返回
  *** Django REST framework可以幫助我們簡化上述兩部分程式碼的編寫大大提高REST API 的開大速度 ***

1.認識Django REST framework:

在這裡插入圖片描述
Django REST framework框架是一個用於構建Web API的強大而又靈活的工具. 通常簡稱為DRF框架或 REST framework框架.

*** 特點 ***

提供了定義序列化器serializer的方法,可以快速根據Django ORM或者其他庫自動序列化/反序列化;
提供了豐富的類檢視、Mixin擴充套件類、簡化檢視的編寫;
豐富的定製層級: 函式檢視、類檢視、檢視集合到自動生成API,滿足各種需求;
多中身份認證和許可權認證方式的支援;
內建了限流系統;
直觀的API web介面;
可擴充套件性, 外掛豐富

*** 資料 ***

環境安裝與配置

DRF框架需要以下依賴:

Python(2.1、3.2~6)
Django(1.10、1.11、1.20)

1.安裝:

pip install djajngorestframework

2. 新增rest_framework應用:

我們利用在Django框架學習中建立的demo工程，在settings.py的INSTALLED_APPS中新增’rest_framework’。

INSTALLED_APPS = [
    ...
    'rest_framework',
]

接下來就可以使用DRF進行開發了。