【DRF版本控制】Python中第三方庫rest_framework的用法
阿新 • • 發佈:2018-12-21
首先,我們開發的專案會有多個版本.
其次,我們的專案版本會隨著更新越來越多,我們不可能因出了新版本就不維護舊版本了.
那麼,我們就需要對版本進行控制——DRF版本控制.
原始碼剖析
DRF檢視中的APIView返回的是View類中的view函式,然後呼叫dispatch
方法.
那麼,我們來看看dispatch
方法都做了些什麼:
執行self.initial
方法之前是各種賦值,包括request的重新封裝賦值.
self.initial
方法中有路由的分發,我們再來看下此方法具體都做了些什麼:
我們可以看到:
version版本資訊賦值給了request.version
.
scheme版本控制方案賦值給了request.versioning_scheme
.
其實合格版本控制方法就是我們配置的版本控制的類.
也就是說,APIView通過這個方法初始化自己提供的元件.
我們接下來看看rest_framework
為我們提供了那些版本控制的方法(在from rest_framework import versioning
檔案內):
如上,rest_framework
為我們提供的所有版本控制的方法.
下面,我們來看看在URL上攜帶版本資訊的用法.
使用內建的URLPathVersioning類
如上圖所有示,URLPathVersioning是在url上攜帶版本資訊的方法.
步驟一
setting.py
REST_FRAMEWORK = { 'DEFAULT_VERSIONING_CLASS'
: 'rest_framework.versioning.URLPathVersioning', # 指定使用的版本控制類 'ALLOWED_VERSIONS': ['v1', 'v2'], # 允許的版本 'VERSION_PARAM': 'version', # 版本使用的引數名稱 'DEFAULT_VERSION': 'v1', # 預設使用的版本 }
步驟二
urls.py
from django.conf.urls import url from blog.views import Test01View # 匯入檢視 urlpatterns =
[ # 如下路徑形式: url(r'^(?P<version>[v1|v2]+)/test01', Test01View.as_view()), ]
步驟三 檢視
from rest_framework.views import APIView from rest_framework.response import Response class Test01View(APIView): def get(self, request, *args, **kwargs): print("版本:", kwargs['version']) print("版本控制資訊:", request.versioning_scheme) if request.version == 'v1': # 處理版本v1的業務邏輯 return Response("這是版本v1的資訊") # 處理版本v2的業務邏輯 return Response("這是版本v2的資訊")
測試效果如下圖:
使用自定義的版本控制類
步驟一 建立自定義版本控制類
class MyVersion(): def determine_version(self, request, *args, **kwargs): # 返回值是版本號 # 獲取前端傳過來的版本號 並且把版本號返回 version = request.query_params.get('version') if not version: # 預設為版本v1,否則都為版本v2 version = 'v1' return version
步驟二
setting.py
REST_FRAMEWORK = { 'DEFAULT_VERSIONING_CLASS': 'utils.version.MyVersion', # 指定自定義的版本控制類 'ALLOWED_VERSIONS': ['v1', 'v2'], # 允許的版本 'VERSION_PARAM': 'version', # 版本使用的引數名稱 'DEFAULT_VERSION': 'v1', # 預設使用的版本 }
步驟三
urls.py
from blog.views import Test02View # 匯入檢視 urlpatterns = [ # 如下路徑格式 url(r'^test02/$', Test02View.as_view()), ]
步驟四 檢視
from rest_framework.views import APIView from rest_framework.response import Response class Test02View(APIView): def get(self, request): print("版本:", request.version) print("版本控制資訊:", request.versioning_scheme) if request.version == 'v2': # 處理版本v2的業務邏輯 return Response("這是版本v2的資訊") # 處理版本v1的業務邏輯 return Response("這是版本v1的資訊")
測試效果如下圖:
is ok.