django rest framework serializers小结

引言

serializers是什么？官网是这样的"Serializers allow complex data such as querysets and model instances to be converted to native Python datatypes that can then be easily rendered into JSON, XML or other content types. "翻译出来就是，将复杂的数据结构变成json或者xml这个格式的。
在最近的学习中，我的见解，serializers有如下几个做用：
- 将queryset与model实例等进行序列化，转化成json格式，返回给用户(api接口)。
- 将post与patch/put的上来的数据进行验证。
- 对post与patch/put数据进行处理。html

（后面的内容，将用patch表示put/patch更新，博主认为patch更贴近更新的说法）
简单来讲，针对get来讲，serializers的做用体如今第一条，但若是是其余请求，serializers可以发挥2,3条的做用！python

本文比较长，用张图简单介绍一下主要内容正则表达式

serializers.fieild

咱们知道在django中，form也有许多field，那serializers其实也是drf中发挥着这样的功能。咱们先简单了解经常使用的几个field。数据库

1. 经常使用的field

CharField、BooleanField、IntegerField、DateTimeField这几个用得比较多，咱们把外键的field放到后面去说！django

# 举例子
mobile = serializers.CharField(max_length=11, min_length=11)
age = serializers.IntegerField(min_value=1, max_value=100)
# format能够设置时间的格式，下面例子会输出如:2018-1-24 12:10
pay_time = serializers.DateTimeField(read_only=True,format='%Y-%m-%d %H:%M')
is_hot = serializers.BooleanField()
复制代码

不一样的是，咱们在django中，form更强调对提交的表单进行一种验证，而serializer的field不只在进行数据验证时起着相当重要的做用，在将数据进行序列化后返回也发挥着重要做用！！
咱们能够看出，不一样的field能够用不一样的关键参数，除此以外，还有一些十分重要有用的参数。编程

2. Core arguments参数

read_only：True表示不容许用户本身上传，只能用于api的输出。若是某个字段设置了read_only=True，那么就不须要进行数据验证，只会在返回时，将这个字段序列化后返回 举个简单的例子：在用户进行购物的时候，用户post订单时，确定会产生一个订单号，而这个订单号应该由后台逻辑完成，而不该该由用户post过来，若是不设置read_only=True，那么验证的时候就会报错。json

order_sn = serializers.CharField(readonly=True)
复制代码

write_only: 与read_only对应 required: 顾名思义，就是这个字段是否必填。
allow_null/allow_blank：是否容许为NULL/空。 error_messages：出错时，信息提示。api

name = serializers.CharField(required=True, min_length=6,
                error_messages={
                    'min_length': '名字不能小于6个字符',
                    'required': '请填写名字'})
                                    
复制代码

label: 字段显示设置，如 label='验证码' help_text: 在指定字段增长一些提示文字，这两个字段做用于api页面比较有用 style: 说明字段的类型，这样看可能比较抽象，看下面例子：bash

# 在api页面，输入密码就会以*显示
password = serializers.CharField(
    style={'input_type': 'password'})
# 会显示选项框
color_channel = serializers.ChoiceField(
    choices=['red', 'green', 'blue'],
    style={'base_template': 'radio.html'})
复制代码

这里面，还有一个十分有用的validators参数，这个咱们会在后面说起！markdown

3. HiddenField

HiddenField的值不依靠输入，而须要设置默认的值，不须要用户本身post数据过来，也不会显式返回给用户，最经常使用的就是user!!
咱们在登陆状况下，进行一些操做，假设一个用户去收藏了某一门课，那么后台应该自动识别这个用户，而后用户只须要将课程的id post过来，那么这样的功能，咱们配合CurrentUserDefault()实现。

# 这样就能够直接获取到当前用户
user = serializers.HiddenField(
	default=serializers.CurrentUserDefault())
复制代码

save instance

这个标题是官方文档的一个小标题，我以为用的很好，一眼看出，这是为post和patch所设置的，没错，这一部分功能是专门为这两种请求所设计的，若是只是简单的get请求，那么在设置了前面的field可能就可以知足这个需求。
咱们在view以及mixins的博客中说起到，post请求对应create方法，而patch请求对应update方法，这里提到的create方法与update方法，是指mixins中特定类中的方法。咱们看一下源代码，源代码具体分析能够看到另一篇博客mixins：

# 只截取一部分
class CreateModelMixin(object):
    def create(self, request, *args, **kwargs):
        serializer = self.get_serializer(data=request.data)
        serializer.is_valid(raise_exception=True)
        self.perform_create(serializer)
        headers = self.get_success_headers(serializer.data)
        return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)

    def perform_create(self, serializer):
        serializer.save()

class UpdateModelMixin(object):
    def update(self, request, *args, **kwargs):
        partial = kwargs.pop('partial', False)
        instance = self.get_object()
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        serializer.is_valid(raise_exception=True)
        self.perform_update(serializer)

        if getattr(instance, '_prefetched_objects_cache', None):
            # If 'prefetch_related' has been applied to a queryset, we need to
            # forcibly invalidate the prefetch cache on the instance.
            instance._prefetched_objects_cache = {}

        return Response(serializer.data)

    def perform_update(self, serializer):
        serializer.save()
