Serializers 序列化组件

Django的序列化方法

  1. class BooksView(View):
  2. def get(self, request):
  3. book_list = Book.objects.values("id", "title", "chapter", "pub_time", "publisher")
  4. book_list = list(book_list)
  5. # 如果我们需要取外键关联的字段信息 需要循环获取外键 再去数据库查然后拼接成我们想要的
  6. ret = []
  7. for book in book_list:
  8. pub_dict = {}
  9. pub_obj = Publish.objects.filter(pk=book["publisher"]).first()
  10. pub_dict["id"] = pub_obj.pk
  11. pub_dict["title"] = pub_obj.title
  12. book["publisher"] = pub_dict
  13. ret.append(book)
  14. ret = json.dumps(book_list, ensure_ascii=False, cls=MyJson)
  15. return HttpResponse(ret)
  16.  
  17. # json.JSONEncoder.default()
  18. # 解决json不能序列化时间字段的问题
  19. class MyJson(json.JSONEncoder):
  20. def default(self, field):
  21. if isinstance(field, datetime.datetime):
  22. return field.strftime('%Y-%m-%d %H:%M:%S')
  23. elif isinstance(field, datetime.date):
  24. return field.strftime('%Y-%m-%d')
  25. else:
  26. return json.JSONEncoder.default(self, field)

.values 序列化结果

  1. from django.core import serializers
  2.  
  3. # 能够得到我们要的效果 结构有点复杂
  4. class BooksView(View):
  5. def get(self, request):
  6. book_list = Book.objects.all()
  7. ret = serializers.serialize("json", book_list)
  8. return HttpResponse(ret)

django serializers

DRF序列化的方法

首先,我们要用DRF的序列化,就要遵循人家框架的一些标准,

  -- Django我们CBV继承类是View,现在DRF我们要用APIView

  -- Django中返回的时候我们用HTTPResponse,JsonResponse,render ,DRF我们用Response

为什么这么用~我们之后会详细讲~~我们继续来看序列化~~

序列化

  1. class BookSerializer(serializers.Serializer):
  2. id = serializers.IntegerField()
  3. title = serializers.CharField(max_length=32)
  4. CHOICES = ((1, "Linux"), (2, "Django"), (3, "Python"))
  5. chapter = serializers.ChoiceField(choices=CHOICES, source="get_chapter_display")
  6. pub_time = serializers.DateField()

第一步 声明序列化类

  1. from rest_framework.views import APIView
  2. from rest_framework.response import Response
  3.  
  4. class BookView(APIView):
  5. def get(self, request):
  6. book_list = Book.objects.all()
  7. ret = BookSerializer(book_list, many=True)
  8. return Response(ret.data)

第二部 序列化对象

外键关系的序列化

  1. # by gaoxin
  2. from rest_framework import serializers
  3. from .models import Book
  4.  
  5. class PublisherSerializer(serializers.Serializer):
  6. id = serializers.IntegerField(read_only=True)
  7. title = serializers.CharField(max_length=32)
  8.  
  9. class UserSerializer(serializers.Serializer):
  10. id = serializers.IntegerField(read_only=True)
  11. name = serializers.CharField(max_length=32)
  12. age = serializers.IntegerField()
  13.  
  14. class BookSerializer(serializers.Serializer):
  15. id = serializers.IntegerField(read_only=True)
  16. title = serializers.CharField(max_length=32)
  17. CHOICES = ((1, "Linux"), (2, "Django"), (3, "Python"))
  18. chapter = serializers.ChoiceField(choices=CHOICES, source="get_chapter_display", read_only=True)
  19. pub_time = serializers.DateField()
  20.  
  21. publisher = PublisherSerializer(read_only=True)
  22. user = UserSerializer(many=True, read_only=True)

外键关系的序列化

反序列化

当前端给我们发post的请求的时候~前端给我们传过来的数据~我们要进行一些校验然后保存到数据库~

这些校验以及保存工作,DRF的Serializer也给我们提供了一些方法了~~

首先~我们要写反序列化用的一些字段~有些字段要跟序列化区分开~~

