Django REST Framework:向ModelSerializer添加其他字段

Question

我想序列化一个模型,但是想要包含一个额外的字段,该字段需要对要序列化的模型实例进行一些数据库查找:

class FooSerializer(serializers.ModelSerializer):
  my_field = ... # result of some database queries on the input Foo object
  class Meta:
        model = Foo
        fields = ('id', 'name', 'myfield')

这样做的正确方法是什么？我看到你可以将额外的"上下文"传递给序列化器,是在上下文字典中传入附加字段的正确答案吗？使用这种方法,获得我需要的字段的逻辑不会与串行器定义一起自包含,这是理想的,因为每个序列化实例都需要my_field.在DRF序列化器文档的其他地方,它说 "额外的字段可以对应于模型上的任何属性或可调用".我正在谈论的是额外的领域吗？我应该在Foo模型定义中定义一个返回my_field值的函数吗？在序列化器中我将my_field挂钩到那个可调用的函数？那是什么样的？

在此先感谢,如有必要,请尽快澄清问题.

Answer 1

我认为SerializerMethodField正是您所需要的:

class FooSerializer(serializers.ModelSerializer):
  my_field = serializers.SerializerMethodField('is_named_bar')

  def is_named_bar(self, foo):
      return foo.name == "bar" 

  class Meta:
    model = Foo
    fields = ('id', 'name', 'my_field')

http://www.django-rest-framework.org/api-guide/fields/#serializermethodfield

Answer 2

您可以将模型方法更改为属性,并使用此方法在序列化程序中使用它.

class Foo(models.Model):
    . . .
    @property
    def my_field(self):
        return stuff
    . . .

class FooSerializer(ModelSerializer):
    my_field = serializers.ReadOnlyField(source='my_field')

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

编辑:使用最新版本的rest框架(我尝试过3.3.3),您不需要更改为属性.模型方法将正常工作.

Answer 3

使用最新版本的Django Rest Framework,您需要在模型中创建一个方法,其中包含您要添加的字段的名称.不需要@property并source='field'引发错误.

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

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

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

Answer 4

如果你想为每个对象动态添加字段，你可以使用 to_represention。

class FooSerializer(serializers.ModelSerializer):
  class Meta:
        model = Foo
        fields = ('id', 'name',)
  
  def to_representation(self, instance):
      representation = super().to_representation(instance)
      if instance.name!='': #condition
         representation['email']=instance.name+"@xyz.com"#adding key and value
         representation['currency']=instance.task.profile.currency #adding key and value some other relation field
         return representation
      return representation

通过这种方式，您可以动态地为每个对象添加键和值希望您喜欢它

Answer 5

我对类似问题(这里)的回答可能有用.

如果您有以下列方式定义的模型方法:

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',
        )

Answer 6

如果您想在多余的字段上进行读写，则可以使用新的自定义序列化程序，该序列化程序扩展了serializers.Serializer，并按如下方式使用

class ExtraFieldSerializer(serializers.Serializer):
    def to_representation(self, instance): 
        # this would have the same as body as in a SerializerMethodField
        return 'my logic here'

    def to_internal_value(self, data):
        # This must return a dictionary that will be used to
        # update the caller's validation data, i.e. if the result
        # produced should just be set back into the field that this
        # serializer is set to, return the following:
        return {
          self.field_name: 'Any python object made with data: %s' % data
        }

class MyModelSerializer(serializers.ModelSerializer):
    my_extra_field = ExtraFieldSerializer(source='*')

    class Meta:
        model = MyModel
        fields = ['id', 'my_extra_field']

我用一些自定义逻辑在相关的嵌套字段中使用此

Answer 7

这对我有用。如果我们只想在 中添加一个附加字段ModelSerializer，我们可以像下面这样做，并且在一些查找计算后也可以为该字段分配一些 val。或者在某些情况下，如果我们想在 API 响应中发送参数。

在模型.py中

class Foo(models.Model):
    """Model Foo"""
    name = models.CharField(max_length=30, help_text="Customer Name")

在序列化器.py中

class FooSerializer(serializers.ModelSerializer):
    retrieved_time = serializers.SerializerMethodField()
    
    @classmethod
    def get_retrieved_time(self, object):
        """getter method to add field retrieved_time"""
        return None

  class Meta:
        model = Foo
        fields = ('id', 'name', 'retrieved_time ')

希望这可以帮助某人。