复制代码

能够看出，不管是create与update都写了一行：serializer.save( )，那么，这一行，到底作了什么事情，分析一下源码。

# serializer.py
def save(self, **kwargs):
# 略去一些稍微无关的内容
	···
	if self.instance is not None:
		self.instance = self.update(self.instance, validated_data)
            ···
	else:
		self.instance = self.create(validated_data)
            ···
	return self.instance
复制代码

显然，serializer.save的操做，它去调用了serializer的create或update方法，不是mixins中的！！！咱们看一下流程图（以post为例）

讲了那么多，咱们到底须要干什么！重载这两个方法！！
若是你的viewset含有post，那么你须要重载create方法，若是含有patch，那么就须要重载update方法。

# 假设如今是个博客，有一个建立文章，与修改文章的功能, model为Article。
class ArticleSerializer(serializers.Serializer):
	user = serializers.HiddenField(
		default=serializers.CurrentUserDefault())
    name = serializers.CharField(max_length=20)
    content = serializers.CharField()

    def create(self, validated_data):
    # 除了用户，其余数据能够从validated_data这个字典中获取
    # 注意，users在这里是放在上下文中的request，而不是直接的request
        user = self.context['request'].user
        name = validated_data['name ']
        content = validated_data['content ']
        return Article.objects.create(**validated_data)

    def update(self, instance, validated_data):
    # 更新的特别之处在于你已经获取到了这个对象instance
        instance.name = validated_data.get('name')
        instance.content = validated_data.get('content')
        instance.save()
        return instance
复制代码

可能会有人好奇，系统是怎么知道，咱们须要调用serializer的create方法，仍是update方法，咱们从save( )方法能够看出，判断的依据是：

if self.instance is not None:pass
复制代码

那么咱们的mixins的create与update也已经在为开发者设置好了，

# CreateModelMixin
serializer = self.get_serializer(data=request.data)
# UpdateModelMixin
serializer = self.get_serializer(instance, data=request.data, partial=partial)
复制代码

也就是说，在update经过get_object( )的方法获取到了instance，而后传递给serializer，serializer再根据是否有传递instance来判断来调用哪一个方法！

Validation自定义验证逻辑

单独的validate

