Django Rest Framework之版本控制

基本代码结构

settings.py:

REST_FRAMEWORK = {
    'DEFAULT_VERSION': 'v1',            # 默认版本
    'ALLOWED_VERSIONS': ['v1', 'v2'],   # 允许的版本
    'VERSION_PARAM': 'version'          # URL中获取值的key
}

 urls.py:

from django.conf.urls import url, include
from web.views import TestView

urlpatterns = [
    url(r'^(?P<version>[v1|v2]+)/test/', TestView.as_view(), name='test'),
]

 views.py:

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


class TestView(APIView):
    versioning_class = URLPathVersioning

    def get(self, request, *args, **kwargs):
        # 获取版本
        print(request.version)
        # 获取版本管理的类
        print(request.versioning_scheme)

        # 反向生成URL
        reverse_url = request.versioning_scheme.reverse('test', request=request)
        print(reverse_url)

        return Response('GET请求，响应内容')

    def post(self, request, *args, **kwargs):
        return Response('POST请求，响应内容')

    def put(self, request, *args, **kwargs):
        return Response('PUT请求，响应内容')

源码分析

• 为什么会用“versioning_class”属性变量，它有什么用？

　　

　　还是要从APIView类中的dispatch开始说起，跟之前讲的认证等功能接口一样，首先要完成对django原生request的封装，然后同样是在initial方法中实现版本控制。在initial方法中可以看到，是通过调用determine_version方法实现版本控制。

　　

　　

　　在determine_version方法中就可以看到versioning_class属性变量，再跳转到version_class定义的地方。可以看到，它的初始值是通过配置文件设置的，而这种方式，主要是来实现全局配置的（下文会说明全局配置）。通过全局配置和“scheme = self.versioning_class()”代码可以看出，这段代码是在做对象的实例化，所以version_class属性变量存储的是一个对象，具体是哪个对象，全局配置方法中告诉了我们。使用的就是基本代码结构中的“URLPathVersioning”对象。而这个类就是实现版本控制核心代码的类。当我们不使用全局配置时，那么我们就必须在自定义的视图类中给version_class属性变量赋值，即：version_class = URLPathVersioning。

• 在urls.py文件中，版本的正则为什么要写成“(?P<version>[v1|v2]+)”的形式，为什么正则中的变量是“version”？

　　

　　跳转到URLPathVersioning类定义的地方可以看到，这种样式的正则“(?P<version>[v1|v2]+)”url的编写方式是在源码中已经规定好的，所以我们要使用源码中提供的接口。

• 在settings配置文件中，为什么会使用“DEFUALT_VERSION”，“ALLOWED_VERSION”，“VERSION_PARM”者三个key值来做版本配置？

     

　　由URLPathVersioning类的定义可以看出，它的父类是BaseVersioning类，先看一下这个类的具体定义。最开始定义的三个属性变量“default_version”，“allowed_versions”，“version_param”的值，也都是通过settings配置文件赋值的，而这三个值不就是问题中提到的三个key值吗？

　　再看determine_version方法，它会抛出异常，所以它的子类（URLPathVersioning类）必须重写这个方法。而下面的is_allowed_version方法，就是用来判断前端请求的版本号是否是配置文件中所配置的版本之一，这就用到了allowed_versions属性变量。如果没有配置allowed_versions变量（也就是说没有设置版本控制的功能，那自然是允许通过的，返回True），如果做了版本控制，那么就要判断当前获取的版本号（version变量）是否在配置的版本中，这里就会用到default_version变量和allowed_versions变量。

　　reverse方法是用于URL反射用的，这里就不多谈了。

      

　　再回到URLPathVersioning类中，可以看到determine_version方法。在这个方法中可以看到，通过kwargs.get()来获取前端请求时的版本号，这就要用到version_param和default_version变量。值得注意的是在对version_param变量配置时，的字符串必须跟在urls.py中的正则表达式中的变量保存一致（这里用的是“version”字符串）。当version变量为None时，就使用默认的版本。之后再调用is_allowed_version方法，完成对当前版本的是否合法的判断。最后返回合法的版本号。

　　

      

　　再回到APIView类中的initial方法中，可以看到它也调用了自己的determine_version方法。在determine_version方法中，可以看到上文提到过的versioning_class属性变量，它保存了URLPathVersion类对象。再看determine_version方法的返回值，返回的是一个元组。元组第一个元素正是上文提到过的URLPathVersion类中的determine_version方法，而这个方法返回的也正是合法的版本号。元组第二个元素是就是这个版本类对象。

　　再来到initial方法中，determine_version方法返回的元组的值，分别赋值到了request.version和request_versioning_scheme变量中。因此，在代码基本结构中，通过request.version变量来获取合法的版本号。

全局配置

REST_FRAMEWORK = {
    'DEFAULT_VERSIONING_CLASS':"rest_framework.versioning.URLPathVersioning",
    'DEFAULT_VERSION': 'v1',
    'ALLOWED_VERSIONS': ['v1', 'v2'],
    'VERSION_PARAM': 'version' 
}

 　　当使用全局配置时，就不需要在自定义的视图类中使用“versioning_class = URLPathVersioning”这段代码了。