一，DRF入門規範

2022 年 8 月 24 日
筆記
Django REST framework

一 Web應用模式

在開發Web應用中，有兩種應用模式：

1.1 前後端不分離

1.2 前後端分離

二 API介面

為了在團隊內部形成共識、防止個人習慣差異引起的混亂，我們需要找到一種大家都覺得很好的介面實現規範，而且這種規範能夠讓後端寫的介面，用途一目了然，減少雙方之間的合作成本。

通過網路，規定了前後台資訊交互規則的url鏈接，也就是前後台資訊交互的媒介

Web API介面和一般的url鏈接還是有區別的，Web API介面簡單概括有下面四大特點

url：長得像返回數據的url鏈接
- //api.map.baidu.com/place/v2/search
請求方式：get、post、put、patch、delete
- 採用get方式請求上方介面
請求參數：json或xml格式的key-value類型數據
- ak：6E823f587c95f0148c19993539b99295
- region：上海
- query：肯德基
- output：json

響應結果：json或xml格式的數據

上方請求參數的output參數值決定了響應數據的格式

數據

# xml格式
//api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml
# json格式
//api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json
{
    "status":0,
  	"message":"ok",
    "results":[
        {
            "name":"肯德基(羅餐廳)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月羅路2380號",
            "province":"上海市",
            "city":"上海市",
            "area":"寶山區",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}

三介面測試工具：Postman

Postman是一款介面調試工具，是一款免費的可視化軟體，同時支援各種作業系統平台，是測試介面的首選工具。

解析json的網站//www.json.cn/

Postman可以直接從官網：//www.getpostman.com/downloads/下載獲得，然後進行傻瓜式安裝。

工作面板

簡易的get請求

簡易的post請求

案例：請求百度地圖介面

四 RESTful API規範

REST全稱是Representational State Transfer，中文意思是表述（編者註：通常譯為表徵性狀態轉移）。它首次出現在2000年Roy Fielding的博士論文中。

RESTful是一種定義Web API介面的設計風格，尤其適用於前後端分離的應用模式中。

這種風格的理念認為後端開發任務就是提供數據的，對外提供的是數據資源的訪問介面，所以在定義介面時，客戶端訪問的URL路徑就表示這種要操作的數據資源。

事實上，我們可以使用任何一個框架都可以實現符合restful規範的API介面。

4.1 數據的安全保障

url鏈接一般都採用https協議進行傳輸

註：採用https協議，可以提高數據交互過程中的安全性

4.2 介面特徵表現

用api關鍵字標識介面url：
- //api.baidu.com
- //www.baidu.com/api
註：看到api字眼，就代表該請求url鏈接是完成前後台數據交互的

4.3 多數據版本共存

在url鏈接中標識數據版本
- //api.baidu.com/v1
- //api.baidu.com/v2
註：url鏈接中的v1、v2就是不同數據版本的體現（只有在一種數據資源有多版本情況下）

4.4 數據即是資源，均使用名詞（可複數）

介面一般都是完成前後台數據的交互，交互的數據我們稱之為資源
註：一般提倡用資源的複數形式，在url鏈接中獎勵不要出現操作資源的動詞，錯誤示範：//api.baidu.com/delete-user
特殊的介面可以出現動詞，因為這些介面一般沒有一個明確的資源，或是動詞就是介面的核心含義
- //api.baidu.com/place/search
- //api.baidu.com/login

4.5 資源操作由請求方式決定（method）

操作資源一般都會涉及到增刪改查，我們提供請求方式來標識增刪改查動作
- //api.baidu.com/books - get請求：獲取所有書
- //api.baidu.com/books/1 - get請求：獲取主鍵為1的書
- //api.baidu.com/books - post請求：新增一本書書
- //api.baidu.com/books/1 - put請求：整體修改主鍵為1的書
- //api.baidu.com/books/1 - patch請求：局部修改主鍵為1的書
- //api.baidu.com/books/1 - delete請求：刪除主鍵為1的書

4.6 過濾，通過在url上傳參的形式傳遞搜索條件

4.7 響應狀態碼

4.7.1 正常響應

響應狀態碼2xx
- 200：常規請求
- 201：創建成功

4.7.2 重定向響應

響應狀態碼3xx
- 301：永久重定向
- 302：暫時重定向

4.7.3 客戶端異常

響應狀態碼4xx
- 403：請求無許可權
- 404：請求路徑不存在
- 405：請求方法不存在

4.7.4 伺服器異常

響應狀態碼5xx
- 500：伺服器異常

4.8 錯誤處理，應返回錯誤資訊，error當做key

{
    error: "無許可權操作"
}

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

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

4.10 需要url請求的資源需要訪問資源的請求鏈接

# Hypermedia API，RESTful API最好做到Hypermedia，即返回結果中提供鏈接，連向其他API方法，使得用戶不查文檔，也知道下一步應該做什麼
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(羅餐廳)",
            "img": "//image.baidu.com/kfc/001.png"
        }
      	...
		]
}

