加入收藏 | 设为首页 | 会员中心 | 我要投稿 李大同 （https://www.lidatong.com.cn/）- 科技、建站、经验、云计算、5G、大数据,站长网!
当前位置： 首页 > 大数据 > 正文

Django Rest Framework源码剖析(一)-----认证

发布时间：2020-12-15 17:17:05 所属栏目：大数据 来源：网络整理
导读：table style="height: 30px; background-color: #afeeee; width: 1266px; ; width: 1266px;" border="0" tr tdspan style="font-size: 16px;" 一、简介 /td /tr /table （简称DRF），是一个用于构建Web API的强大且灵活的工具包。 先说说REST：REST是一种Web
<tr>
<td><span style="font-size: 16px;">一、简介</td>
</tr></table>

（简称DRF），是一个用于构建Web API的强大且灵活的工具包。

先说说REST：REST是一种Web API设计标准，是目前比较成熟的一套互联网应用程序的API设计理论。REST这个词，是在他2000年的中提出的。Fielding是一个非常重要的人，他是HTTP协议（1.0版和1.1版）的主要设计者、Apache服务器软件的作者之一、Apache基金会的第一任主席。所以，他的这篇论文一经发表，就引起了关注，并且立即对互联网开发产生了深远的影响。

Fielding将他对互联网软件的架构原则，定名为REST，即Representational State Transfer的缩写。我对这个词组的翻译是”表现层状态转化”。如果一个架构符合REST原则，就称它为RESTful架构。所以简单来说，RESTful是一种Web API设计规范，根据产品需求需要定出一份方便前后端的规范，因此不是所有的标准要求都需要遵循。

学习RESTful API的资料：、

<table style="height: 30px; background-color: #afeeee; width: 1266px; ; width: 1266px;" border="0">
二、安装配置安装需求：

  • Python（2.7,3.2,3.3,3.4,3.5,3.6）
  • Django（1.10,1.11,2.0 alpha）

可选安装包：

  • （1.32.0+） – 支持模式生成。
  • （2.1.0+） – Markdown支持可浏览的API。
  • （1.0.1+） – 过滤支持。
  • ?– 改进的HTML显示过滤。
  • （1.1.1+） – 支持对象级别的权限控制。

安装：

pip install django-filter

<table style="height: 30px; background-color: #afeeee; width: 1266px; ; width: 1266px;" border="0">

<tr>
<td><span style="font-size: 16px;">三、知识预备</td>
</tr></table>

在开始介绍Django REST Framework之前需要了解下django的以及。

1.csrf校验：

基于中间件的process_view方法实现对请求的csrf_token验证

2.不需要csrf验证方法：

fbv:

django.views.decorators.csrf @csrf_exempt
<span style="color: #0000ff;">def<span style="color: #000000;"> index(request):
<span style="color: #0000ff;">pass

cbv:

方式一：

django.shortcuts django.views.decorators.csrf django.utils.decorators django.views <span style="color: #0000ff;">class<span style="color: #000000;"> Myview(View):
@method_decorator(csrf_exempt) <span style="color: #008000;">#<span style="color: #008000;">必须将装饰器写在dispatch上，单独加不生效
<span style="color: #0000ff;">def dispatch(self,request,*args,<span style="color: #000000;">kwargs):
<span style="color: #0000ff;">return super(Myview,self).dispatch(request,<span style="color: #000000;">kwargs)
<span style="color: #0000ff;">def<span style="color: #000000;"> get(self):
<span style="color: #0000ff;">return HttpResponse(<span style="color: #800000;">'<span style="color: #800000;">get<span style="color: #800000;">'<span style="color: #000000;">)

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

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

方式二：

django.shortcuts django.utils.decorators django.views @method_decorator(csrf_exempt,name=<span style="color: #800000;">'<span style="color: #800000;">dispatch<span style="color: #800000;">')<span style="color: #008000;">#<span style="color: #008000;">#name参数指定是dispatch方法
<span style="color: #0000ff;">class<span style="color: #000000;"> Myview(View):

