Django Rest Framework-如何在ModelSerializer中添加自定义字段

我创建了一个，ModelSerializer并希望添加一个不属于我的模型的自定义字段。

我在此处找到了添加其他字段的说明，并尝试了以下操作：

customField = CharField(source='my_field')

当我添加此字段并调用我的validate()函数时，则此字段不是attr字典的一部分。attr包含所有指定的模型字段，除了额外的字段。因此，我无法在覆盖的验证中访问此字段，可以吗？

当我将此字段添加到字段列表中时，如下所示：

class Meta:
    model = Account
    fields = ('myfield1', 'myfield2', 'customField')

然后我得到一个错误，因为customField它不是我的模型的一部分-正确的是因为我只想为此序列化器添加它。

有什么方法可以添加自定义字段？

您在做正确的事情，除了CharField（和其他类型的字段）用于可写字段。

在这种情况下，您只需要一个简单的只读字段，因此只需使用：

customField = Field(source='get_absolute_url')

实际上，有一个解决方案完全不涉及模型。您可以使用SerializerMethodField它允许您将任何方法插入序列化程序。

class FooSerializer(ModelSerializer):
    foo = serializers.SerializerMethodField()

    def get_foo(self, obj):
        return "Foo id: %i" % obj.pk

...为清楚起见，如果您以以下方式定义了模型方法：

class MyModel(models.Model):
    ...

    def model_method(self):
        return "some_calculated_result"

您可以像这样将调用所述方法的结果添加到序列化程序中：

class MyModelSerializer(serializers.ModelSerializer):
    model_method_field = serializers.CharField(source='model_method')

ps由于自定义字段实际上不是模型中的字段，因此通常需要将其设置为只读，如下所示：

class Meta:
    model = MyModel
    read_only_fields = (
        'model_method_field',
        )

在这里回答您的问题。您应将其添加到模型帐户中：

@property
def my_field(self):
    return None

现在您可以使用：

customField = CharField(source='my_field')

来源：https : //stackoverflow.com/a/18396622/3220916

为了显示self.author.full_name，我遇到了一个错误Field。它与ReadOnlyField：

class CommentSerializer(serializers.HyperlinkedModelSerializer):
    author_name = ReadOnlyField(source="author.full_name")
    class Meta:
        model = Comment
        fields = ('url', 'content', 'author_name', 'author')

在最新版本的Django Rest Framework中，您需要使用要添加的字段名称在模型中创建一个方法。

class Foo(models.Model):
    . . .
    def foo(self):
        return 'stuff'
    . . .

class FooSerializer(ModelSerializer):
    foo = serializers.ReadOnlyField()

    class Meta:
        model = Foo
        fields = ('foo',)

我一直在寻找将可写的自定义字段添加到模型序列化器的解决方案。我找到了这个，但这个问题的答案中并未涉及。

看来您确实确实需要编写自己的简单Serializer。

class PassThroughSerializer(serializers.Field):
    def to_representation(self, instance):
        # This function is for the direction: Instance -> Dict
        # If you only need this, use a ReadOnlyField, or SerializerField
        return None

    def to_internal_value(self, data):
        # This function is for the direction: Dict -> Instance
        # Here you can manipulate the data if you need to.
        return data

现在您可以使用此序列化器将自定义字段添加到ModelSerializer

class MyModelSerializer(serializers.ModelSerializer)
    my_custom_field = PassThroughSerializer()

    def create(self, validated_data):
        # now the key 'my_custom_field' is available in validated_data
        ...
        return instance

如果ModelMyModel实际上有一个名为的属性，my_custom_field但您想忽略其验证器，则这也可以工作。

在阅读完所有答案后，我的结论是不可能做到这一点。您必须精打细算，做些仓促的事情，例如创建一个write_only字段，然后覆盖validateandto_representation方法。这对我有用：

class FooSerializer(ModelSerializer):

    foo = CharField(write_only=True)

    class Meta:
        model = Foo
        fields = ["foo", ...]

    def validate(self, data):
        foo = data.pop("foo", None)
        # Do what you want with your value
        return super().validate(data)

    def to_representation(self, instance):
        data = super().to_representation(instance)
        data["foo"] = whatever_you_want
        return data