[django] 장고 휴식 프레임 워크, 동일한 ModelViewSet에서 다른 직렬 변환기 사용

여러 Serializer를 미리 정의하거나 정의하는 것이 가장 명백한 것처럼 보이지만 문서화 된 방법 인 FWIW는 다른 문서화 된 코드를 사용하고 인스턴스화 된대로 인수를 serializer에 전달할 수있는 대체 방법이 있습니다. 사용자 관리 수준, 호출되는 동작, 인스턴스의 속성 등 다양한 요소를 기반으로 논리를 생성해야한다면 더 가치가 있다고 생각합니다.

퍼즐의 첫 번째 조각은 은 인스턴스화 시점에서 직렬 변환기를 동적으로 수정하는 방법 . 이 문서는 뷰셋에서이 코드를 호출하는 방법이나 필드가 초기화 된 후 필드의 읽기 전용 상태를 수정하는 방법을 설명하지는 않지만 그리 어렵지는 않습니다.

두 번째 부분 -get_serializer 메소드 도 문서화되어 있습니다 ( ‘다른 메소드’에서 get_serializer_class에서 조금 더 아래에 있음). 신뢰할 수 있어야합니다. 수정으로 인한 부작용). GenericAPIView (ModelViewSet 및 다른 모든 내장 뷰 세트 클래스)에서 소스를 확인하여 get_serializer를 정의하는 GenericAPIView에서 상속하십시오.

두 가지를 합치면 다음과 같이 할 수 있습니다.

serializers 파일에서 (base_serializers.py)

class DynamicFieldsModelSerializer(serializers.ModelSerializer):
"""
A ModelSerializer that takes an additional `fields` argument that
controls which fields should be displayed.
"""

def __init__(self, *args, **kwargs):
    # Don't pass the 'fields' arg up to the superclass
    fields = kwargs.pop('fields', None)

    # Adding this next line to the documented example
    read_only_fields = kwargs.pop('read_only_fields', None)

    # Instantiate the superclass normally
    super(DynamicFieldsModelSerializer, self).__init__(*args, **kwargs)

    if fields is not None:
        # Drop any fields that are not specified in the `fields` argument.
        allowed = set(fields)
        existing = set(self.fields)
        for field_name in existing - allowed:
            self.fields.pop(field_name)

    # another bit we're adding to documented example, to take care of readonly fields 
    if read_only_fields is not None:
        for f in read_only_fields:
            try:
                self.fields[f].read_only = True
            exceptKeyError:
                #not in fields anyway
                pass

그런 다음 뷰 세트에서 다음과 같이 할 수 있습니다.

class MyViewSet(viewsets.ModelViewSet):
    # ...permissions and all that stuff

    def get_serializer(self, *args, **kwargs):

        # the next line is taken from the source
        kwargs['context'] = self.get_serializer_context()

        # ... then whatever logic you want for this class e.g:
        if self.action == "list":
            rofs = ('field_a', 'field_b')
            fs = ('field_a', 'field_c')
        if self.action == “retrieve”:
            rofs = ('field_a', 'field_c’, ‘field_d’)
            fs = ('field_a', 'field_b’)
        #  add all your further elses, elifs, drawing on info re the actions, 
        # the user, the instance, anything passed to the method to define your read only fields and fields ...
        #  and finally instantiate the specific class you want (or you could just
        # use get_serializer_class if you've defined it).  
        # Either way the class you're instantiating should inherit from your DynamicFieldsModelSerializer
        kwargs['read_only_fields'] = rofs
        kwargs['fields'] = fs
        return MyDynamicSerializer(*args, **kwargs)

그리고 그게 다야! MyViewSet을 사용하면 원하는 인수를 사용하여 MyDynamicSerializer를 인스턴스화 할 수 있습니다. Serializer가 DynamicFieldsModelSerializer에서 상속한다고 가정하면 수행 할 작업을 알아야합니다.

아마도 다른 방법으로 serializer를 적용하려는 경우 특별한 의미를 가질 수 있다고 언급 할 가치가 있습니다. 예를 들어 read_only_exceptions 목록을 가져 와서 블랙리스트 필드가 아닌 화이트리스트에 사용하는 것이 좋습니다. 전달되지 않은 경우 필드를 빈 튜플로 설정 한 다음 없음 확인을 제거하면 유용합니다. 상속 직렬 변환기의 필드 정의를 ‘ all ‘로 설정하십시오. 이것은 직렬화기를 인스턴스화 할 때 전달되지 않은 필드가 우연히 살아남는 것을 의미하며 직렬화 기 호출과 상속 직렬화 기 클래스 정의를 비교하여 포함 된 내용을 알 필요가 없습니다 (예 : DynamicFieldsModelSerializer 의 초기화 내에) .

# ....
fields = kwargs.pop('fields', ())
# ...
allowed = set(fields)
existing = set(self.fields)
for field_name in existing - allowed:
self.fields.pop(field_name)
# ....

NB 별개의 동작으로 매핑 된 2 개 또는 3 개의 클래스를 원하거나 특별히 동적 직렬 변환기 동작을 원하지 않는 경우 다른 사람들이 언급 한 접근법 중 하나를 사용하는 것이 좋을 수도 있지만 대안으로 제시 할 가치가 있다고 생각했습니다. 특히 다른 용도로 사용됩니다.

답변