美文网首页
# Django Rest_Framework(二)序列化器Se

# Django Rest_Framework(二)序列化器Se

作者: Gavininn | 来源:发表于2019-05-18 18:22 被阅读0次

    作用:

    1.序列化,序列化器会把模型对象转换成字典,经过response以后变成Json字符串

    1. 反序列化,序列化器会把客户端发送过来的数据,经过request以后变成字典,把字典转化成模型

    2. 完成数据校验功能。

    一、定义序列化器

    Django REST Framework中的Serializer使用类来定义,继承自rest_framework.serializers.Serializer

    举个例子:

    1.创建一个新的子应用sers
    $ python manage.py startapp sers
    
    2.建一个模型类,这里我们沿用上一篇中的模型类students/Student 参考上一篇的链接:https://www.jianshu.com/p/d082f7e5b5cb
    from django.db import models
    
    # Create your models here.
    class Student(models.Model):
        # 模型字段
        name = models.CharField(max_length=100,verbose_name="姓名",help_text="提示文本:账号不能为空!")
        sex = models.BooleanField(default=True,verbose_name="性别")
        age = models.IntegerField(verbose_name="年龄")
        class_null = models.CharField(max_length=5,verbose_name="班级编号")
        description = models.TextField(verbose_name="个性签名")
    
        class Meta:
            db_table="tb_student"
            verbose_name = "学生"
            verbose_name_plural = verbose_name
    
    3.为上面这个模型类提供一个序列化器,可以定义如下:
    from rest_framework import serializers
    
    # 声明序列化器,所有的序列化器都要直接或者间接继承于 Serializer
    # 其中,ModelSerializer是Serializer的子类,ModelSerializer在Serializer的基础上进行了代码简化
    class StudentSerializer(serializers.Serializer):
        """学生信息序列化器"""
        # 1. 需要进行数据转换的字段
        id = serializers.IntegerField()
        name = serializers.CharField()
        age = serializers.IntegerField()
        sex = serializers.BooleanField()
        description = serializers.CharField()
    
        # 2. 如果序列化器集成的是ModelSerializer,则需要声明调用的模型信息
    
        # 3. 验证代码
    
        # 4. 编写添加和更新模型的代码
    

    注意:serializer不仅仅只能够为数据库模型类定义,也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在。
    常用字段类型

    字段 字段构造方式
    BooleanField BooleanField()
    NullBooleanField NullBooleanField()
    CharField CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)
    EmailField EmailField(max_length=None, min_length=None, allow_blank=False)
    RegexField RegexField(regex, max_length=None, min_length=None, allow_blank=False)
    SlugField SlugField(maxlength=50, min_length=None, allow_blank=False) 正则字段,验证正则模式 [a-zA-Z0-9-]+
    URLField URLField(max_length=200, min_length=None, allow_blank=False)
    UUIDField UUIDField(format='hex_verbose') format: 1) 'hex_verbose'"5ce0e9a5-5ffa-654b-cee0-1238041fb31a" 2) 'hex'"5ce0e9a55ffa654bcee01238041fb31a" 3)'int' - 如: "123456789012312313134124512351145145114" 4)'urn' 如: "urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"
    IPAddressField IPAddressField(protocol='both', unpack_ipv4=False, **options)
    IntegerField IntegerField(max_value=None, min_value=None)
    FloatField FloatField(max_value=None, min_value=None)
    DecimalField DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置
    DateTimeField DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)
    DateField DateField(format=api_settings.DATE_FORMAT, input_formats=None)
    TimeField TimeField(format=api_settings.TIME_FORMAT, input_formats=None)
    DurationField DurationField()
    ChoiceField ChoiceField(choices) choices与Django的用法相同
    MultipleChoiceField MultipleChoiceField(choices)
    FileField FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
    ImageField ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
    ListField ListField(child=, min_length=None, max_length=None)
    DictField DictField(child=)

    选项参数:

    参数名称 作用
    max_length 最大长度
    min_lenght 最小长度
    allow_blank 是否允许为空
    trim_whitespace 是否截断空白字符
    max_value 最小值
    min_value 最大值

    通用参数:

    参数名称 说明
    read_only 表明该字段仅用于序列化输出,默认False
    write_only 表明该字段仅用于反序列化输入,默认False
    required 表明该字段在反序列化时必须输入,默认True
    default 反序列化时使用的默认值
    allow_null 表明该字段是否允许传入None,默认False
    validators 该字段使用的验证器
    error_messages 包含错误编号与错误信息的字典
    label 用于HTML展示API页面时,显示的字段名称
    help_text 用于HTML展示API页面时,显示的字段帮助提示信息
    4.创建Serializer对象

    定义好Serializer类之后,就可以创建Serializer对象了。
    Serializer的构造方法:

    Serializer(instance=None, data=empty, **kwarg)
    

    说明:
    1. 用于序列化时,将模型类对象传入instance参数
    2. 用于反序列化时,将要被反序列化的数据传入data参数
    3. 除了instancedata参数外,在构造Serializer对象时,还可以通过context参数额外添加数据,如:

    serializer = AccountSerializer(account, context= {'request': request})
    

    通过context参数附加的数据,可以通过Serializer对象的context属性获取。

    使用序列化器时要注意的几个关键点:

    1. 序列化器声明以后,不会自动执行,需要我们在视图中进行调用。
    2. 序列化器无法直接接收数据,需要我们在视图中创建序列化器对象时把使用的数据传递过来。
    3. 序列化器的字段声明类似于我们前面使用过的表单系统。
    4. 开发restful api时,序列化器会帮我们把模型数据转换成字典。
    5. DRF提供的视图会帮助我们把字典转换成json,或者把客户端发送过来的数据转成字典。
    
    5.使用序列化器

    序列化器的使用分为两个阶段:
    1. 在客户端请求时,使用序列化器可以完成对数据的反序列化。
    2. 在服务器响应时,使用序列化器可以万彩城对数据的序列化。

    5.1序列化的基本使用(仍然以Student模型类为例)

    第一步:"找对象"
    查询出一个学生对象(需要序列化的任意对象)

    from students.models import Student
    student = Studnent.objects.get(id=3)
    

    第二步:"搞对象"
    把学生对象传到序列化器类里面,构造出序列化器对象

    from .serializers import StudentSerializer
    
    serializer = StudentSerializer(instance=student)
    

    第三步:"开花结果"
    通过序列化器对象的data属性可以获取序列化后的数据

    serializer.data
    # {'id': 4, 'name': 'Gavin', 'age': 18, 'sex': True, 'description': '享受知识(姿势)带来的乐趣'}
    

    完整的视图代码(单个模型数据)

    from django.views import View
    from students.models import Student
    from .serializers import StudentSerializer
    from django.http.response import JsonResponse
    class StudentView(View):
        """使用序列化器序列化转换单个模型数据"""
        def get(self,request,pk):
            # 获取模型类对象
            student = Student.objects.get(pk=pk)
            #构造序列化器对象,所有的结果都在data里面了[序列化过程]
            serializer = StudentSerializer(instance=student)
            print(serializer.data)
            # 响应数据
            return JsonResponse(serializer.data)
    

    完整的视图代码(多个模型数据)

    from django.views import View
    from students.models import Student
    from .serializers import StudentSerializer
    from django.http.response import JsonResponse
    class StudentView(View):
        """使用序列化器序列化转换多个模型数据"""
        def get(self,request):
            # 获取模型类对象
            student_list = Student.objects.all()
    
            # 构造序列化器对象,所有的结果都在data里面了[序列化过程]
            # 如果转换多个模型对象数据,则需要加上many=True
            serializer = StudentSerializer(instance=student_list,many=True)
            print( serializer.data ) # 序列化器转换后的数据
    
            # 响应数据给客户端
            # 返回的json数据,如果是列表,则需要声明safe=False
            return JsonResponse(serializer.data,safe=False)
        
        
        # 访问结果:
        # [OrderedDict([('id', 1), ('name', 'Gaivin'), ('age', 18), ('sex', True), ('description', '测试')]), OrderedDict([('id', 2), ('name', 'Carrie'), ('age', 16), ('sex', False), ('description', '后面来的测试')]), OrderedDict([('id', 4), ('name', '小张'), ('age', 18), ('sex', True), ('description', '猴赛雷')])]
    
    5.2数据验证

    使用序列化器进行反序列化时,需要对数据进行验证后,才能获取验证成功的数据或保存成模型类对象。
    在获取反序列化数据前,必须调用is_valid()方法进行验证,验证成功返回Ture,否则返回False。
    验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。如果是非字段错误,可以通过修改REST framework配置中的NON_FILED_ERRORS_KEY来控制错误自电脑中的键名。
    验证成功,可以通过序列化器对象的
    validated_data**属性获取数据。
    在定义序列化器时,指明每个字段的序列化类型和选项参数,这本身就是一种验证行为。
    举个例子:我们定义一个BookInfoSerializer

    from rest_framework import serializers
    from .serializers import StudentSerializer
    class BookInfoSerializer(serializers.Serializer):
        """图书数据序列化器"""
        id = serializers.IntegerField(label='ID', read_only=True)
        btitle = serializers.CharField(label='名称', max_length=20)
        bpub_date = serializers.DateField(label='发布日期', required=False)
        bread = serializers.IntegerField(label='阅读量', required=False)
        bcomment = serializers.IntegerField(label='评论量', required=False)
        image = serializers.ImageField(label='图片', required=False)
    

    通过构造序列化器对象,并将要反序列化的数据传递给data构造参数,进而进行验证

    from booktest.serializers import BookInfoSerializer
    data = {'bpub_date': 123}
    serializer = BookInfoSerializer(data=data)
    serializer.is_valid()  # 返回False
    serializer.errors
    # {'btitle': [ErrorDetail(string='This field is required.', code='required')], 'bpub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]}
    serializer.validated_data  # {}
    
    data = {'btitle': 'python'}
    serializer = BookInfoSerializer(data=data)
    serializer.is_valid()  # True
    serializer.errors  # {}
    serializer.validated_data  #  OrderedDict([('btitle', 'python')])
    

    is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError,可以通过传递raise_exception=True参数开启,REST framework接收此异常,会向前端返回HTTP 400 Bad Request响应。

    # Return a 400 response if the data was invalid.
    serializer.is_valid(raise_exception=True)
    

    如果觉得这些还不够,需要在补充验证行为,可以使用以下三种方法:

    1. validate_<field_name>

    对<field_name>字段进行验证:

    from rest_framework import serializers
    class BookInfoSerializer(serializers.Serializer):
        """图书数据序列化器"""
        ...
    
        def validate_btitle(self, value):
            if 'django' not in value.lower():
                raise serializers.ValidationError("图书不是关于Django的")
            return value
    

    运行,看一下结果

    from booktest.serializers import BookInfoSerializer
    data = {'btitle': 'python'}
    serializer = BookInfoSerializer(data=data)
    serializer.is_valid()  # False   
    serializer.errors
    #  {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}
    
    2.validate方法

    在序列化器中需要同时对多个字段进行比较验证时,可以定义validate方法来验证,例如:

    class BookInfoSerializer(serializers.Serializer):
        """图书数据序列化器"""
        ...
    
        def validate(self, attrs):
            bread = attrs['bread']
            bcomment = attrs['bcomment']
            if bread < bcomment:
                raise serializers.ValidationError('阅读量小于评论量')
            return attrs
    

    运行,看一下结果

    from booktest.serializers import BookInfoSerializer
    data = {'btitle': 'about django', 'bread': 10, 'bcomment': 20}
    s = BookInfoSerializer(data=data)
    s.is_valid()  # False
    s.errors
    #  {'non_field_errors': [ErrorDetail(string='阅读量小于评论量', code='invalid')]}
    
    3.validators

    在字段中添加validators选项参数,衣蛾可以补充验证行为,例如:

    def about_django(value):
        if 'django' not in value.lower():
            raise serializers.ValidationError("图书不是关于Django的")
    
    class BookInfoSerializer(serializers.Serializer):
        """图书数据序列化器"""
        id = serializers.IntegerField(label='ID', read_only=True)
        btitle = serializers.CharField(label='名称', max_length=20, validators=[about_django])
        bpub_date = serializers.DateField(label='发布日期', required=False)
        bread = serializers.IntegerField(label='阅读量', required=False)
        bcomment = serializers.IntegerField(label='评论量', required=False)
        image = serializers.ImageField(label='图片', required=False)
    

    运行,看一下结果

    from booktest.serializers import BookInfoSerializer
    data = {'btitle': 'python'}
    serializer = BookInfoSerializer(data=data)
    serializer.is_valid()  # False   
    serializer.errors
    #  {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}
    
    5.3反序列化的使用

    前面的验证数据成功后,我们可以使用序列化器来完成数据反序列化的过程。这个过程可以把数据转换成模型类对象。
    可以通过实现create()和update()两个方法来实现。

    class BookInfoSerializer(serializers.Serializer):
        """图书数据序列化器"""
        ...
    
        def create(self, validated_data):
            """新建"""
            return BookInfo(**validated_data)
    
        def update(self, instance, validated_data):
            """更新,instance为要更新的对象实例"""
            instance.btitle = validated_data.get('btitle', instance.btitle)
            instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date)
            instance.bread = validated_data.get('bread', instance.bread)
            instance.bcomment = validated_data.get('bcomment', instance.bcomment)
            return instance
    

    如果需要在返回数据对象的时候,也将数据保存到数据库中,则可以进行如下修改:

    class BookInfoSerializer(serializers.Serializer):
        """图书数据序列化器"""
        ...
    
        def create(self, validated_data):
            """新建"""
            return BookInfo.objects.create(**validated_data)
    
        def update(self, instance, validated_data):
            """更新,instance为要更新的对象实例"""
            instance.btitle = validated_data.get('btitle', instance.btitle)
            instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date)
            instance.bread = validated_data.get('bread', instance.bread)
            instance.bcomment = validated_data.get('bcomment', instance.bcomment)
            instance.save()
            return instance
    

    实现了上述两个方法后,在反序列化的时候,就可以通过save()方法返回一个数据对象实例了

    book = serializer.save()
    

    如果创建序列化器对象的时候,没有传递instance实例,则调用save()方法的时候,create()被调用,相反,如果传递了instance实例,则调用save()方法的时候,update()被调用。

    from db.serializers import BookInfoSerializer
    data = {'btitle': '封神演义'}
    serializer = BookInfoSerializer(data=data)
    serializer.is_valid()  # True
    serializer.save()  # <BookInfo: 封神演义>
    
    from db.models import BookInfo
    book = BookInfo.objects.get(id=2)
    data = {'btitle': '倚天剑'}
    serializer = BookInfoSerializer(book, data=data)
    serializer.is_valid()  # True
    serializer.save()  # <BookInfo: 倚天剑>
    book.btitle  # '倚天剑'
    

    知识点补充:
    1. 在对序列化器进行save()保存时,可以额外传递数据,这些数据可以再create()和update()中的validated_data参数获取到

    # request.user 是django中记录当前登录用户的模型对象
    serializer.save(owner=request.user)
    
    1. 默认序列化器必须传递所有的required字段,否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新
    # Update `comment` with partial data
    serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)
    

    相关文章

      网友评论

          本文标题:# Django Rest_Framework(二)序列化器Se

          本文链接:https://www.haomeiwen.com/subject/lkitzqtx.html