Django 之 restframework 版本控制的使用以及源码分析

Django rest_framework 之 版本控制

一、何为版本控制：

​ 用于版本的控制

二、内置的版本控制类：

from rest_framework.versioning import QueryParameterVersioning,AcceptHeaderVersioning,NamespaceVersioning,URLPathVersioning

#基于url的get传参方式：QueryParameterVersioning------>如：/users?version=v1
#基于url的正则方式：URLPathVersioning------>/v1/users/
#基于 accept 请求头方式：AcceptHeaderVersioning------>Accept: application/json; version=1.0
#基于主机名方法：HostNameVersioning------>v1.example.com
#基于django路由系统的namespace：NamespaceVersioning------>example.com/v1/users/

三、局部使用

• 先导入模块

  from rest_framework.versioning import QueryParameterVersioning,AcceptHeaderVersioning,NamespaceVersioning,URLPathVersioning
  

• 在视图类中写入配置

  #在CBV类中加入
  versioning_class = URLPathVersioning  # 基于url的正则方式：URLPathVersioning--->/v1/users/
  

• 在settings.py 中配置 REST_FRAMEWORK

  REST_FRAMEWORK = {
      'DEFAULT_VERSION': 'v1',            # 默认版本(从request对象里取不到，显示的默认值)
      'ALLOWED_VERSIONS': ['v1', 'v2'],   # 允许的版本
      'VERSION_PARAM': 'version'          # URL中获取值的key
  }
  

四、全局使用（一般都是全局配置）

REST_FRAMEWORK = {
    'DEFAULT_VERSIONING_CLASS':'rest_framework.versioning.QueryParameterVersioning',# 全局配置
    'DEFAULT_VERSION': 'v1',            # 默认版本(从request对象里取不到，显示的默认值)
    'ALLOWED_VERSIONS': ['v1', 'v2'],   # 允许的版本
    'VERSION_PARAM': 'version'          # URL中获取值的key
}

五、示例

urls.py

from django.conf.urls import url, include
from django.contrib import admin
from app01 import views
from rest_framework import routers  # 路由控制器

# 生成一个路由控制类的对象
router = routers.DefaultRouter()
# router=routers.SimpleRouter()
# 调用对象的register 方法，传入两个参数 ，第一个匹配的路由，视图中写的cbv类
router.register('books', views.BooksView)
# 带版本号的自动配置路由方法
urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'(?P<version>[v1|v2]+)/', include(router.urls))
]

serializers.py(序列化模型类)

class BookSerializer(ModelSerializer):
    class Meta:
        # 指定模型表
        model = models.Book
        # 指定需要序列化的字段
        fields = "__all__"
        # depth = 1  # 控制跨表深度

views.py

from rest_framework.versioning import URLPathVersioning
from rest_framework.response import Response

class BooksView(ModelViewSet):
    # 局部使用 版本控制  URLPathVersioning
    versioning_class = URLPathVersioning
    queryset = models.Book.objects.all()
    serializer_class = myser.BookSerializer
    
    def list(self,request,*args,**kwargs):
        print(1)
        print(request.version)  # 获取版本号
        
        return super().list(request,*args,**kwargs)

六、源码分析

#执行determine_version，返回两个值，放到version,scheme 中
# 其中 version 为版本号
# 其中 scheme 为版本控制的方式类型 （上面的示例类型为  URLPathVersioning）
version, scheme = self.determine_version(request, *args, **kwargs)
# 将版本号 和类型 存放到 request.version 和 request.version_scheme 中
request.version, request.versioning_scheme = version, scheme

def determine_version(self, request, *args, **kwargs):
        #当配置上版本类之后，就会实例化
        if self.versioning_class is None:
            return (None, None)
        scheme = self.versioning_class()
        # 这里返回的是版本号  和   版本控制类类型
        return (scheme.determine_version(request, *args, **kwargs), scheme)