Serializer提供了.is_valid()  和.save()方法~~

  1. # serializers.py 文件
  2. class BookSerializer(serializers.Serializer):
  3. id = serializers.IntegerField(read_only=True)
  4. title = serializers.CharField(max_length=32)
  5. CHOICES = ((1, "Linux"), (2, "Django"), (3, "Python"))
  6. chapter = serializers.ChoiceField(choices=CHOICES, source="get_chapter_display", read_only=True)
  7. w_chapter = serializers.IntegerField(write_only=True)
  8. pub_time = serializers.DateField()
  9.  
  10. publisher = PublisherSerializer(read_only=True)
  11. user = UserSerializer(many=True, read_only=True)
  12.  
  13. users = serializers.ListField(write_only=True)
  14. publisher_id = serializers.IntegerField(write_only=True)
  15.  
  16. def create(self, validated_data):
  17. 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"])
  18. book.user.add(*validated_data["users"])
  19. return book

反序列化serializer.py

  1. class BookView(APIView):
  2. def get(self, request):
  3. book_list = Book.objects.all()
  4. ret = BookSerializer(book_list, many=True)
  5. return Response(ret.data)
  6.  
  7. def post(self, request):
  8. # book_obj = request.data
  9. print(request.data)
  10. serializer = BookSerializer(data=request.data)
  11. if serializer.is_valid():
  12. print(12341253)
  13. serializer.save()
  14. return Response(serializer.validated_data)
  15. else:
  16. return Response(serializer.errors)

反序列化views.py

但前端给我们发送patch请求的时候, 前端传给我们用户需要更新的数据, 我们要对数据进行部分验证.

  1. class BookSerializer(serializers.Serializer):
  2. id = serializers.IntegerField(read_only=True)
  3. title = serializers.CharField(max_length=32)
  4. CHOICES = ((1, "Linux"), (2, "Django"), (3, "Python"))
  5. chapter = serializers.ChoiceField(choices=CHOICES, source="get_chapter_display", read_only=True)
  6. w_chapter = serializers.IntegerField(write_only=True)
  7. pub_time = serializers.DateField()
  8.  
  9. publisher = PublisherSerializer(read_only=True)
  10. user = UserSerializer(many=True, read_only=True)
  11.  
  12. users = serializers.ListField(write_only=True)
  13. publisher_id = serializers.IntegerField(write_only=True)
  14.  
  15. def create(self, validated_data):
  16. book = Book.objects.create(title=validated_data["title"], chapter=validated_data["w_chapter"], pub_time=validated_data["pub_time"],
  17. publisher_id=validated_data["publisher_id"])
  18. book.user.add(*validated_data["users"])
  19. return book
  20.  
  21. def update(self, instance, validated_data):
  22. instance.title = validated_data.get("title", instance.title)
  23. instance.chapter = validated_data.get("w_chapter", instance.chapter)
  24. instance.pub_time = validated_data.get("pub_time", instance.pub_time)
  25. instance.publisher_id = validated_data.get("publisher_id", instance.publisher_id)
  26. if validated_data.get("users"):
  27. instance.user.set(validated_data.get("users"))
  28. instance.save()
  29. return instance

PATCH请求serializers.py

  1. class BookView(APIView):
  2. def patch(self, request):
  3. print(request.data)
  4. book_id = request.data["id"]
  5. book_info = request.data["book_info"]
  6. book_obj = Book.objects.filter(pk=book_id).first()
  7. serializer = BookSerializer(book_obj, data=book_info, partial=True)
  8. if serializer.is_valid():
  9. serializer.save()
  10. return Response(serializer.data)
  11. else:
  12. return Response(serializer.errors)

PATCH请求views.py

验证

如果我们需要对一些字段进行自定义的验证~DRF也给我们提供了钩子方法.

  1. class BookSerializer(serializers.Serializer):
  2. id = serializers.IntegerField(read_only=True)
  3. title = serializers.CharField(max_length=32)
  4. # 省略了一些字段 跟上面代码里一样的
  5. # 。。。。。
  6. def validate_title(self, value):
  7. if "python" not in value.lower():
  8. raise serializers.ValidationError("标题必须含有Python")
  9. return value

