drf框架（二）

drf框架安装

>: pip install djangorestframework

drf框架规矩的封装风格

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.request import Request
from rest_framework.filters import SearchFilter
from rest_framework.pagination import PageNumberPagination
from rest_framework.exceptions import APIException
from rest_framework.authentication import BaseAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework.throttling import SimpleRateThrottle
from rest_framework.settings import APISettings
from rest_framework import status

drf请求生命周期

1.请求走的是APIView的as_view()函数
2.在APIView的as_view调用父类（django原生)的as_view，并禁用了 csrf 认证
3.在父类的as_view中的 dispatch 方法请求走的又是 APIView 的 dispatch
4.完成任务方法交给视图类的请求函数处理，得到请求的响应结果，返回给前台

基于restful规范的原生Django接口

用规范的方法写我们之前的django范例

主路由 urls.py 进行路由分发

from django.conf.urls import url,include
from django.contrib import admin

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^app01/', include('app01.urls')),
]

应用app01下的urls.py

from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^books/$', views.Book.as_view()),
    url(r'^books/(?P<pk>.*)/$', views.Book.as_view()),
]

模型层 models.py创建数据

通过内嵌类class Meta 给model定义元数据

from django.db import models

# Create your models here.


class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.DecimalField(max_digits=5, decimal_places=2)

    class Meta:  # 通过内嵌类，定义元数据
        db_table = 'ob_book'   # 定义表名
        verbose_name = '书籍'  # 定义模型类的别名
        verbose_name_plural = verbose_name  # 模型类的复数形式

    def __str__(self):
        return self.name

后台层admin.py 创建登录admin页面

from django.contrib import admin

from . import models

admin.site.register(models.Book)

数据库迁移

>: python manage.py makemigrations
>: python manage.py migrrate

创建超级用户

>:createsuperuser

视图层：views.py

from django.http import JsonResponse
from django.views import View
# Create your views here.
from . import models
from rest_framework.views import APIView
class Book(View):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk', None)
        if pk: #单查
            book_dic = models.Book.objects.filter(pk=pk).values('name', 'price').first()
            results = book_dic
        else: # 群查
            book_query = models.Book.objects.values('name', 'price')
            results = list(book_query)

        if not results:
            return JsonResponse({
                'status': 1,
                'msg': 'data error'
            })
        return JsonResponse({
            'status': 0,
            'msg': 'ok',
            'results': results
        })

drf的请求模块

'''
drf的请求模块
1.drf的request是在wsgi的request基础上再次封装
2.wsgi的request作为drf的request一个属性：_request
3.新的request对旧的request做了完全兼容
4.新的request对数据解析更规范化：所有的拼接参数都解析到query_params中，所有数据包数据都被解析到data中
5.query_params和data都属于QueryDict类型，可以通过.dict()转化成原生dict类型
'''

源码分析

'''
源码分析
1.drf的APIView类：重写了as_view(),但主体逻辑还是调用父类的View的as_view(),局部禁用了csrf认证
    重点：所有继承drf的基本视图类APIView的视图类，都不在做csrf认证校验
2.drf的APIView类：重写了dispatch(),在内部对request进行了二次封装：self.initialize_request(request, *args, **kwargs)
    内部核心：
        走drf的Request初始化方法__init__:self._request = request
        drf的Request的getter方法__getattr__:先从self._request反射取属性，没取到再从drf.request中取       
核心：request除了可以访问原wsgi协议的request所有内容，还可以访问 query_params、data
'''

使用drf写的get/post请求

class BookAPIView(APIView):
    def get(self, request, *args, **kwargs):
        # url拼接的参数
        # 二次封装方式的request
        print(request._request.GET)  #<QueryDict: {'111': ['123']}>
        # 兼容
        print(request.GET)   #<QueryDict: {'111': ['123']}>
        
        print(request.META)
        # 拓展的属性方法
        print(request.query_params)  #<QueryDict: {'111': ['123']}>

        return Response({
            'status': 0,
            'msg': 'get_ok'
        })

    def post(self, request, *args, **kwargs):
        # 所有请求方式携带的数据包
        # 二次封装方式的request
        print(request._request.POST)  #<QueryDict: {'xyz': ['666']}>
        # 兼容
        print(request.POST)  #<QueryDict: {'xyz': ['666']}>
        
        print(request.META.get('HTTP_AUTH'))  #None
        # 拓展，兼容性最强，三种数据方式都可以
        print(request.data)  #数据包数据<QueryDict: {'xyz': ['666']}>

        print(request.query_params) #拼接数据<QueryDict: {'111': ['123']}>
        

渲染模块

浏览器和Postman请求结果渲染数据的方式不一样

总结

