如何實現(xiàn)Django Rest framework版本控制

更新時間：2019年07月25日 15:56:49 作者：Title

這篇文章主要介紹了如何實現(xiàn)Django Rest framework版本控制,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下

前言

首先，我們開發(fā)的項目會有多個版本.

其次，我們的項目版本會隨著更新越來越多，我們不可能因出了新版本就不維護舊版本了.

那么，我們就需要對版本進行控制——DRF版本控制.

源碼剖析

DRF視圖中的APIView返回的是View類中的view函數(shù)，然后調(diào)用dispatch方法.

那么，我們來看看dispatch方法都做了些什么：

執(zhí)行self.initial方法之前是各種賦值，包括request的重新封裝賦值.

self.initial方法中有路由的分發(fā)，我們再來看下此方法具體都做了些什么：

我們可以看到：

==version版本信息賦值給了request.version.==

==scheme版本控制方案賦值給了request.versioning_scheme.==

其實這個版本控制方法就是我們配置的版本控制的類.

也就是說，APIView通過這個方法初始化自己提供的組件.

我們接下來看看rest_framework為我們提供了那些版本控制的方法(在from rest_framework import versioning文件內(nèi))：

如上，rest_framework為我們提供的所有版本控制的方法.

下面，我們來看看在URL上攜帶版本信息的用法.

使用內(nèi)置的URLPathVersioning類

如上圖所有示，URLPathVersioning是在url上攜帶版本信息的方法.

步驟一 setting.py

REST_FRAMEWORK = {
  'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.URLPathVersioning', # 指定使用的版本控制類
  'ALLOWED_VERSIONS': ['v1', 'v2'], # 允許的版本
  'VERSION_PARAM': 'version', # 版本使用的參數(shù)名稱
  'DEFAULT_VERSION': 'v1', # 默認使用的版本
}

步驟二 urls.py

from django.conf.urls import url
from blog.views import Test01View # 導(dǎo)入視圖

urlpatterns = [
  # 如下路徑形式：
  url(r'^(?P<version>[v1|v2]+)/test01', Test01View.as_view()),
]

步驟三 views.py

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的業(yè)務(wù)邏輯
      return Response("這是版本v1的信息")
    # 處理版本v2的業(yè)務(wù)邏輯
    return Response("這是版本v2的信息")

測試效果如下圖：

使用自定義的版本控制類

步驟一創(chuàng)建自定義版本控制類

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', # 版本使用的參數(shù)名稱
  'DEFAULT_VERSION': 'v1', # 默認使用的版本
}

步驟三 urls.py

from blog.views import Test02View # 導(dǎo)入視圖

urlpatterns = [
  # 如下路徑格式
  url(r'^test02/$', Test02View.as_view()),
]

步驟四 views.py

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的業(yè)務(wù)邏輯
      return Response("這是版本v2的信息")
    # 處理版本v1的業(yè)務(wù)邏輯
    return Response("這是版本v1的信息")

測試效果如下圖：