单个字段的验证

  1. class BookSerializer(serializers.Serializer):
  2. id = serializers.IntegerField(read_only=True)
  3. title = serializers.CharField(max_length=32)
  4. CHOICES = ((1, "Linux"), (2, "Django"), (3, "Python"))
  5. chapter = serializers.ChoiceField(choices=CHOICES, source="get_chapter_display", read_only=True)
  6. w_chapter = serializers.IntegerField(write_only=True)
  7. pub_time = serializers.DateField()
  8. date_added = serializers.DateField(write_only=True)
  9. # 新增了一个上架时间字段
  10. # 省略一些字段。。都是在原基础代码上增加的
  11. # 。。。。。。
  12.  
  13. # 对多个字段进行验证 要求上架日期不能早于出版日期 上架日期要大
  14. def validate(self, attrs):
  15. if attrs["pub_time"] > attrs["date_added"]:
  16. raise serializers.ValidationError("上架日期不能早于出版日期")
  17. return attrs

多个字段的验证

  1. def my_validate(value):
  2. if "敏感词汇" in value.lower:
  3. raise serializers.ValidationError("包含敏感词汇,请重新提交")
  4. return value
  5.  
  6. class BookSerializer(serializers.Serializer):
  7. id = serializers.IntegerField(read_only=True)
  8. title = serializers.CharField(max_length=32, validators=[my_validate])
  9. # 。。。。。。

验证器 validators

ModelSerializer

现在我们已经清楚了Serializer的用法,会发现我们所有的序列化跟我们的模型都紧密相关~

那么,DRF也给我们提供了跟模型紧密相关的序列化器~~ModelSerializer~~

  -- 它会根据模型自动生成一组字段

  -- 它简单的默认实现了.update()以及.create()方法

定义一个ModelSerializer序列化器

  1. class BookSerializer(serializers.ModelSerializer):
  2. class Meta:
  3. model = Book
  4. fields = "__all__"
  5. # fields = ["id", "title", "pub_time"]
  6. # exclude = ["user"]
  7. # 分别是所有字段 包含某些字段 排除某些字段

定义ModelSerializer

外键关系的序列化

注意:当序列化类MATE中定义了depth时,这个序列化类中引用字段(外键)则自动变为只读

  1. class BookSerializer(serializers.ModelSerializer):
  2. class Meta:
  3. model = Book
  4. fields = "__all__"
  5. # fields = ["id", "title", "pub_time"]
  6. # exclude = ["user"]
  7. # 分别是所有字段 包含某些字段 排除某些字段
  8. depth = 1
  9. # depth 代表找嵌套关系的第几层

外键关系序列化

自定义字段

我们可以声明一些字段来覆盖默认字段,来进行自定制~

比如我们的选择字段,默认显示的是选择的key,我们要给用户展示的是value。

  1. class BookSerializer(serializers.ModelSerializer):
  2. chapter = serializers.CharField(source="get_chapter_display", read_only=True)
  3.  
  4. class Meta:
  5. model = Book
  6. fields = "__all__"
  7. # fields = ["id", "title", "pub_time"]
  8. # exclude = ["user"]
  9. # 分别是所有字段 包含某些字段 排除某些字段
  10. depth = 1

自定义字段

Meta中其它关键字参数

  1. class BookSerializer(serializers.ModelSerializer):
  2. chapter = serializers.CharField(source="get_chapter_display", read_only=True)
  3.  
  4. class Meta:
  5. model = Book
  6. fields = "__all__"
  7. # fields = ["id", "title", "pub_time"]
  8. # exclude = ["user"]
  9. # 分别是所有字段 包含某些字段 排除某些字段
  10. depth = 1
  11. read_only_fields = ["id"]
  12. extra_kwargs = {"title": {"validators": [my_validate,]}}

Meta中的参数

post以及patch请求

