目录
drf整体内容-APIView执行流程-Request对象源码分析-序列化器介绍和快速使用-反序列化-反序列化的校验
今日内容概要
-
0 drf整体内容
-
1 APIView执行流程(难 了解)
- 1.1 基于APIView+JsonRespons编写接口
- 1.2 基于APIView+Response写接口
- 1.3 APIView的执行流程
-
2 Request对象源码分析(难 了解)
-
3 序列化器介绍和快速使用
- 3.1 序列化类基本使用 序列化多条
- 3.2 序列化单条
-
4 反序列化
- 4.1 反序列化的新增
- 4.2 反序列化的修改
- 4.3 删除单条
-
5 基于序列化器辨析5个接口(重点)
-
6 反序列化的校验
今日内容详细
0 drf整体内容
# 1 入门规范
-web开发模式
-api接口
-接口测试工具
-restful规范
-序列化反序列化
-drf快速使用
-APIView，Request类
-drf把django的好多东西都重写了
# 2 序列化组件（重要）
-基本序列化类
-模型类序列化类
-如何序列化
-如何反序列化
-反序列化的数据校验功能
# 3 请求与响应
-drf的request已经不是原来django的request了
-drf的request已经不是原来django的request了
-指定可以接收请求的编码方式
-指定响应格式
# 4 视图组件（重点） View
-两个视图基类
-5个视图扩展类
-9个视图子类
-视图集
# 5 路由
-自动生成路由
# 6 认证（登录认证） 权限 频率（重点）
# 7 过滤 排序 分页（次重点）
# 8 自动生成接口文档
--------------------
# 9 JWT 登录认证的 区别与cookie和session 目前主流
# 10 后台管理美化（django原生的很丑 simpleui二次开发）
# 11 基于角色的访问控制 权限的控制
1 APIView执行流程（难 了解）
1.1 基于APIView+JsonResponse编写接口
# 原来基于django原生的View编写接口
# drf提供给咱们的一个类 以后使用def写视图类 都是继承这个类及其子类 APIView本身就是继承了Django原生的View
"""
from rest_framework.views import APIView
from .models import Publish
from django.http import JsonResponse
# Create your views here.
class PublishView(APIView):
def get(self, request):
publishs = Publish.objects.all()
publish_list = []
for publish in publishs:
publish_list.append({'name': publish.name, 'phone': publish.phone, 'address': publish.address})
return JsonResponse(publish_list, safe=False)
"""
1.2 基于APIView+Response写接口
from rest_framework.response import Response
class PublishView(APIView):
def get(self, request):
publishs = Publish.objects.all()
publish_list = []
for publish in publishs:
publish_list.append({'name': publish.name, 'phone': publish.phone, 'address': publish.address})
return Response(publish_list)
1.3 APIView的执行流程
# 路由中写的：path('books/', views.PublishView.as_view())---> 请求来了 执行views.PublishView.as_view()()---> 现在的as_view是APIView的as_view
# APIView的as_view方法：view还是原来的view 但是以后再也没有csrf认证了
@classmethod
def as_view(cls, **initkwargs):
# 调用父类的as_view 父类是django原生的view
# 把django原生的view的as_view方法中的闭包函数view拿出来
view = super().as_view(**initkwargs)
# csrf_exempt 排除所有csrf的认证
# 相当于在所有的方法上面加了这个装饰器
return csrf_exempt(view)
# 路由匹配成功 执行csrf_exempt(view)(requests)---> View的as_view中的闭包函数---> self.dispatch---> sele是视图类的对象---> PublishView---> APIView的dispatch中找到了
def dispatch(self, request, *args, **kwargs):
# request是django原生的request 老的request
# 把老的request包装成了新的request 这个是drf提供的Request类的对象
request = self.initialize_request(request, *args, **kwargs)
# 到此之后 这个request就是新的了 老的request在哪？
# request._request 这是老的
# 把新的request放到了self对象【这个self是PublishView】【就是我们写的视图】
self.request = request
try:
# 执行了三大认证【认证 频率 权限】 使用新的request 不读
self.initial(request, *args, **kwargs)
# 跟之前一模一样【将各种请求方式进行判断】
if request.method.lower() in self.http_method_names:
handler = getattr(self, request.method.lower(),
self.http_method_not_allowed)
else:
handler = self.http_method_not_allowed
# 把新的request传入了 视图类的方法中get的request也是新的
response = handler(request, *args, **kwargs)
except Exception as exc:
# 在执行三大认证和视图类中方法的过程中 如果出现了异常 都能捕获到---> 全局异常捕获
response = self.handle_exception(exc)
self.response = self.finalize_response(request, response, *args, **kwargs)
return self.response
# 总结：APIView的执行流程
1.去除了所有的csrf
2.包装了新的request 以后在视图类中用的request是新的request Request类的对象 不是原生的了
3.在执行视图类的方法之前 执行了三大认证
4.如果在三大认证或视图函数方法执过程中出了错 会有异常捕获---> 全局异常捕获
5.以后视图类方法中的request都是新的了
"""
# 补充：装饰器的基本使用
def auth() # 装饰器
def add() # 函数
# 使用auth装饰add函数
@auth # 本质是 add=auth(add)
def add()
# 以后再使用add 其实就是在使用auth(add) 的返回结果
"""
2 Request对象源码分析(难 了解)
# 新的Request---> 区别于老的
# 老的：django.core.handlers.wsgi.WSGIRequest
# 新的：from rest_framework.request import Request
-新的request._request 点出来的是老的
# Request源码
-方法 __getattr__
-在视图类的方法中 执行request.method 新的request是没有method的 就触发了新的Request的__getattr__方法的执行
def __getattr__(self, attr):
try:
# 从老的request中反射出 要取得属性
return getattr(self._request, attr)
except AttributeError:
return self.__getattribute__(attr)
-request.data---> 这是个方法 包装成了数据属性
-以后无论post put... 放在body中提交的数据 都从request.data中取 取出来就是字典
-无论是哪种编码格式
-request.query_params---> 这是个方法 包装成了数据属性
-get请求携带的参数 以后从这里面取
-query_params：查询参数---> restful规范请求地址中带查询参数
-request.FILES---> 这是个方法 包装成了数据属性
-前端提交过来的文件 从这里取
# Request类总结
-1 新的request用起来 跟之前一模一样 因为新的取不到 会取老的__getattr__
-2 request.data 无论什么编码 什么请求方式 只要是body中的数据 就从这里取---> 字典形式
-3request.query_params 就是原来的request._request.GET
-4上传的文件从request.FILES
# python 中有很多魔法方法 在类中 某种情况下触发 会自动执行
-__str__:打印对象会调用
-__init__:类+() 会调用
-__call__:对象+() 会调用
-__new__:创建新对象
-__getattr__: 对象.属性 如果属性不存在 会触发它的执行(反射)
3 序列化器介绍和快速使用
# 因为咱们在写接口时 需要序列化 需要反序列化 而且反序列化的过程中要做数据校验---> drf直接提供了固定的写法 只要按照固定写法使用 就能完成上面的三个需求
# 提供了两个类 Serializer ModelSerializer
-以后咱们只需要写自己的类 继承drf提供的序列化类 使用其中的某些方法 就能完成上面的操作
# 使用APIView+序列化类+Response 完成接口的编写
3.1序列化类基本使用 序列化多条
serializer.py---> PublishSerializer类
# 自己写一个py文件来存储PublishSerializer类
from rest_framework import serializers
class PublishSerializer(serializers.Serializer):
# 序列化某些字段 这里写要序列化的字段
name = serializers.CharField()
# serializers下大致跟models下的类是对应的
phone = serializers.CharField()
address = serializers.CharField()
views.py---> PublishView视图
# 这就是之前的视图
from .serializer import PublishSerializer
class PublishView(APIView):
def get(self, request):
publishs = Publish.objects.all()
# 使用序列化类来完成---> 得有个序列化类
# instance要序列化的数据 publishs queryset对象
# many=True 只要是queryset对象要传many=True 如果是单个对象就不用传
ser = PublishSerializer(instance=publishs, many=True)
return Response(ser.data) # 无论是列表还是字典都可以序列化
3.2 序列化单条
序列化类---> 没有动
# serializer.py一模一样
视图类---> PublishDetaView
class PublishDetaView(APIView):
# def get(self, pk):
def get(self, request, *args, **kwargs):
# publish = Publish.objects.filter(pk=pk).first()
publish = Publish.objects.filter(pk=kwargs.get('pk')).first()
# 序列化
ser = PublishSerializer(instance=publish) # 单个不需要加many=True
return Response(ser.data)
url新路由，匹配携带的pk
path('publishs/<int:pk>/', views.PublishDetaView.as_view()),
4 反序列化
4.1 反序列化的新增
序列化类
class PublishSerializer(serializers.Serializer):
# 序列化某些字段 这里写要序列化的字段
name = serializers.CharField()
# serializers下大致跟models下的类是对应的
phone = serializers.CharField()
address = serializers.CharField()
def create(self, validated_data):
# 保存的逻辑
# validated_data 校验过后的数据 {name,phone,publish}
# 保存到数据库
publish = Publish.objects.create(**validated_data)
# 一定要返回新增的对象
return publish
视图类
from .serializer import PublishSerializer
class PublishView(APIView):
def post(self, request):
# 把前端传过来的要保存的数据 传给data
ser = PublishSerializer(data=request.data)
# 校验数据
if ser.is_valid():
# 保存---> 需要自己写 要在序列化类PublishSerializer中写---> create方法
ser.save() # 调用ser.save 自动触发咱们写的create 保存起来
return Response({'code': 10000, 'msg': '新增成功', 'result': ser.data})
else:
return Response({'code': 10001, 'msg': ser.errors})
4.2 反序列化的修改
序列化类
def update(self, instance, validated_data):
# instance要修改的数据
# validated_data校验过后的数据
instance.name = validated_data.get('name')
instance.phone = validated_data.get('phone')
instance.address = validated_data.get('address')
instance.save() # orm的单个对象 修改了单个对象的属性 只要调用对象.save 就能把修改保存到数据库
return instance # 不要忘了把修改后的对象 返回
视图类
class PublishDetaView(APIView):
def put(self, request, pk):
publish = Publish.objects.filter(pk=pk).first()
# 反序列化保存---> 借助于序列化类
ser = PublishSerializer(data=request.data, instance=publish)
if ser.is_valid():
ser.save() # 没有重写update的话会报错
return Response({'code': 10000, 'msg': '修改成功', 'result': ser.data})
else:
return Response({'code': 10001, 'msg': ser.errors})
4.3 删除单条
视图类
def delete(self, request, pk):
Publish.objects.filter(pk=pk).delete()
return Response({'code': 10000, 'msg': '删除成功'})
6 反序列化的校验
# 序列化类反序列化 数据校验功能---> 类比forms组件
-局部钩子
-全局钩子
在serializer.py里写
from rest_framework import serializers
from .models import Publish
from rest_framework.validators import ValidationError
class PublishSerializer(serializers.Serializer):
# 序列化某些字段 这里写要序列化的字段
name = serializers.CharField()
# serializers下大致跟models下的类是对应的
phone = serializers.CharField()
address = serializers.CharField()
def create(self, validated_data):
# 保存的逻辑
# validated_data 校验过后的数据 {name,phone,publish}
# 保存到数据库
publish = Publish.objects.create(**validated_data)
# 一定要返回新增的对象
return publish
def update(self, instance, validated_data):
# instance要修改的数据
# validated_data校验过后的数据
instance.name = validated_data.get('name')
instance.phone = validated_data.get('phone')
instance.address = validated_data.get('address')
instance.save() # orm的单个对象 修改了单个对象的属性 只要调用对象.save 就能把修改保存到数据库
return instance # 不要忘了把修改后的对象 返回
# 反序列化校验的局部钩子 名字不能以sb开头
def validate_name(self, name):
# 校验name是否合法
if name.startswith('sb'):
# 校验不通过 抛异常
raise ValidationError('不能以sb开头')
else:
return name
# 全局钩子
def validate(self, attrs):
# 校验过后的数据 出版社名字跟地址不能一致
if attrs.get('name') == attrs.get('address'):
raise ValidationError('出版社名字不能跟地址一样')
else:
return attrs
