DRF 序列化组件
Serializers 序列化组件
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 = PublisherSerializer(read_only=True)
- user = UserSerializer(many=True, read_only=True)
外键关系的序列化
反序列化
当前端给我们发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 = PublisherSerializer(read_only=True)
- user = UserSerializer(many=True, read_only=True)
- users = serializers.ListField(write_only=True)
- publisher_id = serializers.IntegerField(write_only=True)
- def create(self, validated_data):
- book = Book.objects.create(title=validated_data["title"], chapter=validated_data["w_chapter"], pub_time=validated_data["pub_time"], publisher_id=validated_data["publisher_id"])
- book.user.add(*validated_data["users"])
- return book
反序列化serializer.py
- class BookView(APIView):
- def get(self, request):
- book_list = Book.objects.all()
- ret = BookSerializer(book_list, many=True)
- return Response(ret.data)
- def post(self, request):
- # book_obj = request.data
- print(request.data)
- serializer = BookSerializer(data=request.data)
- if serializer.is_valid():
- print(12341253)
- serializer.save()
- return Response(serializer.validated_data)
- else:
- return Response(serializer.errors)
反序列化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 = PublisherSerializer(read_only=True)
- user = UserSerializer(many=True, read_only=True)
- users = serializers.ListField(write_only=True)
- publisher_id = serializers.IntegerField(write_only=True)
- def create(self, validated_data):
- book = Book.objects.create(title=validated_data["title"], chapter=validated_data["w_chapter"], pub_time=validated_data["pub_time"],
- publisher_id=validated_data["publisher_id"])
- book.user.add(*validated_data["users"])
- return book
- def update(self, instance, validated_data):
- instance.title = validated_data.get("title", instance.title)
- instance.chapter = validated_data.get("w_chapter", instance.chapter)
- instance.pub_time = validated_data.get("pub_time", instance.pub_time)
- instance.publisher_id = validated_data.get("publisher_id", instance.publisher_id)
- if validated_data.get("users"):
- instance.user.set(validated_data.get("users"))
- instance.save()
- return instance
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)
- # 新增了一个上架时间字段
- # 省略一些字段。。都是在原基础代码上增加的
- # 。。。。。。
- # 对多个字段进行验证 要求上架日期不能早于出版日期 上架日期要大
- def validate(self, attrs):
- if attrs["pub_time"] > attrs["date_added"]:
- raise serializers.ValidationError("上架日期不能早于出版日期")
- return attrs
多个字段的验证
- 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)
- class Meta:
- model = Book
- fields = "__all__"
- # fields = ["id", "title", "pub_time"]
- # exclude = ["user"]
- # 分别是所有字段 包含某些字段 排除某些字段
- depth = 1
自定义字段
Meta中其它关键字参数
- class BookSerializer(serializers.ModelSerializer):
- chapter = serializers.CharField(source="get_chapter_display", read_only=True)
- class Meta:
- model = Book
- fields = "__all__"
- # fields = ["id", "title", "pub_time"]
- # exclude = ["user"]
- # 分别是所有字段 包含某些字段 排除某些字段
- depth = 1
- read_only_fields = ["id"]
- extra_kwargs = {"title": {"validators": [my_validate,]}}
Meta中的参数
post以及patch请求
由于depth会让我们外键变成只读,所以我们再定义一个序列化的类,其实只要去掉depth就可以了
- class BookSerializer(serializers.ModelSerializer):
- chapter = serializers.CharField(source="get_chapter_display", read_only=True)
- class Meta:
- model = Book
- fields = "__all__"
- # fields = ["id", "title", "pub_time"]
- # exclude = ["user"]
- # 分别是所有字段 包含某些字段 排除某些字段
- read_only_fields = ["id"]
- extra_kwargs = {"title": {"validators": [my_validate,]}}
post/patch请求系列化类
SerializerMethodField
外键关联的对象有很多字段我们是用不到的~都传给前端会有数据冗余~就需要我们自己去定制序列化外键对象的哪些字段~~
- class BookSerializer(serializers.ModelSerializer):
- chapter = serializers.CharField(source="get_chapter_display", read_only=True)
- user = serializers.SerializerMethodField()
- publisher = serializers.SerializerMethodField()
- def get_user(self, obj):
- # obj是当前序列化的book对象
- users_query_set = obj.user.all()
- return [{"id": user_obj.pk, "name": user_obj.name} for user_obj in users_query_set]
- def get_publisher(self, obj):
- publisher_obj = obj.publisher
- return {"id": publisher_obj.pk, "title": publisher_obj.title}
- class Meta:
- model = Book
- fields = "__all__"
- # fields = ["id", "title", "pub_time"]
- # exclude = ["user"]
- # 分别是所有字段 包含某些字段 排除某些字段
- read_only_fields = ["id"]
- extra_kwargs = {"title": {"validators": [my_validate,]}}
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)
- def get_users(self, obj):
- # obj是当前序列化的book对象
- users_query_set = obj.user.all()
- return [{"id": user_obj.pk, "name": user_obj.name} for user_obj in users_query_set]
- def get_publishers(self, obj):
- publisher_obj = obj.publisher
- return {"id": publisher_obj.pk, "title": publisher_obj.title}
- def get_dis_chapter(self, obj):
- return obj.get_chapter_display()
- class Meta:
- model = Book
- # fields = "__all__"
- # 字段是有序的
- fields = ["id", "title","dis_chapter", "pub_time", "publishers", "users","chapter", "user", "publisher"]
- # exclude = ["user"]
- # 分别是所有字段 包含某些字段 排除某些字段
- read_only_fields = ["id", "dis_chapter", "users", "publishers"]
- extra_kwargs = {"title": {"validators": [my_validate,]}, "user": {"write_only": True}, "publisher": {"write_only": True},
- "chapter": {"write_only": True}}
ModelSerializer
DRF 序列化组件的更多相关文章
- cvb源码分析,resful规范,drf,drf序列化组件,95
1 CBV的源码分析 -Class Base View(基于类的视图) -Function Base View(基于函数的视图) -def as_view 类方法 -def view:类方法内部,闭包 ...
- DRF 序列化组件 序列化的两种方式 反序列化 反序列化的校验
序列化组件 django自带的有序列化组件不过不可控不建议使用(了解) from django.core import serializers class Books(APIView): def ge ...
- DRF 序列化组件 模型层中参数补充
一. DRF序列化 django自带有序列化组件,但是相比rest_framework的序列化较差,所以这就不提django自带的序列化组件了. 首先rest_framework的序列化组件使用同fr ...
- 4)drf序列化组件 Serializer(偏底层)、ModelSerializer(重点)、ListModelSerializer(辅助群改)
知识点:Serializer(偏底层).ModelSerializer(重点).ListModelSerializer(辅助群改) 一.Serializer 偏底层 一般不用 理解原理 1.序列化准备 ...
- DRF - 序列化组件(GET/PUT/DELETE接口设计)、视图优化组件
一.序列化组件 基于上篇随笔的表结构 , 通过序列化组件的ModelSerializer设计如下三个接口 : GET 127.0.0.1:8000/books/{id} # 获取一条数据,返回值:{} ...
- DRF 序列化组件单增
目录 自定义序列化(矬) Serializer类(方式繁琐) 底层序列化类 UserSerializer 视图序列化步骤 底层反序列化类 UserCreatSerializer 视图反序列化步骤 Mo ...
- drf序列化组件
rest_framework序列化之Serializer 步骤: 1.自定义一个类,继承Serializer类: 2.在类中写要序列化的字段: 3.使用:在views.py文件中,book_ser=B ...
- drf序列化组件之视图家族
一.视图家族的分类 1.导入分类 from rest_framewok import views, generics, mixins, viewsets views:视图类 两大视图类:APIVi ...
- DjangoRestFramework学习二之序列化组件、视图组件 serializer modelserializer
DjangoRestFramework学习二之序列化组件.视图组件 本节目录 一 序列化组件 二 视图组件 三 xxx 四 xxx 五 xxx 六 xxx 七 xxx 八 xxx 一 序列化组 ...
随机推荐
- Java面试MySQL的一些问题
MySQL InnoDB存储的文件结构 索引树是如何维护的? 数据库自增主键可能的问题
- JWT认证原理及使用
一.JWT原理: 参考文章:https://www.jianshu.com/p/180a870a308a 1.传统的登录方式: 浏览器输入用户名密码,服务端校验通过,根据用户信息生成一个token,将 ...
- 移动web、webApp、混合APP、原生APP、androd H5混合开发 当无网络下,android怎么加载H5界面
PhoneGap是一个采用HTML,CSS和JavaScript的技术,创建移动跨平台移动应用程序的快速开发平台.它使开发者能够在网页中调用IOS,Android,Palm,Symbian,WP7,W ...
- hibernate 的sum(filed)引发的NullPointException错误解决过程
背景: 在用hql语句进行sum查询时遭遇NPE问题: StringBuilder builder = new StringBuilder("select SUM(actualWorking ...
- python_线程的开启、守护线程、锁、死锁、事件、定时器、条件、队列、池
0.承上 什么是线程? CPU调度的最小单位. 线程是进程的必要组成单位. 主线程: 程序开始运行的时候,就产生了一个主线进程来运行这个程序. 子线程: 是由主线程开启的其他线程. · 各线程之间的工 ...
- C#设计模式之6:抽象工厂模式
前面分析了简单工厂模式和工厂方法模式,接着来看一下抽象工厂模式,他与工厂方法模式有一些相似的地方,也有不同的地方. 先来看一个不用工厂方法模式实现的订购披萨的代码: 对象依赖的问题:当你直接实例化一个 ...
- gulp项目和webpack项目在浏览器中查看的方式
在存在.git的目录下,按住shift+左键,打开命令行或者使用git Bash Gulp: 输入gulp dev 本地起一个服务器,在项目中找到gulp.js,然后找本地服务器,找到host和por ...
- eclipse下的spring环境配置
1) 工具: (1) jdk (2) spring.jar .commons-logging-1.1.1.jar (因为只是做的简单的demo,所以就只用这两个jar包) spring.jar 是包 ...
- [转帖]一个FORK的面试题
一个FORK的面试题 https://coolshell.cn 搞不懂 fork 的含义. Linux 里面的线程不是教科书上面的标准的线程 好像用 父子进程来进行 模拟线程的处理 父子线程应该共享 ...
- UTC时间、GMT时间、本地时间、Unix时间戳
引用: https://blog.csdn.net/u012102306/article/details/51538574 https://blog.csdn.net/foxir/article/de ...