比較好的介面返回

# 響應數據要有狀態碼、狀態資訊以及數據本身
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(羅餐廳)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月羅路2380號",
            "province":"上海市",
            "city":"上海市",
            "area":"寶山區",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}

四序列化

api介面開發，最核心最常見的一個過程就是序列化，所謂序列化就是把數據轉換格式，序列化可以分兩個階段：

序列化：把我們識別的數據轉換成指定的格式提供給別人。

例如：我們在django中獲取到的數據默認是模型對象，但是模型對象數據無法直接提供給前端或別的平台使用，所以我們需要把數據進行序列化，變成字元串或者json數據，提供給別人。

反序列化：把別人提供的數據轉換/還原成我們需要的格式。

例如：前端js提供過來的json數據，對於python而言就是字元串，我們需要進行反序列化換成模型類對象，這樣我們才能把數據保存到資料庫中。

五 Django Rest_Framework

核心思想: 縮減編寫api介面的程式碼

Django REST framework是一個建立在Django基礎之上的Web 應用開發框架，可以快速的開發REST API介面應用。在REST framework中，提供了序列化器Serialzier的定義，可以幫助我們簡化序列化與反序列化的過程，不僅如此，還提供豐富的類視圖、擴展類、視圖集來簡化視圖的編寫工作。REST framework還提供了認證、許可權、限流、過濾、分頁、介面文檔等功能支援。REST framework提供了一個API 的Web可視化介面來方便查看測試介面。

官方文檔：//www.django-rest-framework.org/

github: //github.com/encode/django-rest-framework/tree/master

特點

提供了定義序列化器Serializer的方法，可以快速根據 Django ORM 或者其它庫自動序列化/反序列化；
提供了豐富的類視圖、Mixin擴展類，簡化視圖的編寫；
豐富的訂製層級：函數視圖、類視圖、視圖集合到自動生成 API，滿足各種需要；
多種身份認證和許可權認證方式的支援；[jwt]
內置了限流系統；
直觀的 API web 介面；
可擴展性，插件豐富

六環境安裝與配置

DRF是以Django擴展應用的方式提供的，所以我們可以直接利用已有的Django環境而無需重新創建。（若沒有Django環境，需要先創建環境安裝Django）

6.1 安裝DRF

前提是已經安裝了django，建議安裝在虛擬環境

# mkvirtualenv drfdemo -p python3
# pip install django

pip install djangorestframework
pip install pymysql

6.1.1 創建django項目

cd ~/Desktop
django-admin startproject drfdemo

6.2 添加rest_framework應用

在settings.py的INSTALLED_APPS中添加'rest_framework'。

INSTALLED_APPS = [
    ...
    'rest_framework',
]

接下來就可以使用DRF提供的功能進行api介面開發了。在項目中如果使用rest_framework框架實現API介面，主要有以下三個步驟：

將請求的數據（如JSON格式）轉換為模型類對象
操作資料庫
將模型類對象轉換為響應的數據（如JSON格式）

接下來，我們快速體驗下使用drf以後的程式碼。程式碼不需要理解，看步驟。

6.3 體驗drf完全簡寫程式碼的過程（了解）

6.3.1. 創建模型操作類

class Student(models.Model):
    # 模型欄位
    name = models.CharField(max_length=100,verbose_name="姓名")
    sex = models.BooleanField(default=1,verbose_name="性別")
    age = models.IntegerField(verbose_name="年齡")
    class_null = models.CharField(max_length=5,verbose_name="班級編號")
    description = models.TextField(max_length=1000,verbose_name="個性簽名")

    class Meta:
        db_table="tb_student"
        verbose_name = "學生"
        verbose_name_plural = verbose_name

