Django Rest Framework - Cách thêm trường tùy chỉnh trong ModelSerializer

Tôi đã tạo ModelSerializervà muốn thêm trường tùy chỉnh không thuộc mô hình của tôi.

Tôi đã tìm thấy mô tả để thêm các trường bổ sung ở đây và tôi đã thử những cách sau:

customField = CharField(source='my_field')

Khi tôi thêm trường này và gọi validate()hàm của mình thì trường này không phải là một phần của attrdict. attrchứa tất cả các trường mô hình được chỉ định ngoại trừ các trường bổ sung. Vì vậy, tôi không thể truy cập trường này trong xác thực đã ghi đè của mình, có thể không?

Khi tôi thêm trường này vào danh sách trường như sau:

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

sau đó tôi gặp lỗi vì customFieldkhông phải là một phần của mô hình của tôi - điều gì đúng vì tôi muốn thêm nó chỉ cho bộ nối tiếp này.

Có cách nào để thêm trường tùy chỉnh không?

Bạn đang làm đúng, ngoại trừ trường CharField(và các trường đã nhập khác) dành cho các trường có thể ghi.

Trong trường hợp này, bạn chỉ muốn một trường chỉ đọc đơn giản, vì vậy thay vào đó chỉ cần sử dụng:

customField = Field(source='get_absolute_url')

Trong thực tế, có một giải pháp mà không cần chạm vào mô hình nào cả. Bạn có thể sử dụng SerializerMethodFieldnó cho phép bạn cắm bất kỳ phương pháp nào vào bộ nối tiếp của mình.

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

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

... để rõ ràng, nếu bạn có Phương pháp mô hình được xác định theo cách sau:

class MyModel(models.Model):
    ...

    def model_method(self):
        return "some_calculated_result"

Bạn có thể thêm kết quả của việc gọi phương thức đã nói vào bộ tuần tự của mình như sau:

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

ps Vì trường tùy chỉnh không thực sự là một trường trong mô hình của bạn, nên bạn thường muốn đặt nó ở chế độ chỉ đọc, như vậy:

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

đây câu trả lời cho câu hỏi của bạn. bạn nên thêm vào Tài khoản mô hình của mình:

@property
def my_field(self):
    return None

bây giờ bạn có thể sử dụng:

customField = CharField(source='my_field')

nguồn: https://stackoverflow.com/a/18396622/3220916

Để hiển thị self.author.full_name, tôi gặp lỗi với Field. Nó hoạt động với ReadOnlyField:

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

Với phiên bản mới nhất của Django Rest Framework, bạn cần tạo một phương thức trong mô hình của mình với tên trường bạn muốn thêm.

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

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

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

Tôi đang tìm kiếm giải pháp để thêm trường tùy chỉnh có thể ghi vào bộ tuần tự mô hình. Tôi đã tìm thấy cái này, chưa được đề cập trong các câu trả lời cho câu hỏi này.

Có vẻ như bạn thực sự cần viết Serializer đơn giản của riêng mình.

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

Bây giờ bạn có thể sử dụng Serializer này để thêm các trường tùy chỉnh vào 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

Điều này cũng hoạt động, nếu Model MyModelthực sự có một thuộc tính được gọi my_custom_fieldnhưng bạn muốn bỏ qua các trình xác nhận của nó.

Sau khi đọc tất cả các câu trả lời ở đây, kết luận của tôi là không thể làm điều này một cách sạch sẽ. Bạn phải chơi bẩn và làm điều gì đó khó hiểu như tạo trường write_only và sau đó ghi đè các phương thức validatevà to_representation. Đây là những gì làm việc cho tôi:

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