## drf框架
#### 全称：django-rest framework
#### 知识点
""" 1、接口：什么是接口、restful接口规范 2、CBV生命周期源码 - 基于restful规范下的CBV接口 3、请求组件、解析组件、响应组件 4、序列化组件(灵魂) 5、三大认证(重中之重)：认证、权限(权限六表)、频率 6、其余组件：过滤、筛选、排序、分页、路由 """
# 难点：源码分析
```
## 接口
接口：联系两个物质的媒介，完成信息交互
web程序中：联系前台页面与后台数据库的媒介
web接口组成：
url：长得像放回数据的url连接
请求参数：前台按照指定的key提供数据给后台
响应数据：后台与数据库交互后将数据反馈给前台
"""
```
## 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连接 ```
## 基于restful规范的原生Django接口
##### 主路由：url.py
```python from django.conf.urls import url, include from django.contrib import admin urlpatterns = [ url(r'^admin/', admin.site.urls), # 路由分发
url(r'^api/', include('api.urls')) ] ``` ##### api组件的子路由：api/url.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()), ]
##### 模型层：model.py
from django.db import models class Book(models.Model): title = models.CharField(max_length=64) price = models.DecimalField(max_digits=5, decimal_places=2) class Meta: db_table = 'old_boy_book' verbose_name = '书籍' verbose_name_plural = verbose_name def __str__(self): return '《%s》' % self.title
##### 后台层：admin.py
from django.contrib import admin from . import models admin.site.register(models.Book) #注册
##### 数据库迁移
```
>: python manage.py makemigrations >: python manage.py migrrate >: python manage.py createsuperuser ```
##### 视图层：views.py
from django.http import JsonResponse
from django.views import View
from . import models
# 六大基础接口：获取一个 获取全部 增长一个 删除一个 总体更新一个 局部更新一个
# 十大接口：群增 群删 总体改群改 局部改群改
class Book(View): def get(self, request, *args, **kwargs): pk = kwargs.get('pk') if not pk: # 群查
# 操做数据库
book_obj_list = models.Book.objects.all() # 序列化过程
book_list = [] for obj in book_obj_list: dic = {} dic['title'] = obj.title dic['price'] = obj.price book_list.append(dic) # 响应数据
return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': book_list }, json_dumps_params={'ensure_ascii': False}) else: # 单查
book_dic = models.Book.objects.filter(pk=pk).values('title', 'price').first() if book_dic: return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': book_dic }, json_dumps_params={'ensure_ascii': False}) return JsonResponse({ 'status': 2, 'msg': '无结果', }, json_dumps_params={'ensure_ascii': False}) # postman能够完成不一样方式的请求：get | post | put ...
# postman发送数据包有三种方式：form-data | urlencoding | json
# 原生django对urlencoding方式数据兼容最好
def post(self, request, *args, **kwargs): # 前台经过urlencoding方式提交数据
try: book_obj = models.Book.objects.create(**request.POST.dict()) if book_obj: return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': {'title': book_obj.title, 'price': book_obj.price} }, json_dumps_params={'ensure_ascii': False}) except: return JsonResponse({ 'status': 1, 'msg': '参数有误', }, json_dumps_params={'ensure_ascii': False}) return JsonResponse({ 'status': 2, 'msg': '新增失败', }, json_dumps_params={'ensure_ascii': False}) ```
## Postman接口工具
官网下载
## DRF框架
##### 安装
```
>: pip3 install djangorestframework
```
##### drf框架规矩的封装风格
# 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 # setting
from rest_framework.filters import SearchFilter # 过滤
from rest_framework.pagination import PageNumberPagination # 分页
from rest_framework.authentication import TokenAuthentication # token认证
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) 完成任务方法交给视图类的请求函数处理，获得请求的响应结果，返回给前台
## 请求模块：request对象
##### 源码入口
APIView类的dispatch方法中：request = self.initialize_request(request, *args, **kwargs)
class Test(APIView): def get(self, request, *args, **kwargs): print(request._request.GET) # 二次封装
print(request.GET) # 兼容
print(request.query_params) # 推荐使用，拓展
return Response("你好靓仔！") def post(self, request, *args, **kwargs): # 全部请求方式携带的数据包
print(request._request.POST) # 二次封装
print(request.POST) # 兼容
print(request.data) # 推荐使用，拓展,兼容性最强
return Response("你好靓仔！post")
# 总结：
# 1.drf对原生request作了二次封装，requset._request就是原生request
# 2.原生request对象的属性和方法均可以被drf的request对象直接访问（兼容）
# 3.drf请求的全部url拼接参数均被解析到query_params中，全部数据包都被解析到data中
# 二次封装获得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) """ ```
## 渲染模块：浏览器和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', ], } ```
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，完成的是全局配置，全部接口统一处理
##### 局部配置：某一个或一些实体类单独处理，在views.py视图类中提供对应的类属性
# 若是只有部分接口特殊化，能够完成 - 局部配置
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') ```