serializer验证数据

前言

这几天在做公司的项目，记录下感想，与大家一起分享交流
主要从要实现的业务需求着手，然后慢慢扩展

动力：

记录一下验证数据这一问题踩到的一些坑，仅供思考，不是教程

场景分析：

• 前端将房间物业费信息以及车位费信息传递过来，我需要将验证数据的合理性然后进一步做相关的处理
  先大致看一下数据格式（很多代码的编写需要从需求，数据格式等地方思考 需要清楚自己做什么）

{
    "uuid": "9",
    "start_time": "2017-08-28",
    "end_time": "2017-09-27",
    "price": "0.03"
    ...
    "parkings": [
        {
            "price": "1
            "parking_type": "O",
            "start_time": "2017-08-20",
            "end_time": "2017-09-20",
            "uuid": "ca21f6b2-705c-11e7-8985-e4f89c5701e8",
            ...
        },
        {
            "price": "2",
            "start_time": "2017-08-28",
            "end_time": "2017-09-28",
            "uuid": "d8808ce6-705c-11e7-8985-e4f89c5701e8",
            ...
        }
    ]
}
    ]
}

要干嘛：

通过上面的数据结构生成一样房间订单，两张车位订单，生成之前需要验证数据是否正确，比如验证开始日期必须在xxx之前，费用计算是否正确等。
当然传过来的字段是不完整的，还需要一些字段需要自己处理，比如订单编号

主要思路：

• 基础知识点：
  • validate（）
    restframework提供的验证数据的方法

流程：

• 验证房间订单信息
  • 将房间订单相关的信息传递进定制的序列化中
  • data可以看成是刚刚的json的数据，ProperyOrderValidateTempSer就是自己编写的serializer类
  • 调用is_valid的时候就会调用validate方法

            property_temp_ser = PropertyOrderValidateTempSer(data=data)

if property_temp_ser.is_valid():
    pass
else:
    return http_400_response(property_temp_ser.errors)

• 验证车位订单信息
  • 入口类似上面，将相关数据倒进定义好的序列化中，不过这里是将data['parkings'] 这个list倒进去

开始分析:

上篇博客埋下了一个小伏笔，传进去的不是对象，而是纯的字典类型数据会怎样？

class PropertyOrderValidateTempSer(serializers.ModelSerializer):
    # start_time = serializers.SerializerMethodField()
    # end_time = serializers.SerializerMethodField()
    order_number = serializers.SerializerMethodField()

    class Meta:
        model = PropertyOrder
        fields = '__all__'

    def get_order_number(self, obj):
        return now() + random.randint(100, 999)

    def validate(self, data):

        room = Room.objects.get(id=data['room'].id)

        # TODO 开始缴费日期为上次的截止有效期 目前是精度是有效期当天及后一天
        if (data['start_time'] + datetime.timedelta(days=1) < room.effective_time or
                    data['start_time'] > room.effective_time):
            raise serializers.ValidationError("物业费开始缴费日期错误")

这里选用的依然是ModelSerializer

• fields = '__ all __'是干啥的

先打印当前validate里面的data看看：

OrderedDict([(u'order_type', 'W'), (u'price', Decimal('0.03')), (u'start_time', datetime.datetime(2017, 8, 28, 0, 0, tzinfo=<django.utils.timezone.LocalTimezone object at 0x7f5088604710>)), ..., (u'room', <Room: 青岛颐中物业管理有限公司>), (u'creater', 3>)])

上面数据是省略的数据，说明的点是，把传进来的data，字段出现在PropertyOrder里的都加载进来了。

假象一个业务逻辑：首先需要检验下价格是否正确，然后将人民币转换成美元存储...

现在我们将代码改一改：

class PropertyOrderValidateTempSer(serializers.ModelSerializer):
    # start_time = serializers.SerializerMethodField()
    # end_time = serializers.SerializerMethodField()
    order_number = serializers.SerializerMethodField()
    price = serializers.SerializerMethodField()

    class Meta:
        model = PropertyOrder
        # fields = '__all__'
        fields = ('room', 'end_time', 'start_time', 'price', 'order_number', 'order_type')

    def get_order_number(self, obj):
        return now() + random.randint(100, 999)

    def get_price(self, obj):
        print obj
        # 转换相关逻辑不重要，主要是这个场景
        ...
        return "1"
    ...

这时候打印 validate() 里面的data和 get_price()里面的obj看看

validate:
OrderedDict([(u'room', <Room: 青岛颐中物业管理有限公司>), ..., (u'order_type', 'W')])

get_price:
OrderedDict([(u'room', <Room: 青岛颐中物业管理有限公司>), ..., (u'order_type', 'W')])

结论就是price被吃掉了,不能即实现验证又转换汇率了
原理是啥我目前也说不清楚，当时发现这个的时候还郁闷很久，
price被吃掉的原因估计是：

price = serializers.SerializerMethodField()

因为当前传过来的是dict类型的数据，重写price的时候，validate()的data就没有它了（get_price()的obj也一样）
回想第一节，传进序列化的是一个数据库查询对象的时候，无论重不重写里面已有的字段，比如重写price，validate()里面的data绝对还是有price字段的... （这段不明白的可以回顾下上篇博客，留意下effective_time字段）

总结：

• fields 定义的字段不仅仅影响到传出去的字段，也影响到进行验证处理的字段

  • 传出去的字段，一定都在fields里

  • validate验证能取到的字段一定都在fields里，不过可能由于其他原因导致fields有的字段，validate里面没有，比如这里的price

• SeriazlierMethod定义的是传出去的字段，如果传进来的数据是dict类型的，当字段名称相互重复的时候，validate里面的字段就会被吃掉()

  • 由于这个特性，根据业务需求编写代码的时候就要考虑到这一点，可能有同学要说，解决重名还不容易？SerialzierMethod这里改个名嘛。这里就要说，方法可行，看实现整一个功能的代码是怎么设计了，（解决问题的方法往往有很多种嘛）
    我这里不改是因为我要保持这些字段名称和数据库的字段名称一致，方便以后重新使用
  • 我的两个解决思路
    • 两个序列化，一个验证数据，添加数据，一个序列化用来存储数据
    • 先用这个序列化创建出一个obj对象，通过对obj重新赋值进行更改
    • 以上只是具体思路，实际操作的时候还得考虑很多因素，比如数据安全等...

扩展：

• 数据验证还有什么其他什么方式
• validate()验证的时候，除了验证里面自己编写的逻辑，还验证了什么