為了方便測試，所以我們可以先創建一個資料庫。

create database students charset=utf8;

6.3.1.1 執行數據遷移

把students子應用添加到INSTALL_APPS中

初始化資料庫連接

安裝pymysql
pip install pymysql

主引用中__init__.py設置使用pymysql作為資料庫驅動

import pymysql

pymysql.install_as_MySQLdb()

settings.py配置文件中設置mysql的帳號密碼

DATABASES = {
    # 'default': {
    #     'ENGINE': 'django.db.backends.sqlite3',
    #     'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    # },
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': "students",
        "HOST": "127.0.0.1",
        "PORT": 3306,
        "USER": "root",
        "PASSWORD":"123",
    },
}

終端下，執行數據遷移。

python manage.py makemigrations
python manage.py migrate

錯誤列表

# 執行數據遷移 python manage.py makemigrations 報錯如下：

解決方案：

注釋掉 backends/mysql/base.py中的35和36行程式碼。

# 執行數據遷移發生以下錯誤：

解決方法：

backends/mysql/operations.py146行裡面新增一個行程式碼：

6.3.2. 創建序列化器

例如，在django項目中創建學生子應用。

python manage.py startapp students

在syudents應用目錄中新建serializers.py用於保存該應用的序列化器。

創建一個StudentModelSerializer用於序列化與反序列化。

# 創建序列化器類，回頭會在試圖中被調用
class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Student
        fields = "__all__"

model 指明該序列化器處理的數據欄位從模型類BookInfo參考生成
fields 指明該序列化器包含模型類中的哪些欄位，'all'指明包含所有欄位

6.3.3. 編寫視圖

在students應用的views.py中創建視圖StudentViewSet，這是一個視圖集合。

from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer
# Create your views here.
class StudentViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

queryset 指明該視圖集在查詢數據時使用的查詢集
serializer_class 指明該視圖在進行序列化或反序列化時使用的序列化器

6.3.4. 定義路由

在students應用的urls.py中定義路由資訊。

from . import views
from rest_framework.routers import DefaultRouter

# 路由列表
urlpatterns = []

router = DefaultRouter()  # 可以處理視圖的路由器
router.register('students', views.StudentViewSet)  # 向路由器中註冊視圖集

urlpatterns += router.urls  # 將路由器中的路由資訊追到到django的路由列表中

最後把students子應用中的路由文件載入到總路由文件中.

from django.contrib import admin
from django.urls import path,include

urlpatterns = [
    path('admin/', admin.site.urls),
    path("stu/",include("students.urls")),
]

6.3.5. 運行測試

運行當前程式（與運行Django一樣）

python manage.py runserver

在瀏覽器中輸入網址127.0.0.1:8000，可以看到DRF提供的API Web瀏覽頁面：

1）點擊鏈接127.0.0.1:8000/stu/students 可以訪問獲取所有數據的介面，呈現如下頁面：

2）在頁面底下表單部分填寫學生資訊，可以訪問添加新學生的介面，保存學生資訊：

點擊POST後，返回如下頁面資訊：

3）在瀏覽器中輸入網址127.0.0.1:8000/stu/students/5/，可以訪問獲取單一學生資訊的介面（id為5的學生），呈現如下頁面：

4）在頁面底部表單中填寫學生資訊，可以訪問修改學生的介面：

點擊PUT，返回如下頁面資訊：

5）點擊DELETE按鈕，可以訪問刪除學生的介面：

返回，如下頁面：

七 CBV源碼分析

# 視圖層
from django.shortcuts import render, HttpResponse
from django.views import View
class CBVTest(View):
    # 通過調度(dispatch)分發請求
    def dispatch(self, request, *args, **kwargs):
        pass
        super().dispatch(request, *args, **kwargs)
        pass

    def get(self, request):
        return render(request, 'cbv.html')

    def post(self, request):
        return HttpResponse('cbv post method')

<!-- 模板層 -->
<form action="/cbv/" method="post">
    {% csrf_token %}
    <input type="text" name="usr">
    <button type="submit">提交</button>
