Django Rest Framework源码剖析(四)-----API版本

在我们给外部提供的API中，可会存在多个版本，不同的版本可能对应的功能不同，所以这时候版本使用就显得尤为重要，django rest framework也为我们提供了多种版本使用方法。

二、基本使用版本使用方式：

1.在url中传递版本:如http://www.example.com/api?version=v1

和其他组建一样，我们在utils里面建立version.py,添加版本类

rest_framework.versioning class Myversion(BaseVersioning):
def determine_version(self,request,*args,**kwargs):
myversion=request.query_params.get('version')
return myversion

在订单视图中应用版本,(当然直接可以使用request.get获取)

utils.permissions utils.version = [Authentication,] permission_classes = [MyPremission,] versioning_class = Myversion get(self,**(request.version) ret = {:1000,:,: JsonResponse(ret,safe=True)

models.py

django.db class UserInfo(models.Model):
user_type_choice = (
(1,"普通用户"),(2,"会员"),)
user_type = models.IntegerField(choices=user_type_choice)
username = models.CharField(max_length=32,unique=True)
password = models.CharField(max_length=64)

class UserToken(models.Model):
user = models.OneToOneField(to=UserInfo)
token = models.CharField(max_length=64)

urls.py

django.conf.urls django.contrib app01 urlpatterns = [

url(r</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;^api/v1/auth</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;,views.AuthView.as_view()),url(r</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;^api/v1/order</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;,views.OrderView.as_view()),]</span></pre>

views.py

django.shortcuts django.http rest_framework.views rest_framework.authentication . rest_framework class Authentication(BaseAuthentication):
"""
认证类
"""

<span style="color: #0000ff;"&gt;def</span><span style="color: #000000;"&gt; authenticate(self,request):
    token </span>= request._request.GET.get(<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;token</span><span style="color: #800000;"&gt;"</span><span style="color: #000000;"&gt;)
    toke_obj </span>= models.UserToken.objects.filter(token=<span style="color: #000000;"&gt;token).first()
    </span><span style="color: #0000ff;"&gt;if</span> <span style="color: #0000ff;"&gt;not</span><span style="color: #000000;"&gt; toke_obj:
        </span><span style="color: #0000ff;"&gt;raise</span> exceptions.AuthenticationFailed(<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;用户认证失败</span><span style="color: #800000;"&gt;"</span><span style="color: #000000;"&gt;)
    </span><span style="color: #0000ff;"&gt;return</span> (toke_obj.user,toke_obj)  <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; 这里返回值一次给request.user,request.auth</span>

<span style="color: #0000ff;"&gt;def</span><span style="color: #000000;"&gt; authenticate_header(self,val):
    </span><span style="color: #0000ff;"&gt;pass</span>

def md5(user):
ctime = str(time.time())
m = hashlib.md5(bytes(user,encoding="utf-8"))
m.update(bytes(ctime,encoding="utf-8"))
return m.hexdigest()

class AuthView(APIView):
"""登陆认证"""
def dispatch(self,kwargs):
return super(AuthView,self).dispatch(request,kwargs)

</span><span style="color: #0000ff;"&gt;def</span> get(self,**<span style="color: #000000;"&gt;kwargs):
    </span><span style="color: #0000ff;"&gt;return</span> HttpResponse(<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;get</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;)

</span><span style="color: #0000ff;"&gt;def</span> post(self,**<span style="color: #000000;"&gt;kwargs):

    ret </span>= {<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;code</span><span style="color: #800000;"&gt;'</span>: 1000,<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;msg</span><span style="color: #800000;"&gt;'</span>: <span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;登录成功</span><span style="color: #800000;"&gt;"</span><span style="color: #000000;"&gt;}
    </span><span style="color: #0000ff;"&gt;try</span><span style="color: #000000;"&gt;:
        user </span>= request._request.POST.get(<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;username</span><span style="color: #800000;"&gt;"</span><span style="color: #000000;"&gt;)
        pwd </span>= request._request.POST.get(<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;password</span><span style="color: #800000;"&gt;"</span><span style="color: #000000;"&gt;)
        obj </span>= models.UserInfo.objects.filter(username=user,password=<span style="color: #000000;"&gt;pwd).first()
        </span><span style="color: #0000ff;"&gt;if</span> <span style="color: #0000ff;"&gt;not</span><span style="color: #000000;"&gt; obj:
            ret[</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;code</span><span style="color: #800000;"&gt;'</span>] = 1001<span style="color: #000000;"&gt;
            ret[</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;msg</span><span style="color: #800000;"&gt;'</span>] = <span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;用户名或密码错误</span><span style="color: #800000;"&gt;"</span>
        <span style="color: #0000ff;"&gt;else</span><span style="color: #000000;"&gt;:
            token </span>=<span style="color: #000000;"&gt; md5(user)
            models.UserToken.objects.update_or_create(user</span>=obj,defaults={<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;token</span><span style="color: #800000;"&gt;"</span><span style="color: #000000;"&gt;: token})
            ret[</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;token</span><span style="color: #800000;"&gt;'</span>] =<span style="color: #000000;"&gt; token

    </span><span style="color: #0000ff;"&gt;except</span><span style="color: #000000;"&gt; Exception as e:
        ret[</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;code</span><span style="color: #800000;"&gt;'</span>] = 1002<span style="color: #000000;"&gt;
        ret[</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;msg</span><span style="color: #800000;"&gt;'</span>] = <span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;请求异常</span><span style="color: #800000;"&gt;"</span>

    <span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; JsonResponse(ret)

class OrderView(APIView):
'''查看订单'''
from utils.permissions import MyPremission
from utils.version import Myversion
authentication_classes = [Authentication,] #添加权限控制
versioning_class = Myversion
def get(self,**kwargs):
print(request.version)

    ret </span>= {<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;code</span><span style="color: #800000;"&gt;'</span>:1000,safe=True)</pre>

使用postman发送请求：http://127.0.0.1:8000/api/v1/order?token=7c191332ba452abefe516ff95ea9994a&version=v1，后台可获取版本。

当然上面获取版本方式还有更为简单的获取版本方法，使用QueryParameterVersioning，其就是封装的以上过程。

utils.permissions utils.version rest_framework.versioning = [Authentication,] get(self,safe=True)

当然，DRF也提供了可配置的版本，并且还能控制版本使用

settings.py

REST_FRAMEWORK = :, :[,], :, }

使用postman验证，发送带token和版本http://127.0.0.1:8000/api/v1/order?token=7c191332ba452abefe516ff95ea9994a&version=v3

结果：

可见版本配置生效。

2.使用url路径传递版本，如http://www.example.com/api/v1，django rest framework 当然也为我们提供了类：URLPathVersioning

为了区分，这里新建url和view，如下：

urls.py

django.conf.urls django.contrib app01 urlpatterns = [

url(r</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;^api/v1/auth</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;,<span style="color: #ff6600;"&gt; url(r</span></span><span style="color: #ff6600;"&gt;'^api/(?P<version>[v1|v2]+)/user'</span><span style="color: #000000;"&gt;<span style="color: #ff6600;"&gt;,views.UserView.as_view()),# 新建的url</span>

]

UserView

<span style="color: #0000ff;"&gt;from</span> rest_framework.versioning <span style="color: #0000ff;"&gt;import</span><span style="color: #000000;"&gt;<span style="color: #ff6600;"&gt; URLPathVersioning</span>

versioning_class </span>=<span style="color: #000000;"&gt;URLPathVersioning
</span><span style="color: #0000ff;"&gt;def</span> get(self,**<span style="color: #000000;"&gt;kwargs):
    </span><span style="color: #0000ff;"&gt;print</span><span style="color: #000000;"&gt;(request.version)  <span style="color: #ff6600;"&gt;#获取版本</span>

    res</span>={<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;name</span><span style="color: #800000;"&gt;"</span>:<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;wd</span><span style="color: #800000;"&gt;"</span>,<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;age</span><span style="color: #800000;"&gt;"</span>:22<span style="color: #000000;"&gt;}
    </span><span style="color: #0000ff;"&gt;return</span> JsonResponse(res,safe=True)</pre>

使用postman请求：http://127.0.0.1:8000/api/v1/user,同样后台能拿到版本结果。

三、源码剖析和流程一样，请求进来，同样走APIview的dispatch的方法，请阅读注解部分：

1.APIView类的dispatch源码：

dispatch(self,**== request = self.initialize_request(request,**== self.default_response_headers

    <span style="color: #0000ff;"&gt;try</span><span style="color: #000000;"&gt;:
        self.initial(request,</span>*args,**<span style="color: #000000;"&gt;kwargs)

        </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; Get the appropriate handler method</span>
        <span style="color: #0000ff;"&gt;if</span> request.method.lower() <span style="color: #0000ff;"&gt;in</span><span style="color: #000000;"&gt; self.http_method_names:
            handler </span>=<span style="color: #000000;"&gt; getattr(self,request.method.lower(),self.http_method_not_allowed)
        </span><span style="color: #0000ff;"&gt;else</span><span style="color: #000000;"&gt;:
            handler </span>=<span style="color: #000000;"&gt; self.http_method_not_allowed

        response </span>= handler(request,**<span style="color: #000000;"&gt;kwargs)

    </span><span style="color: #0000ff;"&gt;except</span><span style="color: #000000;"&gt; Exception as exc:
        response </span>=<span style="color: #000000;"&gt; self.handle_exception(exc)

    self.response </span>= self.finalize_response(request,response,**<span style="color: #000000;"&gt;kwargs)
    </span><span style="color: #0000ff;"&gt;return</span> self.response</pre>

2.接着执行self.inital方法：

initial(self,**= self.get_format_suffix(**

    </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; Perform content negotiation and store the accepted info on the request</span>
    neg =<span style="color: #000000;"&gt; self.perform_content_negotiation(request)
    request.accepted_renderer,request.accepted_media_type </span>=<span style="color: #000000;"&gt; neg

    </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; Determine the API version,if versioning is in use.</span>
    <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;###版本控制</span>
    version,scheme = self.determine_version(request,**<span style="color: #000000;"&gt;kwargs)
    request.version,request.versioning_scheme </span>=<span style="color: #000000;"&gt; version,scheme

    </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; Ensure that the incoming request is permitted</span>
    <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;2.实现认证</span>

self.perform_authentication(request)
#3.权限判断
 self.check_permissions(request)
#4.频率限制
self.check_throttles(request)

3.可以看到版本控制是在认证之前，首先下执行version,**kwargs)，以下是self.determine_version源码：

determine_version(self,** self.versioning_class = (scheme.determine_version(request,**kwargs),scheme)

4.承接 self.determine_version方法执行完成以后，接着执行request.version,request.versioning_scheme = version,scheme，这个不用多说，无非将版本号赋值给request.version属性，版本类对象赋值给request.versioning_scheme,这也就是我们为什么能通过request.version获取版本号的原因。

5.同认证源码一样，self.determine_version方法中使用的版本类self.versioning_class()，在全局中也有配置

</span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; The following policies may be set at either globally,or per-view.</span>
renderer_classes =<span style="color: #000000;"&gt; api_settings.DEFAULT_RENDERER_CLASSES
parser_classes </span>=<span style="color: #000000;"&gt; api_settings.DEFAULT_PARSER_CLASSES
authentication_classes </span>=<span style="color: #000000;"&gt; api_settings.DEFAULT_AUTHENTICATION_CLASSES
throttle_classes </span>=<span style="color: #000000;"&gt; api_settings.DEFAULT_THROTTLE_CLASSES
permission_classes </span>=<span style="color: #000000;"&gt; api_settings.DEFAULT_PERMISSION_CLASSES
content_negotiation_class </span>=<span style="color: #000000;"&gt; api_settings.DEFAULT_CONTENT_NEGOTIATION_CLASS
metadata_class </span>=<span style="color: #000000;"&gt; api_settings.DEFAULT_METADATA_CLASS
<span style="color: #ff6600;"&gt;versioning_class </span></span><span style="color: #ff6600;"&gt;= api_settings.DEFAULT_VERSIONING_CLASS  #版本处理类配置</span></pre>

6.基于以上源码分析完成以后，下面我们来剖析下，我们示例中所使用的两个版本处理类，具体分析请看注解：

QueryParameterVersioning(BaseVersioning)

= _(

</span></span><span style="color: #0000ff;"&gt;def</span> determine_version(self,**<span style="color: #000000;"&gt;kwargs):           ## 获取版本方法
    version </span>=<span style="color: #000000;"&gt; request.query_params.get(self.version_param,self.default_version) <span style="color: #ff6600;"&gt;# 通过request.query_paras方法获取（本质request.MATE.get）</span>，<span style="color: #ff6600;"&gt;default_version默认是version，是在settings中配置的
    </span></span><span style="color: #0000ff;"&gt;if</span> <span style="color: #0000ff;"&gt;not</span><span style="color: #000000;"&gt; self.is_allowed_version(version):    <span style="color: #ff6600;"&gt; #不允许的版本抛出异常
        </span></span><span style="color: #0000ff;"&gt;raise</span><span style="color: #000000;"&gt; exceptions.NotFound(self.invalid_version_message)
    </span><span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; version  <span style="color: #ff6600;"&gt;#无异常则返回版本号

</span></span><span style="color: #0000ff;"&gt;def</span> reverse(self,viewname,args=None,kwargs=None,request=None,format=None,**<span style="color: #000000;"&gt;extra):  <span style="color: #ff6600;"&gt;#url 反解析，可以通过该方法生成请求的url，后面会有示例</span>
    url </span>=<span style="color: #000000;"&gt; super(QueryParameterVersioning,self).reverse(
        viewname,args,kwargs,format,</span>**<span style="color: #000000;"&gt;extra
    )
    </span><span style="color: #0000ff;"&gt;if</span> request.version <span style="color: #0000ff;"&gt;is</span> <span style="color: #0000ff;"&gt;not</span><span style="color: #000000;"&gt; None:
        </span><span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; replace_query_param(url,self.version_param,request.version)   
    </span><span style="color: #0000ff;"&gt;return</span> url</pre>

URLPathVersioning

An example URL conf for two views that accept two different versions.

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

GET /1.0/something/ HTTP/1.1
Host: example.com
Accept: application/json
</span><span style="color: #800000;"&gt;"""</span><span style="color: #000000;"&gt;
invalid_version_message </span>= _(<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;Invalid version in URL path.</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;)  <span style="color: #ff6600;"&gt;# 不允许的版本信息，可定制

</span></span><span style="color: #0000ff;"&gt;def</span> determine_version(self,**<span style="color: #000000;"&gt;kwargs):    <span style="color: #ff6600;"&gt;## 同样实现determine_version方法获取版本</span>
    version </span>=<span style="color: #000000;"&gt; kwargs.get(self.version_param,self.default_version) <span style="color: #ff6600;"&gt;# 由于传递的版本在url的正则中，所以从kwargs中获取，self.version_param默认是version
    </span></span><span style="color: #0000ff;"&gt;if</span> <span style="color: #0000ff;"&gt;not</span><span style="color: #000000;"&gt; self.is_allowed_version(version):
        </span><span style="color: #0000ff;"&gt;raise</span><span style="color: #000000;"&gt; exceptions.NotFound(self.invalid_version_message)     <span style="color: #ff6600;"&gt;# 没获取到，抛出异常
    </span></span><span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; version                                                  <span style="color: #ff6600;"&gt;# 正常获取，返回版本号

</span></span><span style="color: #0000ff;"&gt;def</span> reverse(self,**<span style="color: #000000;"&gt;extra): <span style="color: #ff6600;"&gt;# url反解析，后面会有示例
    </span></span><span style="color: #0000ff;"&gt;if</span> request.version <span style="color: #0000ff;"&gt;is</span> <span style="color: #0000ff;"&gt;not</span><span style="color: #000000;"&gt; None:
        kwargs </span>= {} <span style="color: #0000ff;"&gt;if</span> (kwargs <span style="color: #0000ff;"&gt;is</span> None) <span style="color: #0000ff;"&gt;else</span><span style="color: #000000;"&gt; kwargs
        kwargs[self.version_param] </span>=<span style="color: #000000;"&gt; request.version

    </span><span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; super(URLPathVersioning,</span>**extra</pre>

这个版本类都继承了BaseVersioning：

= allowed_versions = version_param =

</span></span><span style="color: #0000ff;"&gt;def</span> determine_version(self,**<span style="color: #000000;"&gt;kwargs):
    msg </span>= <span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;{cls}.determine_version() must be implemented.</span><span style="color: #800000;"&gt;'</span>
    <span style="color: #0000ff;"&gt;raise</span><span style="color: #000000;"&gt; NotImplementedError(msg.format(
        cls</span>=self.<span style="color: #800080;"&gt;__class__</span>.<span style="color: #800080;"&gt;__name__</span><span style="color: #000000;"&gt;
    ))

</span><span style="color: #0000ff;"&gt;def</span> reverse(self,**<span style="color: #000000;"&gt;extra):
    </span><span style="color: #0000ff;"&gt;return</span> _reverse(viewname,**<span style="color: #000000;"&gt;extra)

</span><span style="color: #0000ff;"&gt;def</span><span style="color: #000000;"&gt; is_allowed_version(self,version):
    </span><span style="color: #0000ff;"&gt;if</span> <span style="color: #0000ff;"&gt;not</span><span style="color: #000000;"&gt; self.allowed_versions:
        </span><span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; True
    </span><span style="color: #0000ff;"&gt;return</span> ((version <span style="color: #0000ff;"&gt;is</span> <span style="color: #0000ff;"&gt;not</span> None <span style="color: #0000ff;"&gt;and</span> version == self.default_version) <span style="color: #0000ff;"&gt;or</span><span style="color: #000000;"&gt;
            (version </span><span style="color: #0000ff;"&gt;in</span> self.allowed_versions))</pre>

四、利用版本反向生成URL以URLPathVersioning为例，其本质也是用的django的url反向解析方法，实现过程这里就不用过多说明，有兴趣可以自己看源码。

1.配置url，为view取别名

urlpatterns =

url(r</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;^api/v1/auth</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;,<span style="color: #ff6600;"&gt; url(r</span></span><span style="color: #ff6600;"&gt;'^api/(?P<version>[v1|v2]+)/user',views.UserView.as_view(),name="user_view"</span><span style="color: #000000;"&gt;<span style="color: #ff6600;"&gt;),</span>

]

2.利用reverse方法反向生成请求的url,UserView视图。

<span style="color: #0000ff;"&gt;from</span> rest_framework.versioning <span style="color: #0000ff;"&gt;import</span><span style="color: #000000;"&gt; URLPathVersioning

versioning_class </span>=<span style="color: #000000;"&gt;URLPathVersioning
</span><span style="color: #0000ff;"&gt;def</span> get(self,**<span style="color: #000000;"&gt;kwargs):
    </span><span style="color: #0000ff;"&gt;print</span><span style="color: #000000;"&gt;(request.version)

    url </span>= request.versioning_scheme.reverse(viewname=<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;user_view</span><span style="color: #800000;"&gt;'</span>,request=<span style="color: #000000;"&gt;request)
    </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;versioning_scheme已经在源码中分析过了，就是版本类实例化的对象</span>
    <span style="color: #0000ff;"&gt;print</span><span style="color: #000000;"&gt;(url)
    res</span>={<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;name</span><span style="color: #800000;"&gt;"</span>:<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;wd</span><span style="color: #800000;"&gt;"</span>,safe=True)</pre>

使用postman发请求：http://127.0.0.1:8000/api/v1/user查看结果如下：

对于版本控制来说，其实没必要自己去定义或自己写版本处理的类，推荐使用全局配置，以及URLPathVersioning类。

具体配置：

REST_FRAMEWORK =:, :, :[, #单一视图
versioning_class =URLPathVersioning

Django Rest Framework源码剖析(四)-----API版本

相关推荐