咱们在上面提到field，它能起到必定的验证做用，但很明显，它存在很大的局限性，举个简单的例子，咱们要判断咱们手机号码，若是使用CharField(max_length=11, min_length=11），它只能确保咱们输入的是11个字符，那么咱们须要自定义！

mobile_phone = serializers.CharField(max_length=11, min_length=11）

def validate_mobile_phone(self, mobile_phone):
	# 注意参数，self以及字段名
	# 注意函数名写法，validate_ + 字段名字
	if not re.match(REGEX_MOBILE, mobile):
	# REGEX_MOBILE表示手机的正则表达式
		raise serializers.ValidationError("手机号码非法")
	return mobile_phone
复制代码

固然，这里面还能够加入不少逻辑，例如，还能够判断手机是否本来就存在数据库等等。

联合validate

上面验证方式，只能验证一个字段，若是是两个字段联合在一块儿进行验证，那么咱们就能够重载validate( )方法。

start = serializers.DateTimeField()
    finish = serializers.DateTimeField()
    
    def validate(self, attrs):
    # 传进来什么参数，就返回什么参数，通常状况下用attrs
        if data['start'] > data['finish']:
            raise serializers.ValidationError("finish must occur after start")
        return attrs
复制代码

这个方法很是的有用，咱们还能够再这里对一些read_only的字段进行操做，咱们在read_only说起到一个例子，订单号的生成，咱们能够在这步生成一个订单号，而后添加到attrs这个字典中。

order_sn = serializers.CharField(readonly=True)
def validate(self, attrs):
	# 调用一个方法生成order_sn
	attrs['order_sn'] = generate_order_sn()
	return attrs
复制代码

这个方法运用在modelserializer中，能够剔除掉write_only的字段，这个字段只验证，但不存在与指定的model当中，即不能save( )，能够在这delete掉！

Validators

validators能够直接做用于某个字段，这个时候，它与单独的validate做用差很少

def multiple_of_ten(value):
    if value % 10 != 0:
        raise serializers.ValidationError('Not a multiple of ten')

class GameRecord(serializers.Serializer):
    score = IntegerField(validators=[multiple_of_ten])
复制代码

固然，drf提供的validators还有很好的功能：UniqueValidator，UniqueTogetherValidator等 UniqueValidator: 指定某一个对象是惟一的，如，用户名只能存在惟一：

username = serializers.CharField(
		max_length=11, 
		min_length=11,
		validators=[UniqueValidator(queryset=UserProfile.objects.all())
	）
复制代码

UniqueTogetherValidator: 联合惟一，如用户收藏某个课程，这个时候就不能单独做用于某个字段，咱们在Meta中设置。

class Meta:
        validators = [
            UniqueTogetherValidator(
                queryset=UserFav.objects.all(),
                fields=('user', 'course'),
                message='已经收藏'
            )]
复制代码

ModelSerializer

讲了不少Serializer的，在这个时候，我仍是强烈建议使用ModelSerializer，由于在大多数状况下，咱们都是基于model字段去开发。

好处：

ModelSerializer已经重载了create与update方法，它可以知足将post或patch上来的数据进行进行直接地建立与更新，除非有额外需求，那么就能够重载create与update方法。 ModelSerializer在Meta中设置fields字段，系统会自动进行映射，省去每一个字段再写一个field。

class UserDetailSerializer(serializers.ModelSerializer):
    """ 用户详情序列化 """

    class Meta:
        model = User
        fields = ("name", "gender", "birthday", "email", "mobile")
        # fields = '__all__': 表示全部字段
        # exclude = ('add_time',): 除去指定的某些字段
        # 这三种方式，存在一个便可
复制代码

ModelSerializer须要解决的2个问题：

1，某个字段不属于指定model，它是write_only，须要用户传进来，但咱们不能对它进行save( )，由于ModelSerializer是基于Model，这个字段在Model中没有对应，这个时候，咱们须要重载validate！
如在用户注册时，咱们须要填写验证码，这个验证码只须要验证，不须要保存到用户这个Model中：

def validate(self, attrs):
        del attrs["code"]
        return attrs
复制代码

2，某个字段不属于指定model，它是read_only，只须要将它序列化传递给用户，可是在这个model中，没有这个字段！咱们须要用到SerializerMethodField。
假设须要返回用户加入这个网站多久了，不可能维持这样加入的天数这样一个数据，通常会记录用户加入的时间点，而后当用户获取这个数据，咱们再计算返回给它。

class UserSerializer(serializers.ModelSerializer):	
	days_since_joined = serializers.SerializerMethodField()
	# 方法写法：get_ + 字段
	def get_days_since_joined(self, obj):
	# obj指这个model的对象
		return (now() - obj.date_joined).days
		
	class Meta:
		model = User
复制代码

固然，这个的SerializerMethodField用法还相对简单一点，后面还会有比较复杂的状况。

关于外键的serializers

讲了那么多，终于要研究一下外键啦~
其实，外键的field也比较简单，若是咱们直接使用serializers.Serializer，那么直接用PrimaryKeyRelatedField就解决了。假设如今有一门课python入门教学(course)，它的类别是python(catogory)。

# 指定queryset
category = serializers.PrimaryKeyRelatedField(queryset=CourseCategory.objects.all(), required=True)
复制代码

ModelSerializer就更简单了，直接经过映射就行了
不过这样只是用户得到的只是一个外键类别的id，并不能获取到详细的信息，若是想要获取到具体信息，那须要嵌套serializer

category = CourseCategorySerializer()
复制代码

注意：上面两种方式，外键都是正向取得，下面介绍怎么反向去取，如，咱们须要获取python这个类别下，有什么课程。首先，在课程course的model中，须要在外键中设置related_name

class Course(model.Model):
	category = models.ForeignKey(CourseCategory, related_name='courses')
复制代码

# 反向取课程，经过related_name
# 一对多，一个类别下有多个课程，必定要设定many=True
courses = CourseSerializer(many=True)
复制代码

写到这里，咱们的外键就基本讲完了！还有一个小问题：咱们在上面提到ModelSerializer须要解决的第二个问题中，其实还有一种状况，就是某个字段属于指定model，但不能获取到相关数据。
假设如今是一个多级分类的课程，例如，编程语言-->python-->python入门学习课程，编程语言与python属于类别，另一个属于课程，编程语言类别是python类别的一个外键，并且属于同一个model，实现方法：

parent_category = models.ForeignKey('self', null=True, blank=True, 
					verbose_name='父类目别',
					related_name='sub_cat')
复制代码

如今获取编程语言下的课程，显然没法直接获取到python入门学习这个课程，由于它们两没有外键关系。SerializerMethodField( )也能够解决这个问题，只要在自定义的方法中实现相关的逻辑便可！

courses = SerializerMethodField()
def get_courses(self, obj):
	all_courses = Course.objects.filter(category__parent_category_id=obj.id)
	courses_serializer = CourseSerializer(all_course, many=True, 
					context={'request': self.context['request']})
	return courses_serializer.data
复制代码

上面的例子看起来有点奇怪，由于咱们在SerializerMethodField()嵌套了serializer，就须要本身进行序列化，而后再从data就能够取出json数据。
能够看到传递的参数是分别是：queryset，many=True多个对象，context上下文。这个context十分关键，若是不将request传递给它，在序列化的时候，图片与文件这些Field不会再前面加上域名，也就是说，只会有/media/img...这样的路径！

后言

写到这，serializers的小结就写完啦，若是错误的地方，欢迎各位的指出！接下来会继续写drf的相关文章~~

CSDN: http://blog.csdn.net/l_vip/article/details/79156113