由于depth会让我们外键变成只读,所以我们再定义一个序列化的类,其实只要去掉depth就可以了

  1. class BookSerializer(serializers.ModelSerializer):
  2. chapter = serializers.CharField(source="get_chapter_display", read_only=True)
  3.  
  4. class Meta:
  5. model = Book
  6. fields = "__all__"
  7. # fields = ["id", "title", "pub_time"]
  8. # exclude = ["user"]
  9. # 分别是所有字段 包含某些字段 排除某些字段
  10. read_only_fields = ["id"]
  11. extra_kwargs = {"title": {"validators": [my_validate,]}}

post/patch请求系列化类

SerializerMethodField

外键关联的对象有很多字段我们是用不到的~都传给前端会有数据冗余~就需要我们自己去定制序列化外键对象的哪些字段~~

  1. class BookSerializer(serializers.ModelSerializer):
  2. chapter = serializers.CharField(source="get_chapter_display", read_only=True)
  3. user = serializers.SerializerMethodField()
  4. publisher = serializers.SerializerMethodField()
  5.  
  6. def get_user(self, obj):
  7. # obj是当前序列化的book对象
  8. users_query_set = obj.user.all()
  9. return [{"id": user_obj.pk, "name": user_obj.name} for user_obj in users_query_set]
  10.  
  11. def get_publisher(self, obj):
  12. publisher_obj = obj.publisher
  13. return {"id": publisher_obj.pk, "title": publisher_obj.title}
  14.  
  15. class Meta:
  16. model = Book
  17. fields = "__all__"
  18. # fields = ["id", "title", "pub_time"]
  19. # exclude = ["user"]
  20. # 分别是所有字段 包含某些字段 排除某些字段
  21. read_only_fields = ["id"]
  22. extra_kwargs = {"title": {"validators": [my_validate,]}}

SerializerMethodField

用ModelSerializer改进上面Serializer的完整版

  1. class BookSerializer(serializers.ModelSerializer):
  2. dis_chapter = serializers.SerializerMethodField(read_only=True)
  3. users = serializers.SerializerMethodField(read_only=True)
  4. publishers = serializers.SerializerMethodField(read_only=True)
  5.  
  6. def get_users(self, obj):
  7. # obj是当前序列化的book对象
  8. users_query_set = obj.user.all()
  9. return [{"id": user_obj.pk, "name": user_obj.name} for user_obj in users_query_set]
  10.  
  11. def get_publishers(self, obj):
  12. publisher_obj = obj.publisher
  13. return {"id": publisher_obj.pk, "title": publisher_obj.title}
  14.  
  15. def get_dis_chapter(self, obj):
  16. return obj.get_chapter_display()
  17.  
  18. class Meta:
  19. model = Book
  20. # fields = "__all__"
  21. # 字段是有序的
  22. fields = ["id", "title","dis_chapter", "pub_time", "publishers", "users","chapter", "user", "publisher"]
  23. # exclude = ["user"]
  24. # 分别是所有字段 包含某些字段 排除某些字段
  25. read_only_fields = ["id", "dis_chapter", "users", "publishers"]
  26. extra_kwargs = {"title": {"validators": [my_validate,]}, "user": {"write_only": True}, "publisher": {"write_only": True},
  27. "chapter": {"write_only": True}}

ModelSerializer

