Question

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

我找到了添加额外字段here的说明，我尝试了以下内容：

customField = CharField(source='my_field')

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

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

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

然后我收到一个错误，因为customField不属于我的模型 - 什么是正确的，因为我只想为这个序列化程序添加它。

有没有办法添加自定义字段？

Answer 1

除了CharField（和其他类型的字段）是可写字段外，你做的是正确的。

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

customField = Field(source='get_absolute_url')

Answer 2

事实上，有一个解决方案没有触及任何模型。您可以使用SerializerMethodField允许您将任何方法插入序列化程序。

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

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

Answer 3

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

class MyModel(models.Model):
    ...

    def model_method(self):
        return "some_calculated_result"

您可以将调用所述方法的结果添加到序列化程序中，如下所示：

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

P.S。由于自定义字段实际上不是模型中的字段，因此您通常希望将其设置为只读，如下所示：

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

Answer 4

这里回答你的问题。您应该添加到您的模型帐户：

@property
def my_field(self):
    return None

现在您可以使用：

customField = CharField(source='my_field')

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

Answer 5

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

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

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

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

Answer 6

要显示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')

Answer 7

在阅读完所有答案后，我的结论是不可能干净地做到这一点。您必须精打细算，做些仓促的事情，例如创建一个write_only字段，然后覆盖validate和to_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

Answer 8

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

似乎您确实确实需要编写自己的简单序列化器。

class PassThroughSerializer(serializers.Serializer):
    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

如果模型MyModel实际上具有一个名为my_custom_field的属性，但您想忽略其验证器，那么这也可以。

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

8 个答案: