Django rest 框架 - 为类设置默认序列化程序

Question

在我的代码中，我有几个具有多个自定义属性的模型：

@dataclass
class Value:
    amount: float
    currency: str

class MyModel(models.Model):
    ...
    
    @property
    def v1(self) -> Value:
        ...
    
    @property
    def v2(self) -> Value:
        ...
    
    @property
    def v3(self) -> Value:
        ...

我有以下序列化程序：

class MyModelBaseSerializer(serializers.ModelSerializer):
    class Meta:
        model = MyModel
        fields = [..., "v1", "v2", "v3"]

当序列化任何 MyModel 实例时，会引发 TypeError：TypeError: Object of type Value is not JSON serializable。

我知道这可以通过在MyModelBaseSerializer 中显式添加v1, v2, v3 作为字段来解决，但我不想这样做：我有很多具有Value 属性的模型。我希望默认 DRF 序列化程序知道如何序列化 Value 实例。

我尝试覆盖to_representation，但这似乎不起作用。
我想要类似于覆盖 JSONEncoder.default(o) 方法的东西，但我不知道如何告诉 DRF 使用哪个编码器。

Answer 1

为Value 添加一个自定义序列化程序。例如（未测试）。

class ValueSerializer(serializers.Serializer):
    amount = serializers.FloatField()
    currency = serializers.CharField()


class MyModelBaseSerializer(serializers.ModelSerializer):
    v1 = ValueSerializer()
    v2 = ValueSerializer()
    v3 = ValueSerializer()
    ...

或者，由于Value 是dataclass，请查看https://github.com/oxan/djangorestframework-dataclasses。

编辑

一种快速而肮脏的 DRY 方法是覆盖序列化程序上的 build_property_field (see docs)。

class MyModelBaseSerializer(serializers.ModelSerializer):
    def build_property_field(self, field_name, model_class):
        if field_name in ["v1", "v2", "v3"]:
            return ValueSerializer, {}
        return super().build_property_field(field_name, model_class)

覆盖serializer_field_mapping 是另一种选择。