DRF 序列化组件的更多相关文章

  1. cvb源码分析,resful规范,drf,drf序列化组件,95

    1 CBV的源码分析 -Class Base View(基于类的视图) -Function Base View(基于函数的视图) -def as_view 类方法 -def view:类方法内部,闭包 ...

  2. DRF 序列化组件 序列化的两种方式 反序列化 反序列化的校验

    序列化组件 django自带的有序列化组件不过不可控不建议使用(了解) from django.core import serializers class Books(APIView): def ge ...

  3. DRF 序列化组件 模型层中参数补充

    一. DRF序列化 django自带有序列化组件,但是相比rest_framework的序列化较差,所以这就不提django自带的序列化组件了. 首先rest_framework的序列化组件使用同fr ...

  4. 4)drf序列化组件 Serializer(偏底层)、ModelSerializer(重点)、ListModelSerializer(辅助群改)

    知识点:Serializer(偏底层).ModelSerializer(重点).ListModelSerializer(辅助群改) 一.Serializer 偏底层 一般不用 理解原理 1.序列化准备 ...

  5. DRF - 序列化组件(GET/PUT/DELETE接口设计)、视图优化组件

    一.序列化组件 基于上篇随笔的表结构 , 通过序列化组件的ModelSerializer设计如下三个接口 : GET 127.0.0.1:8000/books/{id} # 获取一条数据,返回值:{} ...

  6. DRF 序列化组件单增

    目录 自定义序列化(矬) Serializer类(方式繁琐) 底层序列化类 UserSerializer 视图序列化步骤 底层反序列化类 UserCreatSerializer 视图反序列化步骤 Mo ...

  7. drf序列化组件

    rest_framework序列化之Serializer 步骤: 1.自定义一个类,继承Serializer类: 2.在类中写要序列化的字段: 3.使用:在views.py文件中,book_ser=B ...

  8. drf序列化组件之视图家族

    一.视图家族的分类 1.导入分类 from rest_framewok import views, generics, mixins, viewsets views:视图类 ​ 两大视图类:APIVi ...

  9. DjangoRestFramework学习二之序列化组件、视图组件 serializer modelserializer

      DjangoRestFramework学习二之序列化组件.视图组件   本节目录 一 序列化组件 二 视图组件 三 xxx 四 xxx 五 xxx 六 xxx 七 xxx 八 xxx 一 序列化组 ...

随机推荐

  1. Java面试MySQL的一些问题

    MySQL InnoDB存储的文件结构 索引树是如何维护的? 数据库自增主键可能的问题

  2. JWT认证原理及使用

    一.JWT原理: 参考文章:https://www.jianshu.com/p/180a870a308a 1.传统的登录方式: 浏览器输入用户名密码,服务端校验通过,根据用户信息生成一个token,将 ...

  3. 移动web、webApp、混合APP、原生APP、androd H5混合开发 当无网络下,android怎么加载H5界面

    PhoneGap是一个采用HTML,CSS和JavaScript的技术,创建移动跨平台移动应用程序的快速开发平台.它使开发者能够在网页中调用IOS,Android,Palm,Symbian,WP7,W ...

  4. hibernate 的sum(filed)引发的NullPointException错误解决过程

    背景: 在用hql语句进行sum查询时遭遇NPE问题: StringBuilder builder = new StringBuilder("select SUM(actualWorking ...

  5. python_线程的开启、守护线程、锁、死锁、事件、定时器、条件、队列、池

    0.承上 什么是线程? CPU调度的最小单位. 线程是进程的必要组成单位. 主线程: 程序开始运行的时候,就产生了一个主线进程来运行这个程序. 子线程: 是由主线程开启的其他线程. · 各线程之间的工 ...

  6. C#设计模式之6:抽象工厂模式

    前面分析了简单工厂模式和工厂方法模式,接着来看一下抽象工厂模式,他与工厂方法模式有一些相似的地方,也有不同的地方. 先来看一个不用工厂方法模式实现的订购披萨的代码: 对象依赖的问题:当你直接实例化一个 ...

  7. gulp项目和webpack项目在浏览器中查看的方式

    在存在.git的目录下,按住shift+左键,打开命令行或者使用git Bash Gulp: 输入gulp dev 本地起一个服务器,在项目中找到gulp.js,然后找本地服务器,找到host和por ...

  8. eclipse下的spring环境配置

    1) 工具: (1) jdk (2) spring.jar  .commons-logging-1.1.1.jar (因为只是做的简单的demo,所以就只用这两个jar包) spring.jar 是包 ...

  9. [转帖]一个FORK的面试题

    一个FORK的面试题 https://coolshell.cn 搞不懂 fork 的含义. Linux 里面的线程不是教科书上面的标准的线程 好像用 父子进程来进行 模拟线程的处理 父子线程应该共享 ...

  10. UTC时间、GMT时间、本地时间、Unix时间戳

    引用: https://blog.csdn.net/u012102306/article/details/51538574 https://blog.csdn.net/foxir/article/de ...