drf框架

Posted 2020-11-16 xiongying4

drf框架

全称：django-rest framework

1.接口

接口：联系两个物质的媒介，完成信息交互

web程序中：联系前台页面与后台数据库的媒介

web接口组成：

      url：长得像放回数据的url链接

      请求参数：前台按照指定的key提供数据给后台

      响应数据：后台与数据库交互后将数据反馈给前台

2.restful接口规范

接口规范：就是为了采用不同的后台语言，也能使用同样的接口获取同样的数据

如何写接口：接口规范是规范化书写接口，写接口要写url、响应数据

(注：如果将请求数据也纳入考量范围，那就是在写接口文档)

url

1) 用api关键字标识接口url
    api.baidu.com | www.baidu.com/api
    
2) 接口数据安全性决定优先选择https协议
?
3) 如果一个接口有多版本存在，需要在url中标识体现
    api.baidu.com/v1/... | api.baidu.com/v2/...
    
4) 接口操作的数据源称之为 资源，在url中一般采用资源复数形式，一个接口可以概括对该资源的多种操作方式
    api.baidu.com/books | api.baidu.com/books/(pk)
    
5) 请求方式有多种，用一个url处理如何保证不混乱 - 通过请求方式标识操作资源的方式
    /books      get         获取所有
    /books      post        增加一个(多个)
    /books/(pk) delete      删除一个
    /books/(pk) put         整体更新一个
    /books/(pk) patch       局部更新一个
?
6) 资源往往涉及数据的各种操作方式 - 筛选、排序、限制
    api.baidu.com/books/?search=西&ordering=-price&limit=3

响应数据

1) http请求的响应会有响应状态码，接口用来返回操作的资源数据，可以拥有 操作数据结果的 状态码
    status  0(操作资源成功)  1(操作资源失败)  2(操作资源成功，但没匹配结果)
    注：资源状态码不像http状态码，一般都是后台与前台或是客户约定的
    
2) 资源的状态码文字提示
    status  ok  ‘账号有误‘  ‘密码有误‘  ‘用户锁定‘
    
3) 资源本身
    results
    注：删除资源成功不做任何数据返回(返回空字符串)
    
4) 不能直接放回的资源(子资源、图片、视频等资源)，返回该资源的url链接

3.Postman接口工具

 postman可以完成不同方式的请求：get | post | put ...
 get请求，携带参数采用Params
 postman发送数据包有三种方式：form-data | urlencoding | json
 原生django对urlencoding方式数据兼容最好
 所有请求都可以携带请求头

4.drf框架

安装

>: pip3 install djangorestframework

drf框架规矩的封装风格

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.request import Request
from rest_framework.serializers import Serializer
from rest_framework.settings import APISettings
from rest_framework.filters import SearchFilter
from rest_framework.pagination import PageNumberPagination
from rest_framework.authentication import TokenAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework.throttling import SimpleRateThrottle
?
class Test(APIView):
    def get(self, request, *args, **kwargs):
        return Response(‘drf get ok‘)

drf请求生命周期

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

5.请求模块：request对象

源码入口

APIView类的dispatch方法中：request = self.initialize_request(request, *args, **kwargs)

源码分析

"""
# 二次封装得到def的request对象
request = self.initialize_request(request, *args, **kwargs) 点进去
?
# 在rest_framework.request.Request实例化方法中
self._request = request  将原生request作为新request的_request属性
?
# 在rest_framework.request.Request的__getattr__方法中
try:
    return getattr(self._request, attr)  # 访问属性完全兼容原生request
except AttributeError:
    return self.__getattribute__(attr)
"""

重点总结

 1) drf 对原生request做了二次封装，request._request就是原生request
 2) 原生request对象的属性和方法都可以被drf的request对象直接访问(兼容)
 3) drf请求的所有url拼接参数均被解析到query_params中，所有数据包数据都被解析到data中
class Test(APIView):
    def get(self, request, *args, **kwargs):
        # url拼接的参数
        print(request._request.GET)  # 二次封装方式
        print(request.GET) # 兼容
        print(request.query_params) # 拓展
?
        return Response(‘drf get ok‘)
?
    def post(self, request, *args, **kwargs):
        # 所有请求方式携带的数据包
        print(request._request.POST)  # 二次封装方式
        print(request.POST)  # 兼容
        print(request.data)  # 拓展，兼容性最强，三种数据方式都可以
?
        print(request.query_params)
?
        return Response(‘drf post ok‘)

6.渲染模块（浏览器和Postman请求结果渲染数据的方式不一样）

源码入口

APIView类的dispatch方法中：self.response = self.finalize_response(request, response, *args, **kwargs)

源码分析

"""
# 最后解析reponse对象数据
self.response = self.finalize_response(request, response, *args, **kwargs) 点进去
?
# 拿到运行的解析类的对象们
neg = self.perform_content_negotiation(request, force=True) 点进去
?
# 获得解析类对象
renderers = self.get_renderers() 点进去
?
# 从视图类中得到renderer_classes请求类，如何实例化一个个对象形参解析类对象列表
return [renderer() for renderer in self.renderer_classes]
?
?
# 重点：self.renderer_classes获取renderer_classes的顺序
#   自己视图类的类属性(局部配置) => 
#   APIView类的类属性设置 => 
#   自己配置文件的DEFAULT_RENDERER_CLASSES(全局配置) => 
#   drf配置文件的DEFAULT_RENDERER_CLASSES
"""

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

REST_FRAMEWORK = {
    # drf提供的渲染类
    ‘DEFAULT_RENDERER_CLASSES‘: [
        ‘rest_framework.renderers.JSONRenderer‘,
        ‘rest_framework.renderers.BrowsableAPIRenderer‘,
    ],
}

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

class Test(APIView):
    def get(self, request, *args, **kwargs):
        return Response(‘drf get ok‘)
?
    def post(self, request, *args, **kwargs):
        return Response(‘drf post ok‘)
?
# 在setting.py中配置REST_FRAMEWORK，完成的是全局配置，所有接口统一处理
# 如果只有部分接口特殊化，可以完成 - 局部配置
from rest_framework.renderers import JSONRenderer
class Test2(APIView):
    # 局部配置
    renderer_classes = [JSONRenderer]
    def get(self, request, *args, **kwargs):
        return Response(‘drf get ok 2‘)
?
    def post(self, request, *args, **kwargs):
        return Response(‘drf post ok 2‘)