重写is_valid动态校验参数

  • 有了动态返回字段怎么能没有动态的校验字段!
  • 看了半天Serializer的实现代码，终于捣鼓出来了动态校验字段的方式，该方法还是自己测试阶段，没有开始实际应用，有什么问题请大家及时反馈，我这里实际使用过以后也会更新本篇的内容。
  • 更新：已经实际应用了，暂时没有发现问题。

使用方法

  • 调用serializers：传入的context可以在is_valid中获得
1
2
3
4
5
6
7
8
context = {
        "data": {
            "name": "rename", 
            "valid": "CharField(required=True)"
        }
    }
# 调用校验，传入的context可以在is_valid中获得
DataSerializer(data=validated_data, context=context).is_valid(True)
  • 数据校验serializers：重写is_valid修改_declared_fields，然后继续使用原有的方法校验
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
from rest_framework.serializers import Serializer
from rest_framework.fields import CharField


class DataSerializer(Serializer):
    name = CharField(required=False, allow_null=True, allow_blank=True)
    
    # 重写is_valid
    def is_valid(self, raise_exception=False):
        data = self.context.get("data")
        if data:
            # 把存储的字符串转为可以使用的对象，注意：字符串必须是可以引用的对象，谨慎操作
            valid = eval(data['valid'])
            self._declared_fields[data['name']] = valid
        # 继续使用原有的方法
        return super().is_valid(raise_exception)
  • **self._declared_fields**，需要的校验规则。
  • **self.initial_data**，需要校验的数据，也就是调用时传入的validated_data。
  • 使用self._declared_fields[data['name']] = valid把值加入self._declared_fields后，Serializers在解析的时候使用fields()方法，把declared_fields中的字段进行处理，具体方法不好一一说明，有兴趣的可以看一下Serializers的实现代码，经过以上的重写is_valid()后，等价于：
1
2
3
class DataSerializer(Serializer):
    name = CharField(required=False, allow_null=True, allow_blank=True)
    rename = CharField(required=True)

几种允许数据为空的验证

1
2
3
4
5
from rest_framework.serializers import Serializer
from rest_framework.fields import CharField

class DataSerializer(Serializer):
    name = CharField(required=False, allow_null=True, allow_blank=True)
命令 说明 示例
required=False 允许不传该字段 无
allow_null=True 允许字段填null name=null
allow_blank=True 允许字段填空字符串 name=””