DRF序列化器Meta类中批量设置可选字段的方法

你可以通过重写序列化器的get_fields方法或者__init__方法，配合集中定义的可选字段列表来批量设置required=False，无需逐个字段配置。

方法一：在序列化器中定义可选字段列表，重写get_fields处理 #

这种方式把可选字段集中管理，逻辑清晰：

from rest_framework import serializers
from .models import Company

class CompanySerializer(serializers.ModelSerializer):
    # 集中定义所有非必填字段
    optional_fields = [
        'contact_email', 'website', 'fax', 
        # 补充剩余的17个字段
    ]

    class Meta:
        model = Company
        fields = '__all__'  # 或明确列出所有45个字段

    def get_fields(self):
        fields = super().get_fields()
        # 批量修改字段的required属性
        for field_name in self.optional_fields:
            if field_name in fields:
                fields[field_name].required = False
        return fields

方法二：在Meta类中定义可选字段列表，重写__init__处理 #

如果你更倾向于把可选字段配置放在Meta类中，和其他序列化器配置放在一起，可以用这种方式：

from rest_framework import serializers
from .models import Company

class CompanySerializer(serializers.ModelSerializer):
    class Meta:
        model = Company
        fields = '__all__'
        # 在Meta中直接定义非必填字段列表
        optional_fields = [
            'contact_email', 'website', 'fax', 
            # 补充剩余的17个字段
        ]

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # 读取Meta中的可选字段配置并批量修改
        optional_fields = getattr(self.Meta, 'optional_fields', [])
        for field_name in optional_fields:
            if field_name in self.fields:
                self.fields[field_name].required = False

补充说明 #

如果你的Company模型中，这些非必填字段本身已经设置了blank=True和null=True，DRF的ModelSerializer会自动将这些字段的required设为False，此时无需额外编写上述代码。只有当模型字段为必填（blank=False）但你需要在序列化器中设为可选时，才需要用上面的方法。

内容的提问来源于stack exchange，提问作者se7en