django rest framework系列09-基于请求参数或者url地址使用rest内置版本控制类流程

默认你已经看过前几片文章知道url处理开始先执行self.dispatch()。之前说过了3中认证，(用户认证，权限认证，访问频率认证）

那么在这行代码前面：request.version, request.versioning_scheme = version, scheme

reque中还封装了一个version变量还有一个versioning_scheme。这个就是关于版本的入口。开始进入

def initial(self, request, *args, **kwargs):
    """
    Runs anything that needs to occur prior to calling the method handler.
    """
    self.format_kwarg = self.get_format_suffix(**kwargs)

    # Perform content negotiation and store the accepted info on the request
    neg = self.perform_content_negotiation(request)
    request.accepted_renderer, request.accepted_media_type = neg

    # Determine the API version, if versioning is in use.
    version, scheme = self.determine_version(request, *args, **kwargs)  #调用self.determine_version方法得到两个返回值: version, scheme
    request.version, request.versioning_scheme = version, scheme

    # Ensure that the incoming request is permitted
    self.perform_authentication(request)
    self.check_permissions(request)
    self.check_throttles(request)

 #调用self.determine_version方法得到两个返回值: version, scheme,跟进去看看:

def determine_version(self, request, *args, **kwargs):
    """
    If versioning is being used, then determine any API version for the
    incoming request. Returns a two-tuple of (version, versioning_scheme)
    """
    if self.versioning_class is None:  #先判断有没有这个变量
        return (None, None)
    scheme = self.versioning_class()  #实例化一个对象，因为下面调用 sheme点说明是一个对象。
    return (scheme.determine_version(request, *args, **kwargs), scheme)  #返回对象本身，还有对象中determine_version函数处理的结果。

self.versioning_class(),跟进去看看，配置文件。先不管，这里看以看出和之前的其他认证不一样的地方，之前的认证都是一个列表生成式，这个直接实例化，说明只有一个。

好，现在按住ctrl点击scheme.determine_version，可以看到内置有好几个版本处理的类。找一个进去看看 

 

BaseVersioning的进去看了一个异常，没写，下一个。URLPathVersioning。根据url路劲处理版本。。。。

def determine_version(self, request, *args, **kwargs):
    version = kwargs.get(self.version_param, self.default_version) #self.version_param, self.default_version跟进去看了都是配置文件
    if version is None:  #如果取不到version 使用默认
        version = self.default_version

    if not self.is_allowed_version(version):    
        raise exceptions.NotFound(self.invalid_version_message)
    return version

#这里self.is_allowed_version跟进去：判断version是否包含在allowed_versions中

def is_allowed_version(self, version):
    if not self.allowed_versions: #allowed_versions跟进去看了也是配置文件
        return True
    return ((version is not None and version == self.default_version) or
            (version in self.allowed_versions))

 也就是说需要3个参数去配置文件中写，

version = kwargs.get(self.version_param, self.default_version) #self.version_param, self.default_version跟进去看了都是配置文件

kwargs需要我们自己传进来参数，kwargs的get方法第一个参数key,第二个参数默认值：（默认我们用v1，下面那个可以使用的版本allowed_versions搞一个列表[v1,v2]）

现在就差这个version_param

视图中我们怎么传进来这个key还得去url中匹配。可以看到这个方法上面有个注释使用了一个正在表达式

urlpatterns = [
    re_path(r'^(?P<version>[v1|v2]+)/users/$', users_list, name='users-list'),
    re_path(r'^(?P<version>[v1|v2]+)/users/(?P<pk>[0-9]+)/$', users_detail, name='users-detail')
]

那么跟着做，应该url应该是这样，version是作为参数传入视图的。字典形式。如{'version':'v1'}

from django.contrib import admin
from django.urls import path,re_path
from API import views
urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/v1/auth/',views.authView.as_view()),
    path('api/v1/order/',views.orderView.as_view()),
    re_path(r'^api/(?P<version>[v1|v2]+)/userinfo/$',views.UserInfoView.as_view()), #记得这里变正在了需要引入re_path.
]

 视图是这样的：

class UserInfoView(APIView):
    #authentication_classes = []
    versioning_class = URLPathVersioning
    def get(self,request,*args,**kwargs):
        print(kwargs.get('version'))
        print(request.version)
        ret = {
            'code':1000,
            'msg':'测试',
            'version':request.version
        }
        return JsonResponse(ret)

 配置文件是这样的：

REST_FRAMEWORK ={
    "DEFAULT_AUTHENTICATION_CLASSES":['API.utils.auth.Authtication',],
    'DEFAULT_VERSION':'v1',
    'ALLOWED_VERSIONS':['v1','v2'],
    'VERSION_PARAM':'version'
}

 运行结果：

v1

v2

最后配置到全局：

REST_FRAMEWORK ={
    "DEFAULT_AUTHENTICATION_CLASSES":['API.utils.auth.Authtication',],
    'DEFAULT_VERSIONING_CLASS':'rest_framework.versioning.URLPathVersioning',  #使用的类
    'DEFAULT_VERSION':'v1', #默认版本
    'ALLOWED_VERSIONS':['v1','v2'], #允许的版本
    'VERSION_PARAM':'version' #url中传递给视图的key
}

 

 总结：

全局使用内置版本类，只需要配置4行代码：

返回request.version  #版本号    request.versioning_scheme #处理版本的类，其中还有其他方法。

url匹配改进下不让他报404，版本问题交给URLPathVersioning去处理

re_path(r'^api/(?P<version>[v\d]+)/userinfo/$',views.UserInfoView.as_view()),

扩展：自定义报错信息：

if not self.is_allowed_version(version):
    raise exceptions.NotFound(self.invalid_version_message)
return version

 自己写个类，完全继承URLPathVersioning，然后重写下invalid_version_message的值。引用自己的类。

class URLPathVersioning1(URLPathVersioning):
    def __init__(self):
        self.invalid_version_message = _('唉，版本好像不对！')