drf框架
全称: django-rest framework (framework:框架)
理论知识点
大纲
接口
接口: 联系连个物质的媒介, 完成信息交互
web程序中 : 联系前台页面与后台数据库的媒介
web 接口的组成 :
url: 统一资源定位符 长得像返回数据的链接
请求参数: 前台按照指定的key 提供数据给后台
响应数据: 后台与数据库交互后将数据反馈给前台
restful接口规范
接口规范：就是为了采用不同的后台语言，也能使用同样的接口获取到同样的数据
如何写接口：接口规范是 规范化书写接口的，写接口要写 url、响应数据 注：如果将请求参数也纳入考量范围，那就是在写 接口文档
分为两大部分: 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接口
注释 中间件 csrf 在app文件下创建子路由
主路由(注意点 include)
from django.conf.urls import url,include from django.contrib import admin from app01 import urls urlpatterns = [ url(r'^admin', admin.site.urls), url(r'^api/', include('app01.urls') ), ]
子路由(注意点: 有名分组)
from django.conf.urls import url from . import views urlpatterns = [ url(r'^books/$', views.Book.as_view()), # 匹配 更新删除的 id url(r'^books/(?P<pk>.*)/$', views.Book.as_view()), ]
models.py(注意点: meta 类 verbose db_table)
from django.db import models # Create your models here. # 图书表 class Books(models.Model): title = models.CharField(max_length=64) price = models.DecimalField(max_digits=5, decimal_places=2) # 修改 一个是数据库中的名字，一个是admin页面上的名字 class Meta: # 修改数据库显示表名 db_table = 'old_boy_book' verbose_name = '书籍' # 中文后不带s verbose_name_plural = verbose_name # 打印触发 def __str__(self): return f'<{self.title}>' # 执行数据库迁移命令 py3 manage.py make migrations py3 manage.py migrate # 在 tools 中 执行 run manage task # 把表添加到 admin中注册 # 创建超级用户 py3 manage.py createsuperuser
admin(注册表)
from django.contrib import admin # Register your models here. from . import models # 导入 models 注册 admin.site.register(models.Books)
views
from django.shortcuts import render # Create your views here. # 只需要 JsonResponse from django.http import JsonResponse from app01 import models # CBV # 导入 View from django.views import View class Book(View): # 重写post get 方法 参数 request , *args *kwargs # 六大基础接口 获取一个 获取所有 增加一个 删除一个 增加所有 整体更新一个 局部更新一个 # 十大接口 群增 群删 整体群改 局部改群改 def get(self, request, *args, **kwargs): # 获取 pk 有名分组 book_pk = kwargs.get('pk') # 判断有没有 有 单查 没有 群查 if not book_pk: book_obj_list = models.Books.objects.all() # 拿到book所有book对象 # 手动转 back_list = [] for book_obj in book_obj_list: book_dic = {} book_dic['title'] = book_obj.title book_dic['price'] = book_obj.price back_list.append(book_dic) # 响应数据 return JsonResponse({ 'status': 0, 'msg':'ok', 'result':back_list, },json_dumps_params={'ensure_ascii':False}) # 指定发送过去的 信息是中文 else: book_obj = models.Books.objects.filter(pk=book_pk).values('title','price').first() if book_obj: return JsonResponse({ 'status': 0, 'msg': 'ok', 'result': book_obj, }, 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): try: book_obj = models.Books.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接口工具
官网下载安装
get请求，携带参数采用Params
post等请求，提交数据包可以采用三种方式：form-date、urlencoding、json
所有请求都可以携带请求头
DRF框架安装
安装 pip install djangorestframework 卸载 pip uninstall 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
记住导入rest_framework 后必须在 settings里面注册
十月十一号补充 跨源问题
// 后台接收到前台的请求，可以接收前台数据与请求信息，发现请求的信息不是自身服务器发来的请求，拒绝响应数据，这种情况称之为 - 跨域问题（同源策略 CORS） // 导致跨域情况有三种 // 1) 端口不一致 // 2) IP不一致 // 3) 协议不一致 // Django如何解决 - django-cors-headers模块 // 1) 安装：pip3 install django-cors-headers // 2) 注册： INSTALLED_APPS = [ ... 'corsheaders' ] // 3) 设置中间件： MIDDLEWARE = [ ... 'corsheaders.middleware.CorsMiddleware' ] // 4) 设置跨域： CORS_ORIGIN_ALLOW_ALL = True
drf请求生命周期
补充 如何让django变中文 使用上海时间
LANGUAGE_CODE = 'zh-hans' TIME_ZONE = 'Asia/Shanghai' # 上海时间 USE_I18N = True USE_L10N = True USE_TZ = False # 保证存储到数据库中的是 UTC 时间
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)
源码分析
# 二次封装得到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')
源码入口
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
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，完成的是全局配置，所有接口统一处理 # 如果只有部分接口特殊化，可以完成 - 局部配置 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')