'''
drf的渲染模块（了解）
1.可以在视图类中通过renderer_classes类属性对该视图的数据响应渲染做配置 - 局部配置
2.可以在项目的配置文件中的drf配置中通过DEFAULT_RENDERER_CLASSES对该视图的数据响应渲染做配置 - 全局配置
注：如果有一个视图类在有全局配置下，还进行了局部配置，优先走自己的局部配置
'''
'''
""" 渲染模块源码分析
1、二次处理响应对象：APIView的dispatch方法 - self.finalize_response(request, response, *args, **kwargs)
2、获取渲染类对象：进入finalize_response方法 - self.perform_content_negotiation(request, force=True)
3、从配置文件中得到渲染类对象：perform_content_negotiation -> self.get_renderers() -> [renderer() for renderer in self.renderer_classes]
"""
"""
核心：可以全局和局部配置视图类支持的结果渲染：默认可以json和页面渲染，学习该模块的目的是开发可以全局只配置json方式渲染
"""
'''

全局配置：所有视图类统一处理，在项目的settings.py中

REST_FRAMEWORK = {
    # drf提供的渲染类
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer',  # 以后项目中可只配json格式
        'rest_framework.renderers.BrowsableAPIRenderer',
    ],
}

局部配置：某一个或一些实体类单独处理，在views.py视图类中提供对应的类属性

from rest_framework.renderers import JSONRenderer, BrowsableAPIRenderer
class BookAPIView(APIView):
    # 渲染模块的局部配置
    # 局部禁用就配置为renderer_classes = []
    # renderer_classes = [JSONRenderer]  #建议以后都使用这种
    # renderer_classes = [BrowsableAPIRenderer]

    def get(self, request, *args, **kwargs):
        print(request._request.GET)  #<QueryDict: {'111': ['123']}>
        print(request.GET)   #<QueryDict: {'111': ['123']}>
        print(request.META)
        print(request.query_params)  #<QueryDict: {'111': ['123']}>

        return Response({
            'status': 0,
            'msg': 'get_ok'
        })

解析模块

为什么要配置解析模块

1）drf给我们提供了多种解析数据包方式的解析类  form-data/urlencoded/json
2）我们可以通过配置来控制前台提交的哪些格式的数据后台在解析，哪些数据不解析
3）全局配置就是针对每一个视图类，局部配置就是针对指定的视图来，让它们可以按照配置规则选择性解析数据

总结

'''
drf的解析模块(了解） - 服务的对象是数据包数据
1.可以在视图中通过parser_classes类属性对该视图的数据包解析做配置 - 局部配置
2.可以在项目的配置文件的drf配置中通过DEFAULT_PARSER_CLASSES对该视图的数据包解析做配置 - 全局配置
'''
""" 解析模块源码分析
1、APIView的dispatch方法：self.initialize_request(request, *args, **kwargs)内部还提供了数据解析
2、self.get_parser_context(request)提供要解析的数据，self.get_parsers()提供解析的类对象（内部从配置中找解析类）
"""
"""
核心：请求的数据包格式会有三种（json、urlencoded、form-data），drf默认支持三种数据的解析，可以全局或局部配置视图类具体支持的解析方式
"""

全局配置：项目settings.py文件

REST_FRAMEWORK = {
    # 全局解析类配置
    'DEFAULT_PARSER_CLASSES': [
        'rest_framework.parsers.JSONParser',  # json数据包
        'rest_framework.parsers.FormParser',  # urlencoding数据包
        'rest_framework.parsers.MultiPartParser'  # form-date数据包
    ],
}

局部配置：应用views.py的具体视图类（设置了局部就不用设置全局）

# 解析模块的局部配置
    parser_classes = [JSONParser,MultiPartParser,FormParser]
    def post(self, request, *args, **kwargs):
        print(request._request.POST)  #<QueryDict: {'111': ['123']}>
        print(request.POST)   #<QueryDict: {'111': ['123']}>
        print(request.META)
        print(request.query_data)  #<QueryDict: {'111': ['123']}>

        return Response({
            'status': 0,
            'msg': 'post_ok'
        })

代码示例

在局部设置只能解析json格式数据，在postman其他格式传递的数据都不显示

url拼接的参数就是通过?拼接的参数，通过request.query_params获取参数

数据包传参通过request.data获取参数

from . import models
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.parsers import JSONParser,                            MultiPartParser,FormParser  #用作解析类 

class Book(APIView):

    # 局部解析类配置,post提交数据只能解析json格式数据
    parser_classes = [JSONParser]
    def post(self, request, *args, **kwargs):
        # url拼接参数：只有一种传参方式就是拼接参数
        print(request.query_params)
        # 数据包参数：有三种传承方式，form-data、urlencoding、json
        print(request.data)
        return Response('post ok')

异常模块

为什么要自定义异常模块

1）所有经过drf的APIView视图类产生的异常，都可以提供异常处理方案
2）drf默认提供了异常处理方案(rest_framework.views.exception_handler)，但是处理范围有限
3）drf提供的处理方案两种，处理了返回异常现象，没处理返回None(后续就是服务器抛异常给前台)
4）自定义异常的目的就是解决drf没有处理的异常，让前台得到合理的异常信息返回，后台记录异常具体信息

总结

