Django用rest_framework里的serializers.Serializer序列化

已于 2023-02-03 11:37:33 修改
阅读量1.4k 收藏 4
点赞数 5
分类专栏： # rest_framework 文章标签： 序列化
于 2019-07-24 18:27:38 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zsx1314lovezyf/article/details/97148413
版权

序列化组件的使用及接口设计

  1. 请求接口设计get请求(restapi规范)

      GET						127.0.0.1:8000/books/			# 获取所有数据, 返回值:[{}, {}, {}]
  GET						127.0.0.1:8000/books/{id}       # 获取一条数据, 返回值:{}
  POST					    127.0.0.1:8000/books/			# 新增一条数据, 返回值:{}
  PUT						127.0.0.1:8000/books/{id}       # 修改一条数据, 返回值:{}
  DELETE                    127.0.0.1:8000/books/{id}       # 删除一条数据, 返回值: 空对象

  2. 创建model.py

    1. python manage.py makemigrations

    2. python manage.py migrate

    3. urls.py

    4. views.py

    5. 开始使用序列化

      1. 导入模块 from rest_framework import serializers

      2. 建立一个序列化类

        class BookSerializer(serializers.Serializer):
  	字段可以自定义

      3. 获取queryset

        origin_data = Book.objects.all()

      4. 开始序列化

        serialized_data = BookSerializer(origin_data, many=True )

      5. 序列化后的数据, 返回给客户端

        return Response(serialized_data.data)

案例GET请求

  1. 创建模型类

    from django.db import models

from datetime import datetime
# from django.contrib.auth.models import AbstractUser


class AuthorInfo(models.Model):
    name = models.CharField(max_length=32, verbose_name="作者名称")
    age = models.IntegerField(verbose_name="作者年龄")

    class Meta:
        db_table = "db_author_info"
        verbose_name = "作者信息"
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.name


class PublishInfo(models.Model):
    name = models.CharField(max_length=32, verbose_name="出版社名称")
    city = models.CharField(max_length=32, verbose_name="出版社所在城市")
    email = models.EmailField(verbose_name="出版社邮箱")

    class Meta:
        db_table = "db_publish_info"
        verbose_name = "出版社信息"
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.name


class BookInfo(models.Model):
    title = models.CharField(max_length=32, verbose_name="书名")
    publishDate = models.DateField(default=datetime.now, verbose_name="出版日期")

    # max_digits小数位加整数位多少长度 decimal_places小数位长度为2
    price = models.DecimalField(max_digits=5, decimal_places=2, verbose_name="图书价格")
    
    # on_delete
    # CASCADE:这就是默认的选项，级联删除，你无需显性指定它。
		# PROTECT: 保护模式，如果采用该选项，删除的时候，会抛出ProtectedError错误。
		# SET_NULL: 置空模式，删除的时候，外键字段被设置为空，前提就是blank=True, null=True,定义该字段的时候，允许为空。
		# SET_DEFAULT: 置默认值，删除的时候，外键字段设置为默认值，所以定义外键的时候注意加上一个默认值。
		# SET(): 自定义一个值，该值当然只能是对应的实体了
    publish = models.ForeignKey(PublishInfo, related_name="book", related_query_name="book_query", on_delete=models.CASCADE, verbose_name="出版社")
    # ManyToManyField多对多
    authors = models.ManyToManyField(AuthorInfo, verbose_name="图书作者")

    class Meta:
        db_table = "db_book_info"
        verbose_name = "图书信息"
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.title

  2. 创建urls.py

    from django.urls import re_path
from .views import BookView

urlpatterns = [
  	# restapi风格定制路由
    re_path(r"^books/$", BookView.as_view()),
]

  3. 创建views.py

    1. 导入模块

      # 第一步: 导入模块
from rest_framework import serializers

    2. 建立序列化类

      # 第二步: 创建序列化类, 字段类型不一定要跟model的字段一致
