Django REST Framework: thêm trường bổ sung vào ModelSerializer

Tôi muốn tuần tự hóa một mô hình, nhưng muốn bao gồm một trường bổ sung yêu cầu thực hiện một số tra cứu cơ sở dữ liệu trên phiên bản mô hình để được tuần tự hóa:

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

Cách đúng đắn để làm điều này là gì? Tôi thấy rằng bạn có thể chuyển "ngữ cảnh" bổ sung cho bộ nối tiếp, đây có phải là câu trả lời đúng để chuyển vào trường bổ sung trong từ điển ngữ cảnh không? Với cách tiếp cận đó, logic nhận được trường tôi cần sẽ không được bao gồm với định nghĩa serializer, lý tưởng vì mọi trường hợp được tuần tự hóa sẽ cần my_field. Ở những nơi khác trong tài liệu của DRF serializers nó nói "trường bổ sung có thể tương ứng với bất kỳ tài sản hoặc có thể được gọi vào mô hình". Là các lĩnh vực thêm những gì tôi đang nói về? Tôi có nên định nghĩa một hàm trong Foođịnh nghĩa mô hình trả về my_fieldgiá trị và trong trình tuần tự hóa, tôi kết nối my_field với lệnh có thể gọi đó không? Điều đó giống như thế nào?

Cảm ơn trước, vui lòng làm rõ câu hỏi nếu cần thiết.

Tôi nghĩ rằng SerializerMethodField là những gì bạn đang tìm kiếm:

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

Bạn có thể thay đổi phương thức mô hình của mình thành thuộc tính và sử dụng nó trong serializer với phương pháp này.

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

Chỉnh sửa: Với các phiên bản gần đây của khung nghỉ (tôi đã thử 3.3.3), bạn không cần thay đổi thành thuộc tính. Phương pháp mô hình sẽ chỉ hoạt động tốt.

Với phiên bản cuối cùng 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 của trường bạn muốn thêm. Không cần @propertyvà source='field'đưa ra một lỗi.

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

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

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

Câu trả lời của tôi cho một câu hỏi tương tự ( ở đây ) có thể hữu ích.

Nếu bạn có Phương thức 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 serializer 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 làm cho nó ở chế độ chỉ đọc, như vậy:

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

nếu bạn muốn đọc và viết trên trường thêm của mình, bạn có thể sử dụng trình tuần tự tùy chỉnh mới, mở rộng serializer.Serializer và sử dụng nó như thế này

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']

tôi sử dụng điều này trong các trường lồng nhau có liên quan với một số logic tùy chỉnh

Điều này làm việc cho tôi . Nếu chúng tôi muốn thêm một trường bổ sung vào ModelSerializer, chúng tôi có thể làm như dưới đây và trường cũng có thể được chỉ định một số val sau khi tính toán tra cứu. Hoặc trong một số trường hợp nếu chúng tôi muốn gửi các tham số trong phản hồi API.

Trong mô hình

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



   **

Trong serializer.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 ')

**

Hy vọng điều này có thể giúp ai đó

**

Như Lập trình viên hóa học đã nói trong bình luận này , trong DRF mới nhất, bạn có thể làm như thế này:

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

    def get_extra_field(self, foo_instance):
        return foo_instance.a + foo_instance.b

    class Meta:
        model = Foo
        fields = ('extra_field', ...)

Nguồn tài liệu DRF