在 DRF 序列化的响应字典中添加非模型字段

使用 Django 框架开发后端接口时，经常会遇到在序列化响应字典中添加非模型字段的需求。例如，在创建或更新模型实例时，我们需要在响应中包含一个表示操作成功与否的字段。

然而，在默认情况下，DRF 的序列化器只支持将模型字段序列化为 JSON 格式。如果我们需要在响应中包含一个非模型字段，就需要找到一种方法来将其添加到序列化器的响应字典中。

2. 解决方案

以下是在 DRF 序列化的响应字典中添加非模型字段的解决方案：

1. 扩展序列化器类
   我们可以通过扩展序列化器类来添加非模型字段。扩展后的序列化器类需要具备 get_field_value() 方法，该方法可以根据模型实例和字段名称来获取字段的值。

   class MySerializer(serializers.ModelSerializer):
       status = serializers.SerializerMethodField('get_status')
   
       class Meta:
           model = MyModel
           read_only_fields = ('status',)
   
       def get_status(self, obj):
           return obj.available
   

2. 使用 SerializerMethodField 字段
   SerializerMethodField 字段是一种特殊类型的序列化器字段，它允许我们在序列化器类中定义一个方法来生成字段的值。通过使用 SerializerMethodField 字段，我们可以将非模型字段添加到序列化器的响应字典中。

   class MySerializer(serializers.ModelSerializer):
       status = serializers.SerializerMethodField()
   
       class Meta:
           model = MyModel
           fields = ('id', 'name', 'status')
   
       def get_status(self, obj):
           return obj.available
   

3. 使用 to_representation() 方法
   to_representation() 方法是一种将模型实例转换为 JSON 格式的通用方法。我们可以通过重写 to_representation() 方法来在序列化的响应字典中添加非模型字段。

   class MySerializer(serializers.ModelSerializer):
       class Meta:
           model = MyModel
           fields = ('id', 'name')
   
       def to_representation(self, instance):
           data = super().to_representation(instance)
           data['status'] = instance.available
           return data
   

代码例子

以下是一个使用 SerializerMethodField 字段将非模型字段添加到序列化的响应字典中的示例代码：

class MySerializer(serializers.ModelSerializer):
    status = serializers.SerializerMethodField()

    class Meta:
        model = MyModel
        fields = ('id', 'name', 'status')

    def get_status(self, obj):
        return obj.available


@api_view(['GET'])
def my_view(request):
    queryset = MyModel.objects.all()
    serializer = MySerializer(queryset, many=True)
    return Response(serializer.data)

修改字段名

如果我们需要修改序列化器数据中字段的名称，可以使用 Field#source 属性。Field#source 属性用于指定字段的名称，它可以是模型字段的名称、方法的名称或属性的名称。

例如，以下代码将 name 字段的名称修改为 full_name：

class MySerializer(serializers.ModelSerializer):
    full_name = serializers.CharField(source='name')

    class Meta:
        model = MyModel
        fields = ('id', 'full_name')

总结

在 DRF 序列化的响应字典中添加非模型字段的方法有几种，包括扩展序列化器类、使用 SerializerMethodField 字段和使用 to_representation() 方法。我们可以根据自己的需要选择合适的方法来实现需求。