""" 异常模块(重点)：重写异常模块目的是记录异常信息(项目上线)
1、在settings的drf配置中配置EXCEPTION_HANDLER，指向自定义的exception_handler函数
2、drf出现异常了，都会回调exception_handler函数，携带 异常对象和异常相关信息内容，
    在exception_handler函数完成异常信息的返回以及异常信息的logging日志
"""
""" 源码分析
1、在APIView的dispatch方法中，有一个超大的try...except...，将代码运行异常都交给异常处理模块处理self.handle_exception(exc)
2、从配置中映射出配置处理异常的函数(自定义异常模块就是自定义配置指向自己的函数)：self.get_exception_handler()
3、异常函数exception_handler(exc, context)处理异常，就会走自己的：
    先交给系统处理(客户端的异常)，系统没处理(服务器异常)，再自己处理
"""
"""
核心：异常信息都需要被logging记录，所以需要自定义；drf只处理客户端异常，服务器异常需要手动处理，统一处理结果
"""

源码分析

# 异常模块：APIView类的dispatch方法中
response = self.handle_exception(exc)  # 点进去

# 获取处理异常的句柄(方法)  
# 一层层看源码，走的是配置文件，拿到的是rest_framework.views的exception_handler
# 自定义：直接写exception_handler函数，在自己的配置文件配置EXCEPTION_HANDLER指向自己的
exception_handler = self.get_exception_handler()

# 异常处理的结果  # 自定义异常就是提供exception_handler异常处理函数，处理的目的就是让response一定有值
response = exception_handler(exc, context)

如何使用：自定义exception_handler函数如何书写实现体

# 修改自己的配置文件setting.py
REST_FRAMEWORK = {
    # 全局配置异常模块
     'EXCEPTION_HANDLER': 'app01.utils.exception_handler',  #设置自定义异常文件路径
}

api应用下创建处理异常文件exception.py (在get查询或者post提交的时候有异常都会走这里)

# 异常模块 处理方案
# 终极版
# 1）先将异常处理交给rest_framework.views的exception_handler去处理
# 2）判断处理的结果(返回值)response，有值代表drf已经处理了，None代表需要自己处理
from rest_framework.response import Response
from rest_framework.views import exception_handler as drf_exception_handler
from rest_framework import status
# 自定义异常处理文件exception，在文件中书写exception_handler函数
def exception_handler(exc, context):
    # exc:错误原因
    # context:错误信息
    # drf的exception_handler做基础处理
    response = drf_exception_handler(exc,context)
    # 为空，自定义二次处理
    if response is None: # 表示drf没有处理的异常（服务器异常）
        return Response(status=status.HTTP_500_INTERNAL_SERVER_ERROR, data={
            'status': 7,
            'exc': '%s' % exc
        })

    # 在项目阶段，一定要记录到日志文件
    return Response(status=response.status_code, data={
        'status': 7,
        # drf处理的客户端异常，原始处理方式是将异常信息放在response对象的data中，data的格式是{'datail':'具体的异常信息'}
        'exc': '%s' % response.data.get('datail')
    })

响应模块

总结

""" 响应模块
Response类生成对象需要的参数，以及Response类的对象可以使用的属性
1、参数：Response(data=响应的数据, status=响应的网络状态码, headers=想通过响应头再携带部分信息给前端)
2、属性：response.data  response.status_code  response.status_text

源码：Response类的__init__方法
"""
"""
核心：知道response对象产生可以传那些信息，response对象又是如何访问这些信息的
"""

响应类构造器：rest_framework.response.Response

def __init__(self, data=None, status=None,
                 template_name=None, headers=None,
                 exception=False, content_type=None):
     """
        :param data: 响应数据
        :param status: http响应状态码
        :param template_name: drf也可以渲染页面，渲染的页面模板地址（不用了解）
        :param headers: 响应头
        :param exception: 是否异常了
        :param content_type: 响应的数据格式（一般不用处理，响应头中带了，且默认是json）
    """
    pass

使用：常规实例化相应对象

# status就是解释一堆 数字 网络状态码的模块
from rest_framework import status就是解释一堆 数字 网络状态码的模块
# 一般情况下只需要返回数据，status和headers都有默认值
return Response(data={数据}, status=status.HTTP_200_OK, headers={设置的响应头})

from rest_framework.response import Response
from rest_framework.views import exception_handler as                 drf_exception_handler
from rest_framework import status

def exception_handler(exc, context):
    response = drf_exception_handler(exc,context)

    if response is None: # 表示drf没有处理的异常（服务器异常）
        # 响应模块知识
        return Response(status=status.HTTP_500_INTERNAL_SERVER_ERROR, data={
            'status': 7,
            'exc': '%s' % exc
        })

    # 在项目阶段，一定要记录到日志文件
    # 响应模块知识 （status=response.status_code 表示drf内部能够处理的异常自封装的状态码）
    return Response(status=response.status_code, data={
        'status': 7,
        # drf处理的客户端异常，原始处理方式是将异常信息放在response对象的data中，data的格式是{'datail':'具体的异常信息'}
        'exc': '%s' % response.data.get('detail')
    })

来源：https://www.cnblogs.com/chmily/p/11935045.html