</span><span style="color: #0000ff;"&gt;def</span> dispatch(self,**<span style="color: #000000;"&gt;kwargs)
</span><span style="color: #0000ff;"&gt;def</span><span style="color: #000000;"&gt; get(self):
    </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><span style="color: #000000;"&gt; post(self):
    </span><span style="color: #0000ff;"&gt;return</span> HttpResponse(<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;post</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;)

</span><span style="color: #0000ff;"&gt;def</span><span style="color: #000000;"&gt; put(self):
    </span><span style="color: #0000ff;"&gt;return</span> HttpResponse(<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;put</span><span style="color: #800000;"&gt;'</span>)</pre>
四、简单认证示例场景：用户查看自己购买的订单，需登陆验证

以下是demo：

models.py

django.db <span style="color: #0000ff;">class<span style="color: #000000;"> UserInfo(models.Model):
user_type_choice =<span style="color: #000000;"> (
(1,<span style="color: #800000;">"<span style="color: #800000;">普通用户<span style="color: #800000;">"<span style="color: #000000;">),(2,<span style="color: #800000;">"<span style="color: #800000;">会员<span style="color: #800000;">"<span style="color: #000000;">),)
user_type = models.IntegerField(choices=<span style="color: #000000;">user_type_choice)
username = models.CharField(max_length=32,unique=<span style="color: #000000;">True)
password = models.CharField(max_length=64<span style="color: #000000;">)

<span style="color: #0000ff;">class<span style="color: #000000;"> UserToken(models.Model):
user = models.OneToOneField(to=<span style="color: #000000;">UserInfo)
token = models.CharField(max_length=64)

认证url（urls.py）

django.conf.urls django.contrib app01 urlpatterns =<span style="color: #000000;"> [

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 <span style="color: #0000ff;">class<span style="color: #000000;"> Authentication(BaseAuthentication):
<span style="color: #800000;">"""<span style="color: #800000;">
认证类
<span style="color: #800000;">"""

<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>

<span style="color: #0000ff;">def<span style="color: #000000;"> md5(user):
ctime =<span style="color: #000000;"> str(time.time())
m = hashlib.md5(bytes(user,encoding=<span style="color: #800000;">"<span style="color: #800000;">utf-8<span style="color: #800000;">"<span style="color: #000000;">))
m.update(bytes(ctime,encoding=<span style="color: #800000;">"<span style="color: #800000;">utf-8<span style="color: #800000;">"<span style="color: #000000;">))
<span style="color: #0000ff;">return<span style="color: #000000;"> m.hexdigest()

<span style="color: #0000ff;">class<span style="color: #000000;"> AuthView(APIView):
<span style="color: #800000;">"""<span style="color: #800000;">登陆认证<span style="color: #800000;">"""
<span style="color: #0000ff;">def dispatch(self,<span style="color: #000000;">kwargs):
<span style="color: #0000ff;">return super(AuthView,<span style="color: #000000;">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)

<span style="color: #0000ff;">class<span style="color: #000000;"> OrderView(APIView):
<span style="color: #800000;">'''<span style="color: #800000;">查看订单<span style="color: #800000;">'''<span style="color: #000000;">

authentication_classes </span>= [Authentication,]    <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;添加认证</span>
<span style="color: #0000ff;"&gt;def</span> get(self,**<span style="color: #000000;"&gt;kwargs):
    </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;request.user</span>
    <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;request.auth</span>
    ret = {<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: #800000;"&gt;'</span><span style="color: #800000;"&gt;data</span><span style="color: #800000;"&gt;'</span>:<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;买了一个mac</span><span style="color: #800000;"&gt;"</span><span style="color: #000000;"&gt;}
    </span><span style="color: #0000ff;"&gt;return</span> JsonResponse(ret,safe=True)</pre>

用户使用token访问，不带token或token错误会认证错误。

http://127.0.0.1:8000/api/v1/order?token=<span style="color: #008000;">#<span style="color: #008000;">##返回结果
{<span style="color: #800000;">"<span style="color: #800000;">code<span style="color: #800000;">": 1000,<span style="color: #800000;">"<span style="color: #800000;">msg<span style="color: #800000;">": <span style="color: #800000;">"<span style="color: #800000;">u4f60u7684u8ba2u5355u5df2u7ecfu5b8cu6210<span style="color: #800000;">",<span style="color: #800000;">"<span style="color: #800000;">data<span style="color: #800000;">": <span style="color: #800000;">"<span style="color: #800000;">u4e70u4e86u4e00u4e2amac<span style="color: #800000;">"}

对于以上demo可能会有疑问为什么添加了authentication_classes认证类列表就会使用我们自己定义的认证类，下面从源码角度分析

五、认证过程源码剖析1.先从请求说起，我们都知道在django(CBV)中，客户端的发来的请求会执行视图类的as_view方法，而as_view方法中会执行dispacth方法，然后在根据请求的类型执行相应的方法(get、post等)。

2.在上面的示例中，使用django rest framework中的视图类需要继承APIView,请求到达视图类会执行视图类的as_view方法，而OrderView中没有as_view()方法，所以执行APIView的as_view()方法，下面请看APIView类中的as_view()源码：

as_view(cls,** This allows us to discover information about the view when we do URL reverse lookups. Used for breadcrumb generation. </span><span style="color: #800000;"&gt;"""</span> <span style="color: #0000ff;"&gt;if</span> isinstance(getattr(cls,<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;queryset</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;,None),models.query.QuerySet): </span><span style="color: #0000ff;"&gt;def</span><span style="color: #000000;"&gt; force_evaluation(): </span><span style="color: #0000ff;"&gt;raise</span><span style="color: #000000;"&gt; RuntimeError( </span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;Do not evaluate the `.queryset` attribute directly,</span><span style="color: #800000;"&gt;'</span> <span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;as the result will be cached and reused between requests. </span><span style="color: #800000;"&gt;'</span> <span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;Use `.all()` or call `.get_queryset()` instead.</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt; ) cls.queryset._fetch_all </span>=<span style="color: #000000;"&gt; force_evaluation view </span>= super(APIView,cls).as_view(**<span style="color: #000000;"&gt;initkwargs) <span style="color: #ff6600;"&gt;#执行父类as_view()方法</span> view.cls </span>=<span style="color: #000000;"&gt; cls view.initkwargs </span>=<span style="color: #000000;"&gt; initkwargs </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; Note: session based authentication is explicitly CSRF validated,</span> <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; all other authentication is CSRF exempt.</span> <span style="color: #0000ff;"&gt;return</span> csrf_exempt(view)</pre>

3.从以上源码中可以看到APIView中as_view又执行了父类的as_view方法，在看看APIView的父类是View类，这恰好是django中的view视图类，以下是View类中的as_view()的源码：

as_view(cls,** key key TypeError( % (key,cls. TypeError( % (cls. </span><span style="color: #0000ff;"&gt;def</span> view(request,**<span style="color: #000000;"&gt;kwargs): self </span>= cls(**<span style="color: #000000;"&gt;initkwargs) </span><span style="color: #0000ff;"&gt;if</span> hasattr(self,<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;get</span><span style="color: #800000;"&gt;'</span>) <span style="color: #0000ff;"&gt;and</span> <span style="color: #0000ff;"&gt;not</span> hasattr(self,<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;head</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;): self.head </span>=<span style="color: #000000;"&gt; self.get self.request </span>=<span style="color: #000000;"&gt; request self.args </span>=<span style="color: #000000;"&gt; args self.kwargs </span>=<span style="color: #000000;"&gt; kwargs </span><span style="color: #0000ff;"&gt;return</span> self.dispatch(request,**<span style="color: #000000;"&gt;kwargs) view.view_class </span>=<span style="color: #000000;"&gt; cls view.view_initkwargs </span>=<span style="color: #000000;"&gt; initkwargs </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; take name and docstring from class</span> update_wrapper(view,cls,updated=<span style="color: #000000;"&gt;()) </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; and possible attributes set by decorators</span> <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; like csrf_exempt from dispatch</span> update_wrapper(view,cls.dispatch,assigned=<span style="color: #000000;"&gt;()) </span><span style="color: #0000ff;"&gt;return</span> view</pre>

4.从上源码可以看出View类的as_view()方法执行流程：验证请求方法--->返回view函数名称(view函数会执行dispatch方法)，一旦有请求进来执行view函数-->执行dispatch方法

5.当APIView的as_view方法执行了父类的as_view方法以后，请求进来会执行view方法，view方法中会执行dispatch方法，而Oderview没有dispatch方法，所以执行父类(APIView)的dispatch方法,下面的APIView的dispatch()方法源码：

dispatch(self,**=== self.initialize_request(request,** self.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 style="color: #ff6600;"&gt;#这里request参数实则是Request对象

        </span></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>

6.从以上源码分析，执行APIView的dispatch方法时候会执行self.initialize_request方法，会对django原始的request进行封装。再看看initialize_request源码封装的内容，以下是self.initialize_request()源码：

initialize_request(self,**= </span><span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; Request( <span style="color: #ff6600;"&gt; #实例化Request类，</span> request,<span style="color: #ff6600;"&gt;#django原始的request对象，封装到Request中变成self._request　　</span> parsers</span>=<span style="color: #000000;"&gt;self.get_parsers(),authenticators</span>=<span style="color: #000000;"&gt;self.get_authenticators(),<span style="color: #ff6600;"&gt;#开始认证流程</span> negotiator</span>=<span style="color: #000000;"&gt;self.get_content_negotiator(),parser_context</span>=<span style="color: #000000;"&gt;parser_context )</span></pre>

7.self.initialize_request()源码分析，实例化Request()类，封装原始的request,authenticators(认证),执行self.get_authenticators(),到了这里就开始django rest framework的认证流程，以下是self.get_authenticators()源码：

[auth() auth self.authentication_classes]

8.self.get_authenticators()源码分析，采用列表生成式，循环self.authentication_classes，实例化其中的每一个类，返回列表，不难发现authentication_classes属性正式我们在认证的时候用到认证类列表，这里会自动寻找该属性进行认证。倘若我们的视图类没有定义认证方法呢？，当然django rest framework 已经给我们加了默认配置，如果我们没有定义会自动使用settings中的DEFAULT_AUTHENTICATION_CLASSES作为默认(全局)下面是APIView类中的共有属性：

</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 <span style="color: #ff6600;"&gt;authentication_classes </span></span><span style="color: #ff6600;"&gt;=</span><span style="color: #000000;"&gt;<span style="color: #ff6600;"&gt; api_settings.DEFAULT_AUTHENTICATION_CLASSES</span> <span style="color: #ff6600;"&gt;#默认认证配置</span> 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 versioning_class </span>= api_settings.DEFAULT_VERSIONING_CLASS</pre>

?9.继续分析APIView的dispatch方法，此时执行self.inital方法，并将封装过后的request对象(Reuqest)作为参数进行传递，下面是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> 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: #000000;"> self.perform_authentication(request) <span style="color: #ff6600;"> #实现认证
self.check_permissions(request)
self.check_throttles(request)

10.在self.inital方法中会执行self.perform_authentication方法，而self.perform_authentication方法用会执行request.user,此时的request是Request对象，所以需分析Request类中的user属性，以下是Request部分类源码：

Kwargs: - request(HttpRequest). The original request instance. - parsers_classes(list/tuple). The parsers to use for parsing the request content. - authentication_classes(list/tuple). The authentications used to try authenticating the request's user. </span><span style="color: #800000;"&gt;"""</span> <span style="color: #0000ff;"&gt;def</span> <span style="color: #800080;"&gt;__init__</span>(self,parsers=None,authenticators=<span style="color: #000000;"&gt;None,negotiator</span>=None,parser_context=<span style="color: #000000;"&gt;None): </span><span style="color: #0000ff;"&gt;assert</span><span style="color: #000000;"&gt; isinstance(request,HttpRequest),( </span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;The `request` argument must be an instance of </span><span style="color: #800000;"&gt;'</span> <span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;`django.http.HttpRequest`,not `{}.{}`.</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt; .format(request.</span><span style="color: #800080;"&gt;__class__</span>.<span style="color: #800080;"&gt;__module__</span>,request.<span style="color: #800080;"&gt;__class__</span>.<span style="color: #800080;"&gt;__name__</span><span style="color: #000000;"&gt;) ) self._request </span>= request <span style="color: #ff6600;"&gt;#django原生的request封装为_request</span> self.parsers = parsers <span style="color: #0000ff;"&gt;or</span><span style="color: #000000;"&gt; () self.authenticators </span>= authenticators <span style="color: #0000ff;"&gt;or</span><span style="color: #000000;"&gt; () self.negotiator </span>= negotiator <span style="color: #0000ff;"&gt;or</span><span style="color: #000000;"&gt; self._default_negotiator() self.parser_context </span>=<span style="color: #000000;"&gt; parser_context self._data </span>=<span style="color: #000000;"&gt; Empty self._files </span>=<span style="color: #000000;"&gt; Empty self._full_data </span>=<span style="color: #000000;"&gt; Empty self._content_type </span>=<span style="color: #000000;"&gt; Empty self._stream </span>=<span style="color: #000000;"&gt; Empty

<span style="color: #008000;">#<span style="color: #008000;">###
<span style="color: #000000;"> @property
<span style="color: #0000ff;">def<span style="color: #000000;"> user(self):
<span style="color: #800000;">"""<span style="color: #800000;">
Returns the user associated with the current request,as authenticated
by the authentication classes provided to the request.
<span style="color: #800000;">"""
<span style="color: #0000ff;">if <span style="color: #0000ff;">not hasattr(self,<span style="color: #800000;">'<span style="color: #800000;">_user<span style="color: #800000;">'<span style="color: #000000;">):
with wrap_attributeerrors():
self._authenticate() #下hi ing
<span style="color: #0000ff;">return self._user

11.从上源码分析，在Request对象中，user属性是一个属性方法，并会执行self._authentication方法，在继续看Request对象的self._authentication方法：

authenticator 
 　　　　　　　　
=

        <span style="color: #0000ff;"&gt;if</span> user_auth_tuple <span style="color: #0000ff;"&gt;is</span> <span style="color: #0000ff;"&gt;not</span><span style="color: #000000;"&gt; None:
            self._authenticator </span>=<span style="color: #000000;"&gt; authenticator
            self.user,self.auth </span>=<span style="color: #000000;"&gt; user_auth_tuple  <span style="color: #ff6600;"&gt;#返回值对应示例中的token_obj.user和token_obj
            </span></span><span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt;

    self._not_authenticated()</span></pre>

12.从上源码分析，Request对象的self._authentication中循环self.authenticators(该列表是由认证对象构成的[对象1，对象2])，并执行每一个对象中的方法返回tuple，同时对该过程其进行了异常捕捉，有异常将返回给用户，下面是异常验证逻辑：

  • 如果有异常则执行self._not_authenticated()方法，继续向上抛异常。

  • 如果有返回值必须是一个元组，分别赋值给self.user,self.auth(request.user和request.auth)，并跳出循环。

  • 如果返回None，则由下一个循环处理，如果都为None，则执行self._not_authenticated()，返回 (AnonymousUser,None)

13.当都没有返回值，就执行self._not_authenticated(),相当于匿名用户，没有通过认证，并且此时django会返回默认的匿名用户设置AnonymousUser，如需要单独设置匿名用户返回值，则编写需要写UNAUTHENTICATED_USER的返回值：

Defaults are None,AnonymousUser &amp; None. </span><span style="color: #800000;"&gt;"""</span><span style="color: #000000;"&gt; self._authenticator </span>=<span style="color: #000000;"&gt; None </span><span style="color: #0000ff;"&gt;if</span><span style="color: #000000;"&gt; api_settings.UNAUTHENTICATED_USER: self.user </span>= api_settings.UNAUTHENTICATED_USER() <span style="color: #008000;"&gt;#匿名用户配置，默认返回</span><span style="color: #008000;"&gt;AnonymousUser</span> <span style="color: #0000ff;"&gt;else</span><span style="color: #000000;"&gt;: self.user </span>=<span style="color: #000000;"&gt; None </span><span style="color: #0000ff;"&gt;if</span><span style="color: #000000;"&gt; api_settings.UNAUTHENTICATED_TOKEN: self.auth </span>= api_settings.UNAUTHENTICATED_TOKEN() <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;None</span> <span style="color: #0000ff;"&gt;else</span><span style="color: #000000;"&gt;: self.auth </span>= None</pre>

14.所以经过以上分析，我们需要进行认证时候，需要在每一个认证类中定义authenticate进行验证，并且需要返回元祖。

<table style="height: 30px; background-color: #afeeee; width: 1266px; ; width: 1266px;" border="0">

<tr>
<td><span style="font-size: 16px;">六、配置认证类</td>
</tr></table>

1.认证全局配置文件

经过认证的源码流程剖析，DRF的认证全局配置在api_setting中，以下是api_setings部分源码：

api_settings =<span style="color: #0000ff;">def reload_api_settings(*args,**<span style="color: #000000;">kwargs):
setting = kwargs[<span style="color: #800000;">'<span style="color: #800000;">setting<span style="color: #800000;">'<span style="color: #000000;">]
<span style="color: #0000ff;">if setting == <span style="color: #800000;">'<span style="color: #800000;">REST_FRAMEWORK<span style="color: #800000;">'<span style="color: #000000;">: <span style="color: #ff6600;">#项目中settings.py的key
api_settings.reload()

setting_changed.connect(reload_api_settings)

其中引用了django，settings.py中的REST_FRAMEWORK作为key作为配置，所以全局配置示例：

REST_FRAMEWORK =:[,] }

2.局部使用

局部某个视图不需要认证，则在视图类中加入authentication_classes=[]

authentication_classes = []

3.匿名用户配置：

REST_FRAMEWORK =:[,]， : :"UNAUTHENTICATED_token": None， 

}
七、内置认证类1.BaseAuthentication

BaseAuthentication是django rest framework为我们提供了最基本的认证类，正如源码流程一样，该类中其中定义的两个方法authenticate和authenticate_header(认证失败返回的响应头),使用时候重写该两个方法进行认证，正如示例：

<span style="color: #0000ff;"&gt;def</span><span style="color: #000000;"&gt; authenticate(self,request):
    </span><span style="color: #800000;"&gt;"""</span><span style="color: #800000;"&gt;
    Authenticate the request and return a two-tuple of (user,token).
    </span><span style="color: #800000;"&gt;"""</span>
    <span style="color: #0000ff;"&gt;raise</span> NotImplementedError(<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;.authenticate() must be overridden.</span><span style="color: #800000;"&gt;"</span><span style="color: #000000;"&gt;)

</span><span style="color: #0000ff;"&gt;def</span><span style="color: #000000;"&gt; authenticate_header(self,request):
    </span><span style="color: #800000;"&gt;"""</span><span style="color: #800000;"&gt;
    Return a string to be used as the value of the `WWW-Authenticate`
    header in a `401 Unauthenticated` response,or `None` if the
    authentication scheme should return `403 Permission Denied` responses.
    </span><span style="color: #800000;"&gt;"""</span>
    <span style="color: #0000ff;"&gt;pass</span></pre>

2.其他认证类

SessionAuthentication RemoteUserAuthentication TokenAuthentication

<table style="height: 30px; background-color: #afeeee; width: 1266px; ; width: 1266px;" border="0">

<tr>
<td><span style="font-size: 16px;">八、总结</td>
</tr></table>

1.自定义认证类：

继承BaseAuthentication，重写authenticate方法和authenticate_header(pass就可以)，authenticate()方法需要有三种情况(返回元祖、出现异常、返回none)。

2.认证配置：

REST_FRAMEWORK =:[<span style="color: #008000;">#<span style="color: #008000;">局部认证
authentication_classes =<span style="color: #000000;"> [BaseAuthentication,]

<span style="color: #008000;">#<span style="color: #008000;">是某个视图不进行认证
authentication_classes =[]

3.源码流程：

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!

    相关内容
      推荐文章
        站长推荐
        热点阅读

          【免责声明】本站内容转载自互联网，其发布内容言论不代表本站观点，如果其链接、内容的侵犯您的权益，烦请提交相关链接至邮箱bqsm@foxmail.com我们将及时予以处理。

          建议您使用1920×1080分辨率、谷歌浏览器Google Chrome、Microsoft Edge以获得本站的最佳浏览效果

          Copygight © 2008-2022 https://www.lidatong.com.cn/ All Rights Reserved. 李大同