</form>

# 路由層
from app import views
urlpatterns = [
    url(r'^cbv/', views.CBVTest.as_view()),
]

八 drf基本使用及request源碼分析

8.1 APIView的使用

# 1）安裝drf：pip3 install djangorestframework
# 2）settings.py註冊app：INSTALLED_APPS = [..., 'rest_framework']
# 3）基於cbv完成滿足RSSTful規範的介面

# 視圖層
from rest_framework.views import APIView
from rest_framework.response import Response
user_list = [{'id': 1, 'name': 'Bob'}, {'id': 2, 'name': 'Tom'}]
class Users(APIView):
    def get(self, request, *args, **kwargs):
        return Response({
            'status': 0,
            'msg': 'ok',
            'results': user_list
        })
    def post(self, request, *args, **kwargs):
        # request對formdata，urlencoded，json三個格式參數均能解析
        name = request.data.get('name')
        id = len(user_list) + 1
        user = {'id': id, 'name': name}
        user_list.append(user)
        return Response({
            'status': '0',
            'msg': 'ok',
            'results': user
        })

# 路由層
from app import views
urlpatterns = [
    url(r'^users/', views.Users.as_view()),
]

8.2 APIView和Request對象源碼分析

8.2.1 APIView

# as_view()
	# 核心走了父類as_view
	view = super(APIView, cls).as_view(**initkwargs)
    # 返回的是局部禁用csrf認證的view視圖函數
    return csrf_exempt(view)
    
# dispatch(self, request, *args, **kwargs)
	# 二次封裝request對象
	request = self.initialize_request(request, *args, **kwargs)
    # 自定義request規則
    self.initial(request, *args, **kwargs)
    
# initialize_request(self, request, *args, **kwargs)
	# 原生request封裝在request._request
    
# initial(self, request, *args, **kwargs)
    def initial(self, request, *args, **kwargs):
        # 認證組件：校驗用戶 - 遊客、合法用戶、非法用戶
        # 遊客：代表校驗通過，直接進入下一步校驗（許可權校驗）
        # 合法用戶：代表校驗通過，將用戶存儲在request.user中，再進入下一步校驗（許可權校驗）
        # 非法用戶：代表校驗失敗，拋出異常，返回403許可權異常結果
        self.perform_authentication(request)
        # 許可權組件：校驗用戶許可權 - 必須登錄、所有用戶、登錄讀寫遊客只讀、自定義用戶角色
        # 認證通過：可以進入下一步校驗（頻率認證）
        # 認證失敗：拋出異常，返回403許可權異常結果
        self.check_permissions(request)
        # 頻率組件：限制視圖介面被訪問的頻率次數 - 限制的條件(IP、id、唯一鍵)、頻率周期時間(s、m、h)、頻率的次數（3/s）
        # 沒有達到限次：正常訪問介面
        # 達到限次：限制時間內不能訪問，限制時間達到後，可以重新訪問
        self.check_throttles(request)

8.2.2 Request對象

from rest_framework.request import Request
# 只要繼承了APIView，視圖類中的request對象，都是新的，也就是上面那個request的對象了
# 老的request在新的request._request
# 以後使用reqeust對象，就像使用之前的request是一模一樣（因為重寫了__getattr__方法）
  def __getattr__(self, attr):
        try:
            return getattr(self._request, attr) # 通過反射，取原生的request對象，取出屬性或方法
        except AttributeError:
            return self.__getattribute__(attr)

 # request.data 感覺是個數據屬性，其實是個方法，@property，修飾了
	它是一個字典，post請求不管使用什麼編碼，傳過來的數據，都在request.data
 #get請求傳過來數據，從哪取？
	request.GET
    @property
    def query_params(self):
        """
        More semantically correct name for request.GET.
        """
        return self._request.GET
    
     # 視圖類中
     print(request.query_params)  #get請求，地址中的參數
     # 原來在
     print(request.GET)

補充：局部禁用csrf

# 在視圖函數上加裝飾器@csrf_exempt
# csrf_exempt(view)這麼寫和在視圖函數上加裝飾器是一摸一樣的
# urls.py中看到這種寫法
path('test/', csrf_exempt(views.test))

Tags: Django REST framework