class BookSerializer(serializers.Serializer):
    title = serializers.CharField(max_length=128)
    publishDate = serializers.DateField(default=datetime.now)
    price = serializers.DecimalField(max_digits=5, decimal_places=2)

    # 序列化没有外键(ForeignKey)和多对多(ManyToManyField)
    # 显示出来的是id值, 意义不大可以不写
  	# 外键字段
    publish = serializers.CharField()
    # 外键字段显示__str__方法的返回值, 但是你写了source那么source指定的值覆盖掉__str__的值
    # (注意source指定的值必须是模型类里面的)
    # read_only=True 读的时候有它, 写的时候不需要它
    publish_name = serializers.CharField(max_length=32, read_only=True, source="publish.name")
    publish_city = serializers.CharField(max_length=32, read_only=True, source="publish.city")

    # author = serializers.CharField(max_length=32)
    # 多对多字段需要自己手动获取数据, SerializerMethodField(), 他就会自动去找一个(get_固定格式)get_当前字段(authors)
    # SerializerMethodField()默认是自读字段, 写的时候是不会检查的,  它源码里写了read_only=True
    authors = serializers.SerializerMethodField()

    # 方法名必须是get_ 加上字段上面的多对多字段的名
    # 固定传一个当前表的对象
    def get_authors(self, book_obj):
        author_list = []
        # book_obj.authors.all() 获取所有author对象
        for author in book_obj.authors.all():
         author_list.append(author.name)
        # 返回的值就是authors的值
     return author_list

    3. 获取queryset/开始序列化/序列化后的数据, 返回给客户端

      from rest_framework.views import APIView
# Response返回序列化对象
from rest_framework.response import Response

from .models import BookInfo, PublishInfo, AuthorInfo
from .app_serializers import BookSerializer


class BookView(APIView):
    def get(self, request):
        # 第三步: 获取queryset
        origin_data = BookInfo.objects.all()

        # 第四步: 开始序列化
        # 当序列化多条数据时 要加上many=True
        serialized_data = BookSerializer(origin_data, many=True)
				
        # 返回序列化对象
        # 记住序列化的值在data属性里
        # 所以这里用serialized_data.data取序列化的值
        return Response(serialized_data.data)

    4. postman效果图
      在这里插入图片描述

    5. 浏览器效果图
      在这里插入图片描述

序列化组件接口设计post请求

  1. 通过序列化组件进行

    GET						127.0.0.1:8000/books/			# 获取所有数据, 返回值:[{}, {}, {}]
GET						127.0.0.1:8000/books/{id}       # 获取一条数据, 返回值:{}
POST					127.0.0.1:8000/books/			# 新增一条数据, 返回值:{}
PUT						127.0.0.1:8000/books/{id}       # 修改一条数据, 返回值:{}
DELETE                  127.0.0.1:8000/books/{id}       # 删除一条数据, 返回值: 空对象

    1. 创建model.py

      1. python manage.py makemigrations
      2. python manage.py migrate

    2. urls.py

    3. views.py

      1. 开始使用序列化

        1. 导入模块 from rest_framework import serializers

        2. 建立一个序列化类

          class BookSerializer(serializers.Serializer):
  	字段可以自定义

        3. 获取客户端请求数据

        4. 开始序列化

          verified_data = BookSerializer(data=client_data, many=False)

        5. 写入数据库
          book = verified_data.save()

        6. 序列化后的数据, 返回给客户端

          return Response(serialized_data.data)

案列POST请求

  1. 创建模型类

    from django.db import models

from datetime import datetime
# from django.contrib.auth.models import AbstractUser


class AuthorInfo(models.Model):
    name = models.CharField(max_length=32, verbose_name="作者名称")
    age = models.IntegerField(verbose_name="作者年龄")

    class Meta:
        db_table = "db_author_info"
        verbose_name = "作者信息"
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.name


class PublishInfo(models.Model):
    name = models.CharField(max_length=32, verbose_name="出版社名称")
    city = models.CharField(max_length=32, verbose_name="出版社所在城市")
    email = models.EmailField(verbose_name="出版社邮箱")

    class Meta:
        db_table = "db_publish_info"
        verbose_name = "出版社信息"
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.name


class BookInfo(models.Model):
    title = models.CharField(max_length=32, verbose_name="书名")
    publishDate = models.DateField(default=datetime.now, verbose_name="出版日期")

    # max_digits小数位加整数位多少长度 decimal_places小数位长度为2
    price = models.DecimalField(max_digits=5, decimal_places=2, verbose_name="图书价格")
    
    # on_delete
    # CASCADE:这就是默认的选项，级联删除，你无需显性指定它。
	# PROTECT: 保护模式，如果采用该选项，删除的时候，会抛出ProtectedError错误。
	# SET_NULL: 置空模式，删除的时候，外键字段被设置为空，前提就是blank=True, null=True,定义该字段的时候，允许为空。
	# SET_DEFAULT: 置默认值，删除的时候，外键字段设置为默认值，所以定义外键的时候注意加上一个默认值。
	# SET(): 自定义一个值，该值当然只能是对应的实体了
    publish = models.ForeignKey(PublishInfo, related_name="book", related_query_name="book_query", on_delete=models.CASCADE, verbose_name="出版社")
    # ManyToManyField多对多
    authors = models.ManyToManyField(AuthorInfo, verbose_name="图书作者")

    class Meta:
        db_table = "db_book_info"
        verbose_name = "图书信息"
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.title

  2. 创建urls.py

    from django.urls import re_path
from .views import BookView

urlpatterns = [
  	# restapi风格定制路由
    re_path(r"^books/$", BookView.as_view()),
]

  3. 创建views.py

    1. 导入模块

      # 第一步: 导入模块
from rest_framework import serializers

    2. 建立序列化类, 并且要自定义create方法

      # 第二步: 创建序列化类, 字段类型不一定要跟model的字段一致
class BookSerializer(serializers.Serializer):
    title = serializers.CharField(max_length=128)
    publishDate = serializers.DateField(default=datetime.now)
    price = serializers.DecimalField(max_digits=5, decimal_places=2)

    # 序列化没有外键(ForeignKey)和多对多(ManyToManyField)
    # 显示出来的是id值, 意义不大可以不写
  	# 外键字段
    publish = serializers.CharField()
    # 外键字段显示__str__方法的返回值, 但是你写了source那么source指定的值覆盖掉__str__的值
    # (注意source指定的值必须是模型类里面的)
    # read_only=True 读的时候有它, 写的时候不需要它
    publish_name = serializers.CharField(max_length=32, read_only=True, source="publish.name")
    publish_city = serializers.CharField(max_length=32, read_only=True, source="publish.city")

    # author = serializers.CharField(max_length=32)
    # 多对多字段需要自己手动获取数据, SerializerMethodField(), 他就会自动去找一个(get_固定格式)get_当前字段(authors)
    # SerializerMethodField()默认是自读字段, 写的时候是不会检查的,  它源码里写了read_only=True
    authors = serializers.SerializerMethodField()

    # 方法名必须是get_ 加上字段上面的多对多字段的名
    # 固定传一个当前表的对象
    def get_authors(self, book_obj):
        author_list = []
        # book_obj.authors.all() 获取所有author对象
        for author in book_obj.authors.all():
            author_list.append(author.name)
        # 返回的值就是authors的值
        return author_list
      
    def create(self, validated_data):
    	# 把上面所有的字段放在validated_data里面
        # {'price': Decimal('66.00'), 'publishDate': datetime.date(2019, 7, 25), 'title': 'python666', 'publish': '2'}
        print(validated_data)
        validated_data["publish_id"] = validated_data.pop("publish")
        # {'publishDate': datetime.date(2019, 7, 25), 'publish_id': '2', 'title': 'python666', 'price': Decimal('66.00')}
        print(validated_data)
        # **validated_data 字典解析
        # 创建数据库对象并且保存在数据库中, 并把这个对象返回给book
        book = BookInfo.objects.create(**validated_data)
        return book

    3. 获取数据/开始序列化/序列化后的数据, 返回给客户端

      from rest_framework.views import APIView
# Response返回序列化对象
from rest_framework.response import Response

from .models import BookInfo, PublishInfo, AuthorInfo
from .app_serializers import BookSerializer


class BookView(APIView):
    def get(self, request):
        # 第三步: 获取queryset
        origin_data = BookInfo.objects.all()

        # 第四步: 开始序列化
        # 当序列化多条数据时 要加上many=True
        serialized_data = BookSerializer(origin_data, many=True)
				
        # 返回序列化对象
        # 记住序列化的值在data属性里
        # 所以这里用serialized_data.data取序列化的值
        return Response(serialized_data.data)
      
     def post(self, request):
        # 接受前端发送的json数据
        client_data = request.data

        # many默认是False, 可以省略不写
        # 开始序列化
        verified_data = BookSerializer(data=client_data, many=False)
        # 判断序列化数据的合法性
        if verified_data.is_valid():
            # 当执行save()他就会去找create方法, 并且接受create的返回值
            book = verified_data.save()
            # 查询出id在request.data这个列表里的对象
            authors = AuthorInfo.objects.filter(id__in=request.data["authors"])
            # *authors列表解析
            # book这个对象下的authors是一个列表把查询出来的authors对象添加到book.authors对象中
            book.authors.add(*authors)
            return Response(verified_data.data)
        else:
            return Response(verified_data.errors)

    4. postman效果图
      在这里插入图片描述

只因为你温柔
关注
  • 5
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
django rest framework serializers序列化实例
09-16
在Django REST Framework (DRF)中，`serializers` 是关键组件，它负责数据的序列化和反序列化过程，使得数据可以在Python对象和JSON/XML等格式之间转换。这在构建API接口时尤其重要，因为我们需要将数据库中的模型...
rest framework框架--序列化
no_name_sky的博客
10-19 532
数据准备 models.py from django.db import models # Create your models here. class Group(models.Model): title = models.CharField(verbose_name="组名", max_length=32) class Role(models.Model): title = models.CharField(verbose_name="角色名", max_length=32)
rest_framework学习之序列化（Serializer）
zhubaoJay的博客
07-01 1352
什么是序列化？ 在我看来，序列化就是将复杂的对象数据转化为简单的通用数据格式（如json），这么一个过程就是序列化。反序列化同理。 我们看下DRF对序列化解释，序列化器允许将复杂数据(如查询集和模型实例)转换为原生Python数据类型，然后可以轻松地将其呈现为JSON、XML或其他内容类型。序列化器还提供反序列化，允许在首先验证传入的数据之后将解析后的数据转换回复杂类型。 PS：还是官方专业...
django-rest-framework serializers.Serializer使用总结
Oudelosiki的博客
04-05 3656
django-rest-framework是构建web API的一个包，功能强大也很灵活，遵循restful标准，如果对于rest标准还不熟悉，推荐看一下阮一峰的文章理解restful架构restful设计指南django-rest-framework安装pip install djangorestframework这篇文章对django-rest-framework有一个详细的综述，如果还不了解...
Django REST Framework（DRF）框架之Serializer序列化器的使用
积跬步，至千里。
03-30 3905
Django REST Framework（简称DRF）是基于Django Web框架的一个开源的Web API框架。它提供了一组用于快速构建Web API的工具和库，包括序列化器、认证、权限、视图、路由和文档化等功能。
【DRF】Django Rest Framework（3.DRF的序列化器-serializers.Serializer详解）
Mogul的博客
02-08 934
required=False, 可以不用传，默认是True注意，序列化器的类型，参数，最好要与模型类保持一致。
django自带serializers序列化返回指定字段的方法
09-18
以下将详细介绍如何在Django中使用`serializers`序列化返回指定字段： 1. **基本使用**： Django的`serializers.serialize()`函数接受四个参数： - `format`：指定序列化格式，例如'json'、'xml'等。 - `...
django Serializer序列化使用方法详解
09-20
在Django REST Framework中，`Serializer` 是一个关键组件，用于将Python对象转换为JSON或其他可传输的格式，以及将接收到的用户输入反序列化回Python对象。它简化了数据处理过程，使得数据在视图层和API之间进行...
django rest framework 自定义返回方式
12-17
from rest_framework.serializers import Serializer class JsonResponse(Response): """自定义的Response类，增加code和msg字段""" def __init__(self, data=None, code=None, msg=None, status=None, **kwargs)...
Django序列化器之serializers.SerializerMethodField()
我就叫贝塔
10-12 3189
源代码: class SerializerMethodField(Field): """ A read-only field that get its representation from calling a method on the parent serializer class. The method called will be of the form "get_{field_name}", and should take a single argument, wh
序列化 serializers
weixin_30830327的博客
10-16 265
Django的序列化工具让你可以将Django的模型‘翻译’成其它格式的数据。通常情况下，这种其它格式的数据是基于文本的，并且用于数据交换\传输过程。 一、序列化数据 Django为我们提供了一个强大的序列化工具serializers。使用它也很简单，如下所示： from django.core import serializers data = serializers.seriali...
drf 序列化器 serializers.Serializer
weixin_55024601的博客
11-26 46
Django 里面的序列化其实就是在后端把从数据库中取出来的模型类数据转化成 json 格式传递给前端。相应的反序列化就是把从前端接收到的 json 数据转化成模型类数据再去进行相应的数据库操作。普通的序列化器继承自 serializers.Serializer，需要自己定义想要序列化的字段，根据数据库中表的字段要求设置相应的字段要求，比如：需要传哪些字段就序列化哪些字段，并在序列化器中定义这些字段。这里的语法其实跟在 models.py 中定义数据库表字段的时候很像。
APIView 怎么写？
YuanBao717的博客
06-16 206
APIView怎么写？
Django REST framework中的序列化Serializers
javascript_good的博客
09-04 795
序列化器允许将诸如查询集和模型实例之类的复杂数据转换为原生 Python 数据类型，然后可以将它们轻松地呈现为 JSON，XML 或其他内容类型。序列化器还提供反序列化，在首次验证传入数据之后，可以将解析的数据转换回复杂类型。简单来说，服务器通过api 返回数据（json格式），把非json格式转换为json 就是序列化的过程浏览器提交给服务器端的数据，服务端将json 格式转换给非json存储到数据库，就是反序列化。
DRF-serializers.Serializer序列化器
张鑫宇
03-12 628
模型类用例 这里设置一个Django ORM用来当作下面的测试用例 class StudentInfo(models.Model): name = models.CharField(max_length=20, verbose_name='姓名') birthday = models.DateField(verbose_name='生日', null=True) mon...
Django rest framework的Serializers详解
Faith的博客
01-26 2932
Serializers把querysets和model instances这些复杂的数据结构转化为native Python 以便于以json,xml或其它内容类型的形式render出去。 类似于Django的 Form 和ModelFormSerializer和ModelSerializer 序列化对象 from datetime import datetime class Co
[django-rest-framework]-序列化器Serializer
iamballer77的博客
08-05 1905
drf序列化器学习
django rest framework 学习笔记2
最新发布
种一棵树，最好的结果是十年前，其次是现在！
02-19 822
接口文档：DRF 自动生成网页版的接口文档，其生成的是继承APIView及其子类的视图。过滤：使用列表数据过滤字段信息，可使用django-fitlter扩展支持。注意：该文章部分摘抄之百度，仅当做学习笔记供小白使用，若侵权请联系删除！读取到的结果器数据关联的为数字，此时需要进行一些操作可以读到正确数据。限流： 限制接口的访问频率，减少服务器的压力（反爬虫）显示关联表的数据，本示例会显示所有的关联的数据信息。方法1： source='表名.属性值'显示choice类型字段的对应数据。
drf : 序列化类使用many参数的作用，源码解析
felix的博客
04-01 359
序列化类使用many参数的作用 views.py from rest_framework.views import APIView from .serizlizer import BookSerializers from rest_framework.response import Response from .models import Books class BookView(APIVi...
django遍历rest_framework.serializers.ListSerializer类型的数据
06-10
from rest_framework import serializers class MySerializer(serializers.ListSerializer): ... data = [...] serializer = MySerializer(data=data, many=True) ``` 2. 遍历 `ListSerializer` 中的每一个元素 ...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

只因为你温柔

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值