Serializers 序列化组件
为什么要用序列化组件
当我们做前后端分离的项目~~我们前后端交互一般都选择JSON数据格式，JSON是一个轻量级的数据交互格式。
那么我们给前端数据的时候都要转成json格式，那就需要对我们从数据库拿到的数据进行序列化。
接下来我们看下django序列化和rest_framework序列化的对比~~
Django的序列化方法
class BooksView(View):
def get(self, request):
book_list = Book.objects.values("id", "title", "chapter", "pub_time", "publisher")
book_list = list(book_list)
# 如果我们需要取外键关联的字段信息 需要循环获取外键 再去数据库查然后拼接成我们想要的
ret = []
for book in book_list:
pub_dict = {}
pub_obj = Publish.objects.filter(pk=book["publisher"]).first()
pub_dict["id"] = pub_obj.pk
pub_dict["title"] = pub_obj.title
book["publisher"] = pub_dict
ret.append(book)
ret = json.dumps(book_list, ensure_ascii=False, cls=MyJson)
return HttpResponse(ret) # json.JSONEncoder.default()解决json不能序列化时间字段的问题
class MyJson(json.JSONEncoder):
def default(self, field):
if isinstance(field, datetime.datetime):
return field.strftime('%Y-%m-%d %H:%M:%S')
elif isinstance(field, datetime.date):
return field.strftime('%Y-%m-%d')
else:
return json.JSONEncoder.default(self, field)
.values 序列化结果
from django.core import serializers # 能够得到我们要的效果 结构有点复杂
class BooksView(View):
def get(self, request):
book_list = Book.objects.all()
ret = serializers.serialize("json", book_list)
return HttpResponse(ret)
django serializers
DRF序列化的方法
首先，我们要用DRF的序列化，就要遵循人家框架的一些标准，
-- Django我们CBV继承类是View，现在DRF我们要用APIView
-- Django中返回的时候我们用HTTPResponse，JsonResponse，render ，DRF我们用Response
为什么这么用~我们之后会详细讲~~我们继续来看序列化~~
序列化
class BookSerializer(serializers.Serializer):
id = serializers.IntegerField()
title = serializers.CharField(max_length=32)
CHOICES = ((1, "Linux"), (2, "Django"), (3, "Python"))
chapter = serializers.ChoiceField(choices=CHOICES, source="get_chapter_display")
pub_time = serializers.DateField()
第一步 声明序列化类
from rest_framework.views import APIView
from rest_framework.response import Response class BookView(APIView):
def get(self, request):
book_list = Book.objects.all()
ret = BookSerializer(book_list, many=True)
return Response(ret.data)
第二步 序列化对象
外键关系的序列化
# by gaoxin
from rest_framework import serializers
from .models import Book class PublisherSerializer(serializers.Serializer):
id = serializers.IntegerField(read_only=True)
title = serializers.CharField(max_length=32) class UserSerializer(serializers.Serializer):
id = serializers.IntegerField(read_only=True)
name = serializers.CharField(max_length=32)
age = serializers.IntegerField() class BookSerializer(serializers.Serializer):
id = serializers.IntegerField(read_only=True)
title = serializers.CharField(max_length=32)
CHOICES = ((1, "Linux"), (2, "Django"), (3, "Python"))
chapter = serializers.ChoiceField(choices=CHOICES, source="get_chapter_display", read_only=True)
pub_time = serializers.DateField()publisher </span>= PublisherSerializer(read_only=<span style="color: #000000;">True)
user </span>= UserSerializer(many=True, read_only=True)</pre>
外键关系的序列化
反序列化
当前端给我们发post的请求的时候~前端给我们传过来的数据~我们要进行一些校验然后保存到数据库~
这些校验以及保存工作，DRF的Serializer也给我们提供了一些方法了~~
首先~我们要写反序列化用的一些字段~有些字段要跟序列化区分开~~
Serializer提供了.is_valid() 和.save()方法~~
# serializers.py 文件
class BookSerializer(serializers.Serializer):
id = serializers.IntegerField(read_only=True)
title = serializers.CharField(max_length=32)
CHOICES = ((1, "Linux"), (2, "Django"), (3, "Python"))
chapter = serializers.ChoiceField(choices=CHOICES, source="get_chapter_display", read_only=True)
w_chapter = serializers.IntegerField(write_only=True)
pub_time = serializers.DateField()publisher </span>= PublisherSerializer(read_only=<span style="color: #000000;">True)
user </span>= UserSerializer(many=True, read_only=<span style="color: #000000;">True) users </span>= serializers.ListField(write_only=<span style="color: #000000;">True)
publisher_id </span>= serializers.IntegerField(write_only=<span style="color: #000000;">True) </span><span style="color: #0000ff;">def</span><span style="color: #000000;"> create(self, validated_data):
book </span>= Book.objects.create(title=validated_data[<span style="color: #800000;">"</span><span style="color: #800000;">title</span><span style="color: #800000;">"</span>], chapter=validated_data[<span style="color: #800000;">"</span><span style="color: #800000;">w_chapter</span><span style="color: #800000;">"</span>], pub_time=validated_data[<span style="color: #800000;">"</span><span style="color: #800000;">pub_time</span><span style="color: #800000;">"</span>], publisher_id=validated_data[<span style="color: #800000;">"</span><span style="color: #800000;">publisher_id</span><span style="color: #800000;">"</span><span style="color: #000000;">])
book.user.add(</span>*validated_data[<span style="color: #800000;">"</span><span style="color: #800000;">users</span><span style="color: #800000;">"</span><span style="color: #000000;">])
</span><span style="color: #0000ff;">return</span> book</pre>
反序列化serializer.py
class BookView(APIView):
def get(self, request):
book_list = Book.objects.all()
ret = BookSerializer(book_list, many=True)
return Response(ret.data)</span><span style="color: #0000ff;">def</span><span style="color: #000000;"> post(self, request):
</span><span style="color: #008000;">#</span><span style="color: #008000;"> book_obj = request.data</span>
<span style="color: #0000ff;">print</span><span style="color: #000000;">(request.data)
serializer </span>= BookSerializer(data=<span style="color: #000000;">request.data)
</span><span style="color: #0000ff;">if</span><span style="color: #000000;"> serializer.is_valid():
</span><span style="color: #0000ff;">print</span>(12341253<span style="color: #000000;">)
serializer.save()
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> Response(serializer.validated_data)
</span><span style="color: #0000ff;">else</span><span style="color: #000000;">:
</span><span style="color: #0000ff;">return</span> Response(serializer.errors)</pre>
反序列化views.py
当前端给我们发送patch请求的时候，前端传给我们用户要更新的数据，我们要对数据进行部分验证~~
class BookSerializer(serializers.Serializer):
id = serializers.IntegerField(read_only=True)
title = serializers.CharField(max_length=32)
CHOICES = ((1, "Linux"), (2, "Django"), (3, "Python"))
chapter = serializers.ChoiceField(choices=CHOICES, source="get_chapter_display", read_only=True)
w_chapter = serializers.IntegerField(write_only=True)
pub_time = serializers.DateField()publisher </span>= PublisherSerializer(read_only=<span style="color: #000000;">True)
user </span>= UserSerializer(many=True, read_only=<span style="color: #000000;">True) users </span>= serializers.ListField(write_only=<span style="color: #000000;">True)
publisher_id </span>= serializers.IntegerField(write_only=<span style="color: #000000;">True) </span><span style="color: #0000ff;">def</span><span style="color: #000000;"> create(self, validated_data):
book </span>= Book.objects.create(title=validated_data[<span style="color: #800000;">"</span><span style="color: #800000;">title</span><span style="color: #800000;">"</span>], chapter=validated_data[<span style="color: #800000;">"</span><span style="color: #800000;">w_chapter</span><span style="color: #800000;">"</span>], pub_time=validated_data[<span style="color: #800000;">"</span><span style="color: #800000;">pub_time</span><span style="color: #800000;">"</span><span style="color: #000000;">],
publisher_id</span>=validated_data[<span style="color: #800000;">"</span><span style="color: #800000;">publisher_id</span><span style="color: #800000;">"</span><span style="color: #000000;">])
book.user.add(</span>*validated_data[<span style="color: #800000;">"</span><span style="color: #800000;">users</span><span style="color: #800000;">"</span><span style="color: #000000;">])
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> book </span><span style="color: #0000ff;">def</span><span style="color: #000000;"> update(self, instance, validated_data):
instance.title </span>= validated_data.get(<span style="color: #800000;">"</span><span style="color: #800000;">title</span><span style="color: #800000;">"</span><span style="color: #000000;">, instance.title)
instance.chapter </span>= validated_data.get(<span style="color: #800000;">"</span><span style="color: #800000;">w_chapter</span><span style="color: #800000;">"</span><span style="color: #000000;">, instance.chapter)
instance.pub_time </span>= validated_data.get(<span style="color: #800000;">"</span><span style="color: #800000;">pub_time</span><span style="color: #800000;">"</span><span style="color: #000000;">, instance.pub_time)
instance.publisher_id </span>= validated_data.get(<span style="color: #800000;">"</span><span style="color: #800000;">publisher_id</span><span style="color: #800000;">"</span><span style="color: #000000;">, instance.publisher_id)
</span><span style="color: #0000ff;">if</span> validated_data.get(<span style="color: #800000;">"</span><span style="color: #800000;">users</span><span style="color: #800000;">"</span><span style="color: #000000;">):
instance.user.set(validated_data.get(</span><span style="color: #800000;">"</span><span style="color: #800000;">users</span><span style="color: #800000;">"</span><span style="color: #000000;">))
instance.save()
</span><span style="color: #0000ff;">return</span> instance</pre>
PATCH请求serializers.py
class BookView(APIView):
def patch(self, request):
print(request.data)
book_id = request.data["id"]
book_info = request.data["book_info"]
book_obj = Book.objects.filter(pk=book_id).first()
serializer = BookSerializer(book_obj, data=book_info, partial=True)
if serializer.is_valid():
serializer.save()
return Response(serializer.data)
else:
return Response(serializer.errors)
PATCH请求views.py
验证
如果我们需要对一些字段进行自定义的验证~DRF也给我们提供了钩子方法~~
class BookSerializer(serializers.Serializer):
id = serializers.IntegerField(read_only=True)
title = serializers.CharField(max_length=32)
# 省略了一些字段 跟上面代码里一样的
# 。。。。。
def validate_title(self, value):
if "python" not in value.lower():
raise serializers.ValidationError("标题必须含有Python")
return value
单个字段的验证
class BookSerializer(serializers.Serializer):
id = serializers.IntegerField(read_only=True)
title = serializers.CharField(max_length=32)
CHOICES = ((1, "Linux"), (2, "Django"), (3, "Python"))
chapter = serializers.ChoiceField(choices=CHOICES, source="get_chapter_display", read_only=True)
w_chapter = serializers.IntegerField(write_only=True)
pub_time = serializers.DateField()
date_added = serializers.DateField(write_only=True)
# 新增了一个上架时间字段
# 省略一些字段。。都是在原基础代码上增加的
# 。。。。。。<span style="color: #008000;">#</span><span style="color: #008000;"> 对多个字段进行验证 要求上架日期不能早于出版日期 上架日期要大</span>
<span style="color: #0000ff;">def</span><span style="color: #000000;"> validate(self, attrs):
</span><span style="color: #0000ff;">if</span> attrs[<span style="color: #800000;">"</span><span style="color: #800000;">pub_time</span><span style="color: #800000;">"</span>] > attrs[<span style="color: #800000;">"</span><span style="color: #800000;">date_added</span><span style="color: #800000;">"</span><span style="color: #000000;">]:
</span><span style="color: #0000ff;">raise</span> serializers.ValidationError(<span style="color: #800000;">"</span><span style="color: #800000;">上架日期不能早于出版日期</span><span style="color: #800000;">"</span><span style="color: #000000;">)
</span><span style="color: #0000ff;">return</span> attrs</pre>
多个字段的验证
def my_validate(value):
if "敏感词汇" in value.lower:
raise serializers.ValidationError("包含敏感词汇，请重新提交")
return value class BookSerializer(serializers.Serializer):
id = serializers.IntegerField(read_only=True)
title = serializers.CharField(max_length=32, validators=[my_validate])
# 。。。。。。
验证器 validators
ModelSerializer
现在我们已经清楚了Serializer的用法，会发现我们所有的序列化跟我们的模型都紧密相关~
那么，DRF也给我们提供了跟模型紧密相关的序列化器~~ModelSerializer~~
-- 它会根据模型自动生成一组字段
-- 它简单的默认实现了.update()以及.create()方法
定义一个ModelSerializer序列化器
class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book
fields = "__all__"
# fields = ["id", "title", "pub_time"]
# exclude = ["user"]
# 分别是所有字段 包含某些字段 排除某些字段
定义ModelSerializer
外键关系的序列化
注意：当序列化类MATE中定义了depth时，这个序列化类中引用字段（外键）则自动变为只读
class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book
fields = "__all__"
# fields = ["id", "title", "pub_time"]
# exclude = ["user"]
# 分别是所有字段 包含某些字段 排除某些字段
depth = 1
# depth 代表找嵌套关系的第几层
外键关系序列化
自定义字段
我们可以声明一些字段来覆盖默认字段，来进行自定制~
比如我们的选择字段，默认显示的是选择的key，我们要给用户展示的是value。
class BookSerializer(serializers.ModelSerializer):
chapter = serializers.CharField(source="get_chapter_display", read_only=True)</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Meta:
model </span>=<span style="color: #000000;"> Book
fields </span>= <span style="color: #800000;">"</span><span style="color: #800000;">__all__</span><span style="color: #800000;">"</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> fields = ["id", "title", "pub_time"]</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> exclude = ["user"]</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> 分别是所有字段 包含某些字段 排除某些字段</span>
depth = 1</pre>
自定义字段
Meta中其它关键字参数
class BookSerializer(serializers.ModelSerializer):
chapter = serializers.CharField(source="get_chapter_display", read_only=True)</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Meta:
model </span>=<span style="color: #000000;"> Book
fields </span>= <span style="color: #800000;">"</span><span style="color: #800000;">__all__</span><span style="color: #800000;">"</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> fields = ["id", "title", "pub_time"]</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> exclude = ["user"]</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> 分别是所有字段 包含某些字段 排除某些字段</span>
depth = 1<span style="color: #000000;">
read_only_fields </span>= [<span style="color: #800000;">"</span><span style="color: #800000;">id</span><span style="color: #800000;">"</span><span style="color: #000000;">]
extra_kwargs </span>= {<span style="color: #800000;">"</span><span style="color: #800000;">title</span><span style="color: #800000;">"</span>: {<span style="color: #800000;">"</span><span style="color: #800000;">validators</span><span style="color: #800000;">"</span>: [my_validate,]}}</pre>
Meta中参数
post以及patch请求
由于depth会让我们外键变成只读，所以我们再定义一个序列化的类，其实只要去掉depth就可以了~~
class BookSerializer(serializers.ModelSerializer):
chapter = serializers.CharField(source="get_chapter_display", read_only=True)</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Meta:
model </span>=<span style="color: #000000;"> Book
fields </span>= <span style="color: #800000;">"</span><span style="color: #800000;">__all__</span><span style="color: #800000;">"</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> fields = ["id", "title", "pub_time"]</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> exclude = ["user"]</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> 分别是所有字段 包含某些字段 排除某些字段</span>
read_only_fields = [<span style="color: #800000;">"</span><span style="color: #800000;">id</span><span style="color: #800000;">"</span><span style="color: #000000;">]
extra_kwargs </span>= {<span style="color: #800000;">"</span><span style="color: #800000;">title</span><span style="color: #800000;">"</span>: {<span style="color: #800000;">"</span><span style="color: #800000;">validators</span><span style="color: #800000;">"</span>: [my_validate,]}}</pre>
post/patch请求序列化类
SerializerMethodField
外键关联的对象有很多字段我们是用不到的~都传给前端会有数据冗余~就需要我们自己去定制序列化外键对象的哪些字段~~
class BookSerializer(serializers.ModelSerializer):
chapter = serializers.CharField(source="get_chapter_display", read_only=True)
user = serializers.SerializerMethodField()
publisher = serializers.SerializerMethodField()</span><span style="color: #0000ff;">def</span><span style="color: #000000;"> get_user(self, obj):
</span><span style="color: #008000;">#</span><span style="color: #008000;"> obj是当前序列化的book对象</span>
users_query_set =<span style="color: #000000;"> obj.user.all()
</span><span style="color: #0000ff;">return</span> [{<span style="color: #800000;">"</span><span style="color: #800000;">id</span><span style="color: #800000;">"</span>: user_obj.pk, <span style="color: #800000;">"</span><span style="color: #800000;">name</span><span style="color: #800000;">"</span>: user_obj.name} <span style="color: #0000ff;">for</span> user_obj <span style="color: #0000ff;">in</span><span style="color: #000000;"> users_query_set] </span><span style="color: #0000ff;">def</span><span style="color: #000000;"> get_publisher(self, obj):
publisher_obj </span>=<span style="color: #000000;"> obj.publisher
</span><span style="color: #0000ff;">return</span> {<span style="color: #800000;">"</span><span style="color: #800000;">id</span><span style="color: #800000;">"</span>: publisher_obj.pk, <span style="color: #800000;">"</span><span style="color: #800000;">title</span><span style="color: #800000;">"</span><span style="color: #000000;">: publisher_obj.title} </span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Meta:
model </span>=<span style="color: #000000;"> Book
fields </span>= <span style="color: #800000;">"</span><span style="color: #800000;">__all__</span><span style="color: #800000;">"</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> fields = ["id", "title", "pub_time"]</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> exclude = ["user"]</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> 分别是所有字段 包含某些字段 排除某些字段</span>
read_only_fields = [<span style="color: #800000;">"</span><span style="color: #800000;">id</span><span style="color: #800000;">"</span><span style="color: #000000;">]
extra_kwargs </span>= {<span style="color: #800000;">"</span><span style="color: #800000;">title</span><span style="color: #800000;">"</span>: {<span style="color: #800000;">"</span><span style="color: #800000;">validators</span><span style="color: #800000;">"</span>: [my_validate,]}}</pre>
SerializerMethodField
用ModelSerializer改进上面Serializer的完整版
class BookSerializer(serializers.ModelSerializer):
dis_chapter = serializers.SerializerMethodField(read_only=True)
users = serializers.SerializerMethodField(read_only=True)
publishers = serializers.SerializerMethodField(read_only=True)</span><span style="color: #0000ff;">def</span><span style="color: #000000;"> get_users(self, obj):
</span><span style="color: #008000;">#</span><span style="color: #008000;"> obj是当前序列化的book对象</span>
users_query_set =<span style="color: #000000;"> obj.user.all()
</span><span style="color: #0000ff;">return</span> [{<span style="color: #800000;">"</span><span style="color: #800000;">id</span><span style="color: #800000;">"</span>: user_obj.pk, <span style="color: #800000;">"</span><span style="color: #800000;">name</span><span style="color: #800000;">"</span>: user_obj.name} <span style="color: #0000ff;">for</span> user_obj <span style="color: #0000ff;">in</span><span style="color: #000000;"> users_query_set] </span><span style="color: #0000ff;">def</span><span style="color: #000000;"> get_publishers(self, obj):
publisher_obj </span>=<span style="color: #000000;"> obj.publisher
</span><span style="color: #0000ff;">return</span> {<span style="color: #800000;">"</span><span style="color: #800000;">id</span><span style="color: #800000;">"</span>: publisher_obj.pk, <span style="color: #800000;">"</span><span style="color: #800000;">title</span><span style="color: #800000;">"</span><span style="color: #000000;">: publisher_obj.title} </span><span style="color: #0000ff;">def</span><span style="color: #000000;"> get_dis_chapter(self, obj):
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> obj.get_chapter_display() </span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Meta:
model </span>=<span style="color: #000000;"> Book
</span><span style="color: #008000;">#</span><span style="color: #008000;"> fields = "__all__"</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> 字段是有序的</span>
fields = [<span style="color: #800000;">"</span><span style="color: #800000;">id</span><span style="color: #800000;">"</span>, <span style="color: #800000;">"</span><span style="color: #800000;">title</span><span style="color: #800000;">"</span>,<span style="color: #800000;">"</span><span style="color: #800000;">dis_chapter</span><span style="color: #800000;">"</span>, <span style="color: #800000;">"</span><span style="color: #800000;">pub_time</span><span style="color: #800000;">"</span>, <span style="color: #800000;">"</span><span style="color: #800000;">publishers</span><span style="color: #800000;">"</span>, <span style="color: #800000;">"</span><span style="color: #800000;">users</span><span style="color: #800000;">"</span>,<span style="color: #800000;">"</span><span style="color: #800000;">chapter</span><span style="color: #800000;">"</span>, <span style="color: #800000;">"</span><span style="color: #800000;">user</span><span style="color: #800000;">"</span>, <span style="color: #800000;">"</span><span style="color: #800000;">publisher</span><span style="color: #800000;">"</span><span style="color: #000000;">]
</span><span style="color: #008000;">#</span><span style="color: #008000;"> exclude = ["user"]</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> 分别是所有字段 包含某些字段 排除某些字段</span>
read_only_fields = [<span style="color: #800000;">"</span><span style="color: #800000;">id</span><span style="color: #800000;">"</span>, <span style="color: #800000;">"</span><span style="color: #800000;">dis_chapter</span><span style="color: #800000;">"</span>, <span style="color: #800000;">"</span><span style="color: #800000;">users</span><span style="color: #800000;">"</span>, <span style="color: #800000;">"</span><span style="color: #800000;">publishers</span><span style="color: #800000;">"</span><span style="color: #000000;">]
extra_kwargs </span>= {<span style="color: #800000;">"</span><span style="color: #800000;">title</span><span style="color: #800000;">"</span>: {<span style="color: #800000;">"</span><span style="color: #800000;">validators</span><span style="color: #800000;">"</span>: [my_validate,]}, <span style="color: #800000;">"</span><span style="color: #800000;">user</span><span style="color: #800000;">"</span>: {<span style="color: #800000;">"</span><span style="color: #800000;">write_only</span><span style="color: #800000;">"</span>: True}, <span style="color: #800000;">"</span><span style="color: #800000;">publisher</span><span style="color: #800000;">"</span>: {<span style="color: #800000;">"</span><span style="color: #800000;">write_only</span><span style="color: #800000;">"</span><span style="color: #000000;">: True},
</span><span style="color: #800000;">"</span><span style="color: #800000;">chapter</span><span style="color: #800000;">"</span>: {<span style="color: #800000;">"</span><span style="color: #800000;">write_only</span><span style="color: #800000;">"</span>: True}}</pre>
ModelSerializer
Django Rest Framework 视图和路由
DRF的视图
APIView
我们django中写CBV的时候继承的是View，rest_framework继承的是APIView，那么他们两个有什么不同呢~~~
urlpatterns = [ url(r'^book$', BookView.as_view()), url(r'^book/(?P<id>\d+)$', BookEditView.as_view()),] |
我们可以看到，不管是View还是APIView最开始调用的都是as_view()方法~~那我们走进源码看看~~
我们能看到，APIView继承了View, 并且执行了View中的as_view()方法，最后把view返回了，用csrf_exempt()方法包裹后去掉了csrf的认证。
那我们看看View中的as_view()方法做了什么~
我们看到了~在View中的as_view方法返回了view函数，而view函数执行了self.dispatch()方法~~但是这里的dispatch方法应该是我们APIView中的~~
我们去initialize_request中看下把什么赋值给了request，并且赋值给了self.request, 也就是我们在视图中用的request.xxx到底是什么~~
我们看到，这个方法返回的是Request这个类的实例对象~~我们注意我们看下这个Request类中的第一个参数request，是我们走我们django的时候的原来的request~
我们看到了，这个Request类把原来的request赋值给了self._request, 也就是说以后_request是我们老的request，新的request是我们这个Request类~~
那我们继承APIView之后请求来的数据都在哪呢~~
我们用了rest_framework框架以后，我们的request是重新封装的Request类~
request.query_params 存放的是我们get请求的参数
request.data 存放的是我们所有的数据，包括post请求的以及put，patch请求~~~
相比原来的django的request，我们现在的request更加精简，清晰了~~~
现在我们知道了APIView和View的一些区别~~当然还有~~后面我们还会说~~
我们写的视图可能对多个表进行增删改查，就导致我们的视图特别多重复的代码~~
那么我们尝试着来进行封装一下~~
第一次封装
class BookView(APIView):</span><span style="color: #0000ff;">def</span><span style="color: #000000;"> get(self, request):
query_set </span>=<span style="color: #000000;"> Book.objects.all()
book_ser </span>= BookSerializer(query_set, many=<span style="color: #000000;">True)
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> Response(book_ser.data) </span><span style="color: #0000ff;">def</span><span style="color: #000000;"> post(self, request):
query_set </span>=<span style="color: #000000;"> request.data
book_ser </span>= BookSerializer(data=<span style="color: #000000;">query_set)
</span><span style="color: #0000ff;">if</span><span style="color: #000000;"> book_ser.is_valid():
book_ser.save()
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> Response(book_ser.validated_data)
</span><span style="color: #0000ff;">else</span><span style="color: #000000;">:
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> Response(book_ser.errors)
class BookEditView(APIView):
</span><span style="color: #0000ff;">def</span><span style="color: #000000;"> get(self, request, id):
query_set </span>= Book.objects.filter(id=<span style="color: #000000;">id).first()
book_ser </span>=<span style="color: #000000;"> BookSerializer(query_set)
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> Response(book_ser.data) </span><span style="color: #0000ff;">def</span><span style="color: #000000;"> patch(self, request, id):
query_set </span>= Book.objects.filter(id=<span style="color: #000000;">id).first()
book_ser </span>= BookSerializer(query_set, data=request.data, partial=<span style="color: #000000;">True)
</span><span style="color: #0000ff;">if</span><span style="color: #000000;"> book_ser.is_valid():
book_ser.save()
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> Response(book_ser.validated_data)
</span><span style="color: #0000ff;">else</span><span style="color: #000000;">:
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> Response(book_ser.errors) </span><span style="color: #0000ff;">def</span><span style="color: #000000;"> delete(self, request, id):
query_set </span>= Book.objects.filter(id=<span style="color: #000000;">id).first()
</span><span style="color: #0000ff;">if</span><span style="color: #000000;"> query_set:
query_set.delete()
</span><span style="color: #0000ff;">return</span> Response(<span style="color: #800000;">""</span><span style="color: #000000;">)
</span><span style="color: #0000ff;">else</span><span style="color: #000000;">:
</span><span style="color: #0000ff;">return</span> Response(<span style="color: #800000;">"</span><span style="color: #800000;">删除的书籍不存在</span><span style="color: #800000;">"</span>)</pre>
APIView视图
class GenericAPIView(APIView):
queryset = None
serializer_class = None</span><span style="color: #0000ff;">def</span><span style="color: #000000;"> get_queryset(self):
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> self.queryset.all() </span><span style="color: #0000ff;">def</span> get_serializer(self, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">return</span> self.serializer_class(*args, **<span style="color: #000000;">kwargs)
class ListModelMixin(object):
def list(self, request, *args, **kwargs):
queryset = self.get_queryset()
serializer = self.get_serializer(queryset, many=True)
return Response(serializer.data)class CreateModelMixin(object):
def create(self, request, *args, **kwargs):
serializer = self.get_serializer(data=request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.validated_data)
else:
return Response(serializer.errors)class RetrieveModelMixin(object):
def retrieve(self, request, id, *args, **kwargs):
book_obj = self.get_queryset().filter(pk=id).first()
book_ser = self.get_serializer(book_obj)
return Response(book_ser.data)class UpdateModelMixin(object):
def update(self, request, id, *args, **kwargs):
book_obj = self.get_queryset().filter(pk=id).first()
book_ser = self.get_serializer(book_obj, data=request.data, partial=True)
if book_ser.is_valid():
book_ser.save()
return Response(book_ser.validated_data)
else:
return Response(book_ser.errors)class DestroyModelMixin(object):
def destroy(self, request, id, *args, **kwargs):
queryset = self.get_queryset()
try:
queryset.get(pk=id).delete()
return Response("")
except Exception as e:
return Response("信息有误")
# 我们把公共的部分抽出来 这样不管写多少表的增删改查都变的很简单这样封装后我们的视图会变成这样
class BookView(GenericAPIView, ListModelMixin, CreateModelMixin):
queryset = Book.objects.all()
serializer_class = BookSerializer</span><span style="color: #0000ff;">def</span> get(self, request, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">return</span> self.list(request, *args, **<span style="color: #000000;">kwargs) </span><span style="color: #0000ff;">def</span> post(self, request, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">return</span> self.create(request, *args, **<span style="color: #000000;">kwargs)
class BookEditView(GenericAPIView, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin):
queryset = Book.objects.all()
serializer_class = BookSerializer</span><span style="color: #0000ff;">def</span> get(self, request, id, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">return</span> self.retrieve(request, id, *args, **<span style="color: #000000;">kwargs) </span><span style="color: #0000ff;">def</span> patch(self, request, id, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">return</span> self.update(request, id, *args, **<span style="color: #000000;">kwargs) </span><span style="color: #0000ff;">def</span> destroy(self, request, id, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">return</span> self.delete(request, id, *args, **kwargs)</pre>
第一次封装
我们封装的GenericAPIView，包括封装每个方法的类，其实框架都帮我们封装好了~~
我们可以直接继承这些类~~来实现上面的视图~~可是还有没有更简单的方法呢~我们再次封装一下~~
第二次封装
# 上面我们写的继承类太长了~~我们再改改 class ListCreateAPIView(GenericAPIView, ListModelMixin, CreateModelMixin):
pass class RetrieveUpdateDestroyAPIView(GenericAPIView, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin):
pass class BookView(ListCreateAPIView):
queryset = Book.objects.all()
serializer_class = BookSerializer</span><span style="color: #0000ff;">def</span> get(self, request, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">return</span> self.list(request, *args, **<span style="color: #000000;">kwargs) </span><span style="color: #0000ff;">def</span> post(self, request, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">return</span> self.create(request, *args, **<span style="color: #000000;">kwargs)
class BookEditView(RetrieveUpdateDestroyAPIView):
queryset = Book.objects.all()
serializer_class = BookSerializer</span><span style="color: #0000ff;">def</span> get(self, request, id, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">return</span> self.retrieve(request, id, *args, **<span style="color: #000000;">kwargs) </span><span style="color: #0000ff;">def</span> patch(self, request, id, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">return</span> self.update(request, id, *args, **<span style="color: #000000;">kwargs) </span><span style="color: #0000ff;">def</span> delete(self, request, id, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">return</span> self.delete(request, id, *args, **kwargs)</pre>
第二次封装
这次我们只是让继承变的简单了一点而已，好像并没有什么大的进步~~
我们可不可以把这两个视图合并成一个视图呢~~~框架给我们提供了一个路由传参的方法~~
我们看下ViewSetMixin
actions这个默认参数其实就是我们路由可以进行传参了~~~
下面这个循环~可以看出~我们要传的参数是一个字段~key应该是我们的请求方式，value应该对应我们处理的方法~
这样我们每个视图就不用在写函数了~因为已经和内部实现的函数相对应了~
第三次封装
urlpatterns = [
# url(r'^book$', BookView.as_view()),
# url(r'^book/(?P<id>\d+)$', BookEditView.as_view()),
url(r'^book$', BookView.as_view({"get": "list", "post": "create"})),
url(r'^book/(?P<pk>\d+)$', BookView.as_view({"get": "retrieve", "patch": "update", "delete": "destroy"})),
]
路由urls.py
from rest_framework.viewsets import ViewSetMixin # class BookView(ViewSetMixin, ListCreateAPIView, RetrieveUpdateDestroyAPIView):queryset = Book.objects.all()
serializer_class = BookSerializer
# 如果我们再定义一个类
class ModelViewSet(ViewSetMixin, ListCreateAPIView, RetrieveUpdateDestroyAPIView):
pass class BookView(ModelViewSet):
queryset = Book.objects.all()
serializer_class = BookSerializer
第三次封装
我们现在的视图就只要写两行就可以了~~~
其实我们写的所有的视图~框架都帮我们封装好了~
注意一点~~用框架封装的视图~我们url上的那个关键字参数要用pk~~系统默认的~~
奉献一张图来看下我们的继承顺序~~~
DRF的路由
我们上面的路由传参写的特别多~~框架也帮我们封装好了~
from .views import BookView
from rest_framework.routers import DefaultRouter router = DefaultRouter()
router.register(r"book", BookView) urlpatterns = [
# url(r'^book\(', BookView.as_view()),</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> url(r'^book/(?P<id>\d+)\)', BookEditView.as_view()),
# url(r'^book\(', BookView.as_view({"get": "list", "post": "create"})),</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> url(r'^book/(?P<pk>\d+)\)', BookView.as_view({"get": "retrieve", "patch": "update", "delete": "destroy"})),
]
urlpatterns += router.urls
路由
我们可以看到~~通过框架我们可以把路由视图都变的非常简单~~
但是需要自定制的时候还是需要我们自己用APIView写~~当不需要那么多路由的时候~也不要用这种路由注册~~
总之~~一切按照业务需要去用~~~
您的资助是我最大的动力！
金额随意,欢迎来赏！
如果，您认为阅读这篇博客让您有些收获，不妨点击一下右下角的按钮。
如果，您希望更容易地发现我的新博客，不妨点击一下绿色通道的。
如果，想给予我更多的鼓励，求打
因为，我的写作热情也离不开您的肯定支持，感谢您的阅读，我是【桎梏】！
联系或打赏博主【桎梏】！https://www.cnblogs.com/zhigu/
DRF 版本 认证
DRF的版本
版本控制是做什么用的, 我们为什么要用
首先我们要知道我们的版本是干嘛用的呢~~大家都知道我们开发项目是有多个版本的~~
当我们项目越来越更新~版本就越来越多~~我们不可能新的版本出了~以前旧的版本就不进行维护了~~~
那我们就需要对版本进行控制~~这个DRF也给我们提供了一些封装好的版本控制方法~~
版本控制怎么用
之前我们学视图的时候知道APIView，也知道APIView返回View中的view函数，然后调用的dispatch方法~
那我们现在看下dispatch方法~~看下它都做了什么~~
执行self.initial方法之前是各种赋值，包括request的重新封装赋值，下面是路由的分发，那我们看下这个方法都做了什么~~
我们可以看到，我们的version版本信息赋值给了 request.version 版本控制方案赋值给了 request.versioning_scheme~~
其实这个版本控制方案~就是我们配置的版本控制的类~~
也就是说，APIView通过这个方法初始化自己提供的组件~~
我们接下来看看框架提供了哪些版本的控制方法~~在rest_framework.versioning里~~
框架一共给我们提供了这几个版本控制的方法~~我们在这里只演示一个~~因为基本配置都是一样的~~
详细用法
我们看下放在URL上携带版本信息怎么配置~~
REST_FRAMEWORK = {
# 默认使用的版本控制类
'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.URLPathVersioning',
# 允许的版本
'ALLOWED_VERSIONS': ['v1', 'v2'],
# 版本使用的参数名称
'VERSION_PARAM': 'version',
# 默认使用的版本
'DEFAULT_VERSION': 'v1',
}第一步 setting.py
urlpatterns = [
url(r"^versions", MyView.as_view()),
url(r"^(?P<version>[v1|v2]+)/test01", TestView.as_view()),
]
第二步 urls.py
class TestView(APIView):
def get(self, request, *args, **kwargs):
print(request.versioning_scheme)
ret = request.version
if ret == "v1":
return Response("版本v1的信息")
elif ret == "v2":
return Response("版本v2的信息")
else:
return Response("根本就匹配不到这个路由")
测试视图
其他的版本控制的类，配置方法都差不多~~这里就不一一例举了~~
DRF的认证
认证是干嘛的呢~
我们都知道~我们可以在网站上登录~然后可以有个人中心，对自己信息就行修改~~~
但是我们每次给服务器发请求，由于Http的无状态，导师我们每次都是新的请求~~
那么服务端需要对每次来的请求进行认证，看用户是否登录，以及登录用户是谁~~
那么我们服务器对每个请求进行认证的时候，不可能在每个视图函数中都写认证~~~
一定是把认证逻辑抽离出来~~以前我们可能会加装饰器~或者中间件~~那我们看看DRF框架给我们提供了什么~~~
认证怎么用
上面讲版本的时候我们知道~在dispatch方法里~执行了initial方法~~那里初始化了我们的版本~~
如果我们细心我们能看到~版本的下面其实就是我们的认证，权限，频率组件了~~
我们先看看我们的认证组件~~
我们进去我们的认证看下~~
我们这个权限组件返回的是request.user，那我们这里的request是新的还是旧的呢~~
我们的initial是在我们request重新赋值之后的~所以这里的request是新的~也就是Request类实例对象~~
那这个user一定是一个静态方法~我们进去看看~~
我没在这里反复的截图跳转页面~~大家可以尝试着自己去找~~要耐心~~细心~~
我们通过上面基本可以知道我们的认证类一定要实现的方法~~以及返回值类型~~以及配置的参数authentication_classes~
下面我们来看看具体用法~~~
认证的详细用法
我们先写个认证的小demo~~我们先建一个用户表~字段为用户名以及对应的token值~~
# 先在model中注册模型类
# 并且进行数据迁移
# 测试我就简写了~ class UserInfo(models.Model):
username = models.CharField(max_length=32)
token = models.UUIDField()
models.py
# 写视图类并且用post请求注册一个用户 class UserView(APIView):
def post(self, request, *args, **kwargs):
username = request.data["username"]
UserInfo.objects.create(username=username, token=uuid.uuid4())
return Response("注册成功")
views.py
准备工作完成~我们来开始我们的认证~~
# 注意我们这个认证的类必须实现的方法以及返回值
class MyAuth(BaseAuthentication):</span><span style="color: #0000ff;">def</span><span style="color: #000000;"> authenticate(self, request):
request_token </span>= request.query_params.get(<span style="color: #800000;">"</span><span style="color: #800000;">token</span><span style="color: #800000;">"</span><span style="color: #000000;">, None)
</span><span style="color: #0000ff;">if</span> <span style="color: #0000ff;">not</span><span style="color: #000000;"> request_token:
</span><span style="color: #0000ff;">raise</span> AuthenticationFailed({<span style="color: #800000;">"</span><span style="color: #800000;">code</span><span style="color: #800000;">"</span>: 1001, <span style="color: #800000;">"</span><span style="color: #800000;">error</span><span style="color: #800000;">"</span>: <span style="color: #800000;">"</span><span style="color: #800000;">缺少token</span><span style="color: #800000;">"</span><span style="color: #000000;">})
token_obj </span>= UserInfo.objects.filter(token=<span style="color: #000000;">request_token).first()
</span><span style="color: #0000ff;">if</span> <span style="color: #0000ff;">not</span><span style="color: #000000;"> token_obj:
</span><span style="color: #0000ff;">raise</span> AuthenticationFailed({<span style="color: #800000;">"</span><span style="color: #800000;">code</span><span style="color: #800000;">"</span>: 1001, <span style="color: #800000;">"</span><span style="color: #800000;">error</span><span style="color: #800000;">"</span>: <span style="color: #800000;">"</span><span style="color: #800000;">无效的token</span><span style="color: #800000;">"</span><span style="color: #000000;">})
</span><span style="color: #0000ff;">return</span> token_obj.username, token_obj</pre>
写一个认证的类
class TestAuthView(APIView):
authentication_classes = [MyAuth, ]</span><span style="color: #0000ff;">def</span> get(self, request, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">return</span> Response(<span style="color: #800000;">"</span><span style="color: #800000;">测试认证</span><span style="color: #800000;">"</span>)</pre>
视图级别认证
REST_FRAMEWORK = {
# 默认使用的版本控制类
'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.URLPathVersioning',
# 允许的版本
'ALLOWED_VERSIONS': ['v1', 'v2'],
# 版本使用的参数名称
'VERSION_PARAM': 'version',
# 默认使用的版本
'DEFAULT_VERSION': 'v1',
# 配置全局认证
'DEFAULT_AUTHENTICATION_CLASSES': ["BRQP.utils.MyAuth", ]
}全局配置认证
DRF 权限 频率
DRF的权限
权限是什么
大家之前都应该听过权限~那么我们权限到底是做什么用的呢~~
大家都有博客~或者去一些论坛~一定知道管理员这个角色~
比如我们申请博客的时候~一定要向管理员申请~也就是说管理员会有一些特殊的权利~是我们没有的~~
这些对某件事情决策的范围和程度~我们叫做权限~~权限是我们在项目开发中非常常用到的~~
那我们看DRF框架给我们提供的权限组件都有哪些方法~~
权限组件源码
我们之前说过了DRF的版本和认证~也知道了权限和频率跟版本认证都是在initial方法里初始化的~~
其实我们版本，认证，权限，频率控制走的源码流程大致相同~~大家也可以在源码里看到~~
我们的权限类一定要有has_permission方法~否则就会抛出异常~~这也是框架给我提供的钩子~~
我们先看到在rest_framework.permissions这个文件中~存放了框架给我们提供的所有权限的方法~~
我这里就不带着大家详细去看每一个了~大家可以去浏览一下每个权限类~看看每个都是干嘛的~~
这里主要说下BasePermission 这个是我们写权限类继承的一个基础权限类~~~
权限的详细用法
在这里我们一定要清楚一点~我们的Python代码是一行一行执行的~那么执行initial方法初始化这些组件的时候~~
也是有顺序的~~我们的版本在前面~然后是认证，然后是权限~ 最后是频率~~所以大家要清楚~~
我们的权限执行的时候~我们的认证已经执行结束了~~~
前提在model中的UserInfo表中加了一个字段~用户类型的字段~~做好数据迁移~~
class MyPermission(BasePermission):
message = "VIP用户才能访问"<span style="color: #0000ff;">def</span><span style="color: #000000;"> has_permission(self, request, view):
</span><span style="color: #800000;">"""</span><span style="color: #800000;">
自定义权限只有vip用户能访问，
注意我们初始化时候的顺序是认证在权限前面的，所以只要认证通过~
我们这里就可以通过request.user,拿到我们用户信息
request.auth就能拿到用户对象
</span><span style="color: #800000;">"""</span>
<span style="color: #0000ff;">if</span> request.user <span style="color: #0000ff;">and</span> request.auth.type == 2<span style="color: #000000;">:
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> True
</span><span style="color: #0000ff;">else</span><span style="color: #000000;">:
</span><span style="color: #0000ff;">return</span> False</pre>
第一步 写权限类
class TestAuthView(APIView):
authentication_classes = [MyAuth, ]
permission_classes = [MyPermission, ]</span><span style="color: #0000ff;">def</span> get(self, request, *args, **<span style="color: #000000;">kwargs):
</span><span style="color: #0000ff;">print</span><span style="color: #000000;">(request.user)
</span><span style="color: #0000ff;">print</span><span style="color: #000000;">(request.auth)
username </span>=<span style="color: #000000;"> request.user
</span><span style="color: #0000ff;">return</span> Response(username)</pre>
局部视图注册
REST_FRAMEWORK = {
# 默认使用的版本控制类
'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.URLPathVersioning',
# 允许的版本
'ALLOWED_VERSIONS': ['v1', 'v2'],
# 版本使用的参数名称
'VERSION_PARAM': 'version',
# 默认使用的版本
'DEFAULT_VERSION': 'v1',
# 配置全局认证
# 'DEFAULT_AUTHENTICATION_CLASSES': ["BRQP.utils.MyAuth", ]
# 配置全局权限
"DEFAULT_PERMISSION_CLASSES": ["BROP.utils.MyPermission"]
}全局注册 settings.py
DRF的频率
频率限制是做什么的
开放平台的API接口调用需要限制其频率，以节约服务器资源和避免恶意的频繁调用。
我们的DRF提供了一些频率限制的方法，我们看一下。
频率组件源码
版本，认证，权限，频率这几个组件的源码是一个流程，这里就不再带大家走源码了~
相信大家可以自己看懂了~~下面我们谈谈频率组件实现的原理~~
频率组件原理
DRF中的频率控制基本原理是基于访问次数和时间的，当然我们可以通过自己定义的方法来实现。
当我们请求进来，走到我们频率组件的时候，DRF内部会有一个字典来记录访问者的IP，
以这个访问者的IP为key，value为一个列表，存放访问者每次访问的时间，
{ IP1: [第三次访问时间，第二次访问时间，第一次访问时间]，}
把每次访问最新时间放入列表的最前面，记录这样一个数据结构后，通过什么方式限流呢~~
如果我们设置的是10秒内只能访问5次，
-- 1，判断访问者的IP是否在这个请求IP的字典里
-- 2，保证这个列表里都是最近10秒内的访问的时间
判断当前请求时间和列表里最早的(也就是最后的)请求时间的查
如果差大于10秒，说明请求以及不是最近10秒内的，删除掉，
继续判断倒数第二个，直到差值小于10秒
-- 3，判断列表的长度(即访问次数)，是否大于我们设置的5次，
如果大于就限流，否则放行，并把时间放入列表的最前面。
频率组件的详细用法
频率组件的配置方式其实跟上面的组件都一样，我们看下频率组件的使用。
VISIT_RECORD = {}
class MyThrottle(object):</span><span style="color: #0000ff;">def</span> <span style="color: #800080;">__init__</span><span style="color: #000000;">(self):
self.history </span>=<span style="color: #000000;"> None </span><span style="color: #0000ff;">def</span><span style="color: #000000;"> allow_request(self, request, view):
</span><span style="color: #800000;">"""</span><span style="color: #800000;">
自定义频率限制60秒内只能访问三次
</span><span style="color: #800000;">"""</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> 获取用户IP</span>
ip = request.META.get(<span style="color: #800000;">"</span><span style="color: #800000;">REMOTE_ADDR</span><span style="color: #800000;">"</span><span style="color: #000000;">)
timestamp </span>=<span style="color: #000000;"> time.time()
</span><span style="color: #0000ff;">if</span> ip <span style="color: #0000ff;">not</span> <span style="color: #0000ff;">in</span><span style="color: #000000;"> VISIT_RECORD:
VISIT_RECORD[ip] </span>=<span style="color: #000000;"> [timestamp, ]
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> True
history </span>=<span style="color: #000000;"> VISIT_RECORD[ip]
self.history </span>=<span style="color: #000000;"> history
history.insert(0, timestamp)
</span><span style="color: #0000ff;">while</span> history <span style="color: #0000ff;">and</span> history[-1] < timestamp - 60<span style="color: #000000;">:
history.pop()
</span><span style="color: #0000ff;">if</span> len(history) > 3<span style="color: #000000;">:
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> False
</span><span style="color: #0000ff;">else</span><span style="color: #000000;">:
</span><span style="color: #0000ff;">return</span><span style="color: #000000;"> True </span><span style="color: #0000ff;">def</span><span style="color: #000000;"> wait(self):
</span><span style="color: #800000;">"""</span><span style="color: #800000;">
限制时间还剩多少
</span><span style="color: #800000;">"""</span><span style="color: #000000;">
timestamp </span>=<span style="color: #000000;"> time.time()
</span><span style="color: #0000ff;">return</span> 60 - (timestamp - self.history[-1])</pre>
自定义的频率限制类
REST_FRAMEWORK = {
# ......
# 频率限制的配置
"DEFAULT_THROTTLE_CLASSES": ["Throttle.throttle.MyThrottle"],
}
}配置自定义频率限制
from rest_framework.throttling import SimpleRateThrottle class MyVisitThrottle(SimpleRateThrottle):
scope = "WD"<span style="color: #0000ff;">def</span><span style="color: #000000;"> get_cache_key(self, request, view):
</span><span style="color: #0000ff;">return</span> self.get_ident(request)</pre>
使用自带的频率限制类
REST_FRAMEWORK = {
# 频率限制的配置
# "DEFAULT_THROTTLE_CLASSES": ["Throttle.throttle.MyVisitThrottle"],
"DEFAULT_THROTTLE_CLASSES": ["Throttle.throttle.MyThrottle"],
"DEFAULT_THROTTLE_RATES":{
'WD':'5/m', #速率配置每分钟不能超过5次访问，WD是scope定义的值，
}
}配置频率限制
我们可以在postman~~或者DRF自带的页面进行测试都可以~~
</div>
DRF的分页
DRF的分页
为什么要使用分页
其实这个不说大家都知道，大家写项目的时候也是一定会用的，
我们数据库有几千万条数据，这些数据需要展示，我们不可能直接从数据库把数据全部读取出来，
这样会给内存造成特别大的压力，有可能还会内存溢出，所以我们希望一点一点的取，
那展示的时候也是一样的，总是要进行分页显示，我们之前自己都写过分页。
那么大家想一个问题，在数据量特别大的时候，我们的分页会越往后读取速度越慢，
当有一千万条数据，我要看最后一页的内容的时候，怎么能让我的查询速度变快。
DRF给我们提供了三种分页方式，我们看下他们都是什么样的~~
分页组件的使用
DRF提供的三种分页
from rest_framework.pagination import PageNumberPagination, LimitOffsetPagination, CursorPagination
全局配置
REST_FRAMEWORK = {
'PAGE_SIZE': 2
}第一种 PageNumberPagination 看第n页，每页显示n条数据
http://127.0.0.1:8000/book?page=2&size=1
class MyPageNumber(PageNumberPagination):
page_size = 2 # 每页显示多少条
page_size_query_param = 'size' # URL中每页显示条数的参数
page_query_param = 'page' # URL中页码的参数
max_page_size = None # 最大页码数限制
自定义分页类
class BookView(APIView):
def get(self, request):
book_list = Book.objects.all()
# 分页
page_obj = MyPageNumber()
page_article = page_obj.paginate_queryset(queryset=book_list, request=request, view=self)ret </span>= BookSerializer(page_article, many=<span style="color: #000000;">True)
</span><span style="color: #0000ff;">return</span> Response(ret.data)</pre>
视图
class BookView(APIView):
def get(self, request):
book_list = Book.objects.all()
# 分页
page_obj = MyPageNumber()
page_article = page_obj.paginate_queryset(queryset=book_list, request=request, view=self)ret </span>= BookSerializer(page_article, many=<span style="color: #000000;">True)
</span><span style="color: #008000;">#</span><span style="color: #008000;"> return Response(ret.data)</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> 返回带超链接 需返回的时候用内置的响应方法</span>
<span style="color: #0000ff;">return</span> page_obj.get_paginated_response(ret.data)</pre>
返回带页码链接的响应
第二种 LimitOffsetPagination 在第n个位置 向后查看n条数据
http://127.0.0.1:8000/book?offset=2&limit=1
class MyLimitOffset(LimitOffsetPagination):
default_limit = 1
limit_query_param = 'limit'
offset_query_param = 'offset'
max_limit = 999
自定义的分页类
# 视图和上面的大体一致
# 只有用的分页类不同，其他都相同
class BookView(APIView):
def get(self, request):
book_list = Book.objects.all()
# 分页
page_obj = MyLimitOffset()
page_article = page_obj.paginate_queryset(queryset=book_list, request=request, view=self)ret </span>= BookSerializer(page_article, many=<span style="color: #000000;">True)
</span><span style="color: #008000;">#</span><span style="color: #008000;"> return Response(ret.data)</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> 返回带超链接 需返回的时候用内置的响应方法</span>
<span style="color: #0000ff;">return</span> page_obj.get_paginated_response(ret.data)</pre>
视图
第三种 CursorPagination 加密游标的分页 把上一页和下一页的id记住
class MyCursorPagination(CursorPagination):
cursor_query_param = 'cursor'
page_size = 1
ordering = '-id'
自定义分页类
class BookView(APIView):
def get(self, request):
book_list = Book.objects.all()
# 分页
page_obj = MyCursorPagination()
page_article = page_obj.paginate_queryset(queryset=book_list, request=request, view=self)ret </span>= BookSerializer(page_article, many=<span style="color: #000000;">True)
</span><span style="color: #008000;">#</span><span style="color: #008000;"> return Response(ret.data)</span>
<span style="color: #008000;">#</span><span style="color: #008000;"> 返回带超链接 需返回的时候用内置的响应方法</span>
<span style="color: #0000ff;">return</span> page_obj.get_paginated_response(ret.data)</pre>
视图
DRF的解析器和渲染器
解析器
解析器的作用就是服务端接收客户端传过来的数据，把数据解析成自己想要的数据类型的过程。
本质就是对请求体中的数据进行解析。
Django的解析器
我们请求进来请求体中的数据在request.body中，那也就证明，解析器会把解析好的数据放入request.body
我们在视图中可以打印request的类型，能够知道request是WSGIRequest这个类。
我们可以看下这个类的源码~~~我们是怎么拿到request.POST数据的~~
application/x-www-form-urlencoded不是不能上传文件，是只能上传文本格式的文件，
multipart/form-data是将文件以二进制的形式上传，这样可以实现多种类型的文件上传
一个解析到request.POST, request.FILES中。
也就是说我们之前能在request中能到的各种数据是因为用了不同格式的数据解析器~
那么我们的DRF能够解析什么样的数据类型呢~~~
DRF的解析器
我们想一个问题~什么时候我们的解析器会被调用呢~~ 是不是在request.data拿数据的时候~
我们说请求数据都在request.data中，那我们看下这个Request类里的data~~
得到解析器后，调用解析器里的parse方法~~
那说到这里~我们看下DRF配置的默认的解析器的类都有哪些~~
也就是说我们的DRF支持Json，Form表单的请求，包括多种文件类型的数据~~~~
可以在我们的视图中配置视图级别的解析器~~~
这就是我们DRF的解析器~~~
DRF的渲染器
渲染器就是友好的展示数据~~
DRF给我们提供的渲染器有~~
我们在浏览器中展示的DRF测试的那个页面~就是通过浏览器的渲染器来做到的~~
当然我们可以展示Json数据类型~~~~渲染器比较简单~~~~