目录
- 一、drf 整体内容
- 二、APIView执行流程——源码分析（难，了解）
- 三、Request对象源码分析（难，了解）
- 四、序列化器介绍和快速使用(重点)
- 五、反序列化(重点)
- 六、完整的代码
- 七、反序列化的校验
- 八、作业
一、drf 整体内容
# 1 入门规范
-web开发模式
-api接口
-接口测试工具
-restful规范
-序列化反序列化
-drf快速使用
-APIView，Request类
-drf把django的好多东西都重写了
# 2 序列化组件(重要)
-基本序列化类
-模型类序列化类
-如何序列化
-如何反序列化
-反序列化的数据校验功能
# 3 请求与响应
-drf的request已经不是原来djagno的request了
-drf的reponse已经不是原来djagno的reponse了
-指定可以接收请求的编码方式
-指定响应格式
# 4 视图组件（重点） View
-两个视图基类
-5个视图扩展类
-9个视图子类
-视图集
# 5 路由
-自动生成路由
# 6 认证(登录认证)，权限，频率 （重点）
# 7 过滤，排序，分页（次重点）
# 8 自动生成接口文档
-----------拓展-----------
# 9 JWT 登录认证的，区别与cookie和session，主流
# 10 后台管理美化（django原生的很丑，simpleui二次开发）
# 11 基于角色的访问控制，权限的控制
二、APIView执行流程——源码分析（难，了解）
2.1 基于APIView+JsonResponse编写接口
# 原来基于django原生的View编写接口
# drf提供给咱们的一个类，以后使用drf写视图类，都是继承这个类及其子类，APIView本身就是继承了Django原生的View
class BookView(APIView):
def get(self, request):
books = Book.objects.all()
book_list = []
for book in books:
book_list.append({'name': book.name, 'price': book.price, 'publish': book.publish})
return JsonResponse(book_list, safe=False)
2.2 基于APIView+Response 写接口
class BookView(APIView):
def get(self, request):
books = Book.objects.all()
book_list = []
for book in books:
book_list.append({'name': book.name, 'price': book.price, 'publish': book.publish})
return Response(book_list) # 无论是列表还是字典都可以序列化，同时也不需要JsonResponse的参数了
2.3 APIView的执行流程
路由中写的：
path('books/', views.BookView.as_view()),---》请求来了，执行views.BookView.as_view()()----->现在的as_view是APIView的as_view（因为我们把父类从View换成了APIView）
我们点进源码查看可以发现APIView其实继承了View
class APIView(View):
往下查找as_view()的代码
# APIView的as_view方法：view还是原来的view，但是以后再也没有csrf认证了
@classmethod
def as_view(cls, **initkwargs):
# 调用父类的as_view，父类是django原生的View
# 把djagno原生View的as_view方法中的闭包函数view拿出来了
view = super().as_view(**initkwargs)
# csrf_exempt 排除所有csrf的认证
# 相当于在所有的方法上面加了这个装饰器
return csrf_exempt(view)
'从他内部的view我们可以看到他是用派生方法调用父类View中的as_view因此我们说view还是原来的view，但是返回的结果是csrf_exempt(view)，回顾装饰器的知识，我们可以知道虽然我们把装饰器写成了语法糖，但是在运行的时候其实就是把被装饰的函数名称传进来当参数运行，因此这里就是取消了csrf认证的作用'
# 路由匹配成功，执行的其实就是 csrf_exempt(view)(requets)--->而这个view就是View的as_view中的闭包函数view---》然后执行self.dispatch---->self是视图类的对象---》BookiView产生的对象---》这时候会执行self.dispatch，根据名称的查找顺序他会查找到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对象【BookView的对象】
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:
# 在执行3大认证和视图类中方法的过程中，如果出了异常，都能捕获到---》全局异常捕获
response = self.handle_exception(exc)
self.response = self.finalize_response(request, response, *args, **kwargs)
return self.response
'上方的request调用了initialize_request方法，这个方法的返回结果产生了一个Request生成的对象，它的源码如下：'
def initialize_request(self, request, *args, **kwargs):
parser_context = self.get_parser_context(request)
return Request(
request,
parsers=self.get_parsers(),
authenticators=self.get_authenticators(),
negotiator=self.get_content_negotiator(),
parser_context=parser_context
)
'接着我们点进这个Request类的源码，我们会发现老的request变成了_request属性'
def __init__(self, request, parsers=None, authenticators=None,
negotiator=None, parser_context=None):
self._request = request
self.parsers = parsers or ()
self.authenticators = authenticators or ()
self.negotiator = negotiator or self._default_negotiator()
self.parser_context = parser_context
self._data = Empty
self._files = Empty
self._full_data = Empty
self._content_type = Empty
self._stream = Empty
# 总结：APIView的执行流程
1 去除了所有的csrf
2 包装了新的request，以后在视图类中用的request是新的request Request类的对象，不是原生的了
-原生的在：新的requets._request
3 在执行视图类的方法之前，执行了3大认证
4 如果在3大认证或视图函数方法执行过程中出了错，会有异常捕获----》全局异常捕获
5 以后视图类方法中的request都是新的了
# 补充：装饰器的基本原来
def auth() # 装饰器
def add() # 函数
# 使用auth装饰add函数
@auth # 本质是 add=auth(add)
def add()
# 以后再使用add，其实就是在使用 auth(add) 的返回结果
三、Request对象源码分析（难，了解）
新的Request---》区别于老的
老的：由django.core.handlers.wsgi.WSGIRequest 产生
新的：由from rest_framework.request import Request产生
-request现在是新的 request._request 获取到的是老的
通过查看源码我们发现他内部并没有我们常用的一些方法，如：method，但是我们在调用的时候缺可以跟之前一样使用，这时候我们发现了他内部有一个双下getattr的魔法方法（查找属性或方法不存在的时候会触发他），那我们根据目前学的知识，最可能是这里有玄机，点击来查看源码：
# 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--->这是个方法，包装成了数据属性
-request.GET请求携带的参数，以后从这里面取
-query_params：查询参数--->restful规范请求地址中带查询参数
-request.FILES--->这是个方法，包装成了数据属性
-前端提交过来的文件，从这里取
# Request类总结
-1 新的request用起来，跟之前一模一样，因为新的取不到，会取老的__getattr__
-2 request.data 无论什么编码，什么请求方式，只要是body中的数据，就从这里取，字典
-3 request.query_params 就是原来的request._request.GET
-4 上传的文件从request.FILES
# python 中有很多魔法方法,在类中，某种情况下触发，会自动执行
-__str__:打印对象会调用
-__init__:类() 会调用
-__call__: 对象() 会调用
-__new__:
-__getattr__：对象.属性，如果属性不存在，会触发它的执行
四、序列化器介绍和快速使用(重点)
# 因为咱么在写接口时，需要序列化，需要反序列化，而且反序列化的过程中要做数据校验---》drf直接提供了固定的写法，只要按照固定写法使用，就能完成上面的三个需求
# 提供了两个类 Serializer ModelSerializer
-以后咱们只需要写自己的类，继承drf提供的序列化类，使用其中的某些方法，就能完成上面的操作
# 使用APIView+序列化类+Response 完成接口的编写
4.1 序列化类基本使用，序列化多条（使用方式类似forms组件）
serializer.py--BookSerializer类
from rest_framework import serializers
class BookSerializer(serializers.Serializer):
# 序列化某些字段，这里写要序列化的字典
name = serializers.CharField() # serializers下大致跟models下的类是对应的
# price = serializers.CharField()
publish = serializers.CharField()
views.py--->BookView类
ps：我们在编写post请求添加数据的时候，需要注意，我们需要在serializer.py编写的BookSerializer类中添加一个create函数（不加他会报错，报错信息中的提示就是缺一个create函数，导致报错的原因是调用save的时候用到了create）
class BookView(APIView):
def get(self, request):
# 只是为了验证之前讲过的
print(request.method)
print(request._request)
print(type(self.request))
books = Book.objects.all()
# 使用序列化类来完成---》得有个序列化类
# instance要序列化的数据books queryset对象
# many=True 只要是queryset对象要传many=True，如果是单个对象就不用传
ser = BookSerializer(instance=books, many=True)
return Response(ser.data) # 无论是列表还是字典都可以序列化
def post(self, request):
# requset.data # 前端提交的要保存的数据----》校验数据---》存
ser = BookSerializer(data=request.data) # 把前端传入的要保存的数据，给data参数
# 校验数据
if ser.is_valid():
# 保存---->需要自己写，要在序列化类BookSerializer中写----》create方法
ser.save() # 调用ser.save,自动触发咱们写的create，保存起来
return Response({'code': 100, 'msg': '新增成功', 'result': ser.data})
else:
return Response({'code': 101, 'msg': ser.errors})
urls.py
urlpatterns = [
path('admin/', admin.site.urls),
path('books/', views.BookView.as_view()),
]
4.2 序列化单条
序列化类---没有动
from rest_framework import serializers
class BookSerializer(serializers.Serializer):
# 序列化某些字段，这里写要序列化的字典
name = serializers.CharField() # serializers下大致跟models下的类是对应的
# price = serializers.CharField()
publish = serializers.CharField()
视图类---》BookDetailView
class BookDetailView(APIView):
# def get(self, request,pk):
def get(self, request, *args, **kwargs):
book = Book.objects.filter(pk=kwargs.get('pk')).first()
# 序列化
ser = BookSerializer(instance=book)
return Response(ser.data)
url加了新的路由
urlpatterns = [
path('admin/', admin.site.urls),
path('books/', views.BookView.as_view()),
path('books/<int:pk>/', views.BookDetaView.as_view()),
]
五、反序列化(重点)
5.1 反序列化的新增
序列化类
class BookSerializer(serializers.Serializer):
# 序列化某些字段，这里写要序列化的字典
name = serializers.CharField() # serializers下大致跟models下的类是对应的
price = serializers.CharField()
publish = serializers.CharField()
def create(self, validated_data):
# 保存的逻辑
# validated_data 校验过后的数据 {name,price,publish}
# 保存到数据库
book = Book.objects.create(**validated_data)
# 一定不要返回新增的对象
return book
视图类
class BookView(APIView):
def post(self, request):
# requset.data # 前端提交的要保存的数据----》校验数据---》存
ser = BookSerializer(data=request.data) # 把前端传入的要保存的数据，给data参数
# 校验数据
if ser.is_valid():
# 保存---->需要自己写，要在序列化类BookSerializer中写----》create方法
ser.save() # 调用ser.save,自动触发咱们写的create，保存起来
return Response({'code': 100, 'msg': '新增成功', 'result': ser.data})
else:
return Response({'code': 101, 'msg': ser.errors})
5.2 反序列化的修改
序列化类
class BookSerializer(serializers.Serializer):
# 序列化某些字段，这里写要序列化的字典
name = serializers.CharField() # serializers下大致跟models下的类是对应的
price = serializers.CharField()
publish = serializers.CharField()
def create(self, validated_data):
# 保存的逻辑
# validated_data 校验过后的数据 {name,price,publish}
# 保存到数据库
book = Book.objects.create(**validated_data)
# 一定不要返回新增的对象
return book
def update(self, instance, validated_data):
# instance 要修改的对象
# validated_data 校验过后的数据
instance.name = validated_data.get('name')
instance.price = validated_data.get('price')
instance.publish = validated_data.get('publish')
instance.save() # orm的单个对象，修改了单个对象的属性，只要调用对象.save,就能把修改保存到数据库
return instance # 不要忘了吧修改后的对象，返回
视图类
class BookDetailView(APIView):
def put(self, request, pk):
book = Book.objects.filter(pk=pk).first()
# 反序列化保存 ---借助于序列化类
ser = BookSerializer(data=request.data, instance=book)
if ser.is_valid():
ser.save() # 由于没有重写update，所以这报错
return Response({'code': 100, 'msg': '修改成功', 'result': ser.data})
else:
return Response({'code': 101, 'msg': ser.errors})
5.3 删除单条
视图类
class BookDetailView(APIView):
def delete(self, request, pk):
Book.objects.filter(pk=pk).delete()
return Response({'code': 100, 'msg': '删除成功'})
六、完整的代码
models.py
from django.db import models
# Create your models here.
class Book(models.Model):
name = models.CharField(max_length=32)
price = models.CharField(max_length=32)
publish = models.CharField(max_length=32)
urls.py
from django.db import models
# Create your models here.
class Book(models.Model):
name = models.CharField(max_length=32)
price = models.CharField(max_length=32)
publish = models.CharField(max_length=32)
views.py
from django.shortcuts import render
# # rest_framework很规范，想导入什么拼写单词即可
# from rest_framework.request import Request
# from rest_framework.response import Response
from rest_framework.views import APIView
from django.http import JsonResponse # 原生的
from rest_framework.response import Response # drf提供的
from .models import Book
# 1 基于APIView+JsonResponse 写接口
# class BookView(APIView):
# def get(self, request):
# books = Book.objects.all()
# book_list = []
# for book in books:
# book_list.append({'name': book.name, 'price': book.price, 'publish': book.publish})
#
# return JsonResponse(book_list, safe=False)
# 基于APIView+Response 写接口
# class BookView(APIView):
# def get(self, request):
#
# print(request.GET)
#
#
# books = Book.objects.all()
# book_list = []
# for book in books:
# book_list.append({'name': book.name, 'price': book.price, 'publish': book.publish})
#
# return Response(book_list) # 无论是列表还是字典都可以序列化
# APIView和Response 之前没有用过
# 基于APIView+序列化类+Response 写接口
from .serializer import BookSerializer
class BookView(APIView):
def get(self, request):
# 只是为了验证之前讲过的
print(request.method)
print(request._request)
print(type(self.request))
books = Book.objects.all()
# 使用序列化类来完成---》得有个序列化类
# instance要序列化的数据books queryset对象
# many=True 只要是queryset对象要传many=True，如果是单个对象就不用传
ser = BookSerializer(instance=books, many=True)
return Response(ser.data) # 无论是列表还是字典都可以序列化
def post(self, request):
# requset.data # 前端提交的要保存的数据----》校验数据---》存
ser = BookSerializer(data=request.data) # 把前端传入的要保存的数据，给data参数
# 校验数据
if ser.is_valid():
# 保存---->需要自己写，要在序列化类BookSerializer中写----》create方法
ser.save() # 调用ser.save,自动触发咱们写的create，保存起来
return Response({'code': 100, 'msg': '新增成功', 'result': ser.data})
else:
return Response({'code': 101, 'msg': ser.errors})
class BookDetailView(APIView):
# def get(self, request,pk):
def get(self, request, *args, **kwargs):
book = Book.objects.filter(pk=kwargs.get('pk')).first()
# 序列化
ser = BookSerializer(instance=book)
return Response(ser.data)
def put(self, request, pk):
book = Book.objects.filter(pk=pk).first()
# 反序列化保存 ---借助于序列化类
ser = BookSerializer(data=request.data, instance=book)
if ser.is_valid():
ser.save() # 由于没有重写update，所以这报错
return Response({'code': 100, 'msg': '修改成功', 'result': ser.data})
else:
return Response({'code': 101, 'msg': ser.errors})
def delete(self, request, pk):
Book.objects.filter(pk=pk).delete()
return Response({'code': 100, 'msg': '删除成功'})
serializer.py(在app01中创建一个新的py文件写即可)
# from rest_framework.serializers import Serializer
from rest_framework import serializers
from rest_framework.exceptions import ValidationError
from .models import Book
class BookSerializer(serializers.Serializer):
# 序列化某些字段，这里写要序列化的字典
name = serializers.CharField() # serializers下大致跟models下的类是对应的
price = serializers.CharField()
publish = serializers.CharField()
def create(self, validated_data):
# 保存的逻辑
# validated_data 校验过后的数据 {name,price,publish}
# 保存到数据库
book = Book.objects.create(**validated_data)
# 一定不要返回新增的对象
return book
def update(self, instance, validated_data):
# instance 要修改的对象
# validated_data 校验过后的数据
instance.name = validated_data.get('name')
instance.price = validated_data.get('price')
instance.publish = validated_data.get('publish')
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('publish'):
raise ValidationError('书名跟出版社名字不能一致')
else:
return attrs
七、反序列化的校验
# 序列化类反序列化，数据校验功能--->类比forms组件
-局部钩子
-全局钩子
class BookSerializer(serializers.Serializer):
# 序列化某些字段，这里写要序列化的字典
name = serializers.CharField() # serializers下大致跟models下的类是对应的
price = serializers.CharField()
publish = serializers.CharField()
def create(self, validated_data):
# 保存的逻辑
# validated_data 校验过后的数据 {name,price,publish}
# 保存到数据库
book = Book.objects.create(**validated_data)
# 一定不要忘了返回新增的对象
return book
def update(self, instance, validated_data):
# instance 要修改的对象
# validated_data 校验过后的数据
instance.name = validated_data.get('name')
instance.price = validated_data.get('price')
instance.publish = validated_data.get('publish')
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('publish'):
raise ValidationError('书名跟出版社名字不能一致')
else:
return attrs
八、作业
1 基于序列化器编写5个接口 Publish
2 使用局部钩子和全局钩子校验 5个接口
models.py
from django.db import models
# Create your models here.
class Publish(models.Model):
name = models.CharField(max_length=32)
place = models.CharField(max_length=32)
urls.py
from django.contrib import admin
from django.urls import path
from app01 import views
urlpatterns = [
path('admin/', admin.site.urls),
path('publishes/',views.PublishFunction.as_view()),
path('publishes/<int:pk>/', views.PublishFunctionDateView.as_view()),
]
serializer.py
from rest_framework import serializers
from .models import Publish
from rest_framework.exceptions import ValidationError
class PublishSerializer(serializers.Serializer):
name = serializers.CharField()
place = serializers.CharField()
def create(self, validated_data):
publish = Publish.objects.create(**validated_data)
return publish
def update(self, instance, validated_data):
instance.name = validated_data.get('name')
instance.place = validated_data.get('place')
instance.save()
return instance
def validate_name(self,name):
if name.startswith('sb'):
raise ValidationError('不能以sb开头')
else:
return name
def validate(self, attrs):
if attrs.get('name') == attrs.get('place'):
raise ValidationError('出版社名称和地址不能一样')
else:
return attrs
views.py
from django.shortcuts import render
from rest_framework.views import APIView
from rest_framework.response import Response
from .models import Publish
from .serializer import PublishSerializer
# Create your views here.
class PublishFunction(APIView):
def get(self,request):
publishes = Publish.objects.all()
ser = PublishSerializer(instance=publishes, many=True)
return Response(ser.data)
def post(self,request):
ser = PublishSerializer(data=request.data)
if ser.is_valid():
# 说明条件都符合，添加数据到数据库
ser.save()
return Response({'code':100, 'msg':'添加成功'})
else:
return Response({'code':101, 'msg':ser.errors})
#
class PublishFunctionDateView(APIView):
def get(self,request,pk):
publish = Publish.objects.filter(pk=pk).first()
ser = PublishSerializer(instance=publish)
return Response(ser.data)
def put(self,request,*args,**kwargs):
publish = Publish.objects.filter(pk=kwargs.get('pk')).first()
ser = PublishSerializer(data=request.data, instance=publish)
if ser.is_valid():
ser.save()
return Response({'code':100, 'msg':'修改成功'})
else:
return Response({'code':101, 'msg':ser.errors})
def delete(self,request,pk):
Publish.objects.filter(pk=pk).delete()
return Response({'code':100, 'msg':'删除成功'})
3 原生的request 没有data 属性 实现一个原生的 request.data 拿出无论什么编码格式提交的数
FBV--->写个装饰条
def wrapper(func):
def inner(request,*args,**kwargs):
request=新的
res=func(request)
return res
return inner
@wrapper
def index(request):
print(request.data)