django-rest-framework 序列化器在多个视图中的不同字段

Posted 2023-02-16

【中文标题】django-rest-framework 序列化器在多个视图中的不同字段

【英文标题】：django-rest-framework serializer different fields in multiple views

【发布时间】：2017-10-19 04:56:32

【问题描述】：

我是 Django 的新手，找不到解决问题的方法。

问题是在使用不同视图的情况下强制特定的序列化程序包含不同数量的字段。我想在我的第一个视图和第二个视图中使用“id”字段 - “id”和“name”字段。

这是我的model.py

class Processing(models.Model):
    id = models.AutoField(primary_key=True)
    name = models.CharField()
    description = models.CharField()

这是我的 serializer.py

class ProcessingSerializer(serializers.ModelSerializer):
    id = serializers.ModelField(model_field=Processing()._meta.get_field('id'))
    class Meta:
        model = Processing
        fields = ('id', 'name')

欢迎任何帮助。

【问题讨论】：

@e4c5 感谢您提供有趣的解决方案，但在我当前的应用程序中，我刚刚创建了两个非常相似的序列化程序，不同之处仅在于一个额外的字段

这不正是我建议你做的吗？使用两个不同的序列化器？

@e4c5 是的，感谢您的建议。以为你在问 get_serializer_class。

【参考方案1】：

当有人刚开始使用 DRF 时，一个常见的错误是试图让同一个 Serializer 做所有事情。当然，我自己也走上了这条路。

但是当您为不同的任务使用多个序列化程序时，生活会变得简单得多。您可以使用get_serializer_class 方法轻松切换序列化程序。这是手册中的一个示例，展示了如何将一个用于管理员，另一个用于普通用户

def get_serializer_class(self):
    if self.request.user.is_staff:
        return FullAccountSerializer
    return BasicAccountSerializer

有时您想对列表使用单个序列化程序，在提供详细信息时使用另一个序列化程序。试试这样的：

def get_serializer_class(self):
    if self.action == 'retrieve':
        return serializers.PlayerDetailSerializer
    else : 
        return serializers.PlayerSerializer

这样生活就简单多了。

【讨论】：

感谢分享您的经验！在这里节省了很多时间：+1：

【参考方案2】：

class DynamicFieldsModelSerializer(ModelSerializer):
    """
    A ModelSerializer that takes an additional `fields` and 'exclude' 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)
        exclude = kwargs.pop('exclude', 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.keys())
            for field_name in existing - allowed:
                self.fields.pop(field_name)

        if exclude is not None:
            not_allowed = set(exclude)
            for exclude_name in not_allowed:
                self.fields.pop(exclude_name)



class UserCreateSerializer(DynamicFieldsModelSerializer):
    class Meta:
        model = User
        fields = ('username', 'tel', 'email', 'password')

使用：

serializer = UserCreateSerializer(data=request.data, fields=('username', 'password', 'tel'))

或

serializer = UserCreateSerializer(data=request.data, fields=('username', 'password', 'email'))

【参考方案3】：

你也可以使用下一个方法：

class SelectSerializerMixin(object):
    serializer_class = None
    list_serializer_class = None
    retrieve_serializer_class = None
    update_serializer_class = None
    partial_update_serializer_class = None
    create_serializer_class = None

    def get_serializer_class(self):
        """
        Return the class to use for the serializer.
        Defaults to using `self.serializer_class`.
        """
        assert self.serializer_class is not None, (
            "'%s' should either include a `serializer_class` attribute, "
            "or override the `get_serializer_class()` method."
            % self.__class__.__name__
        )
        return getattr(self, f"self.action_serializer_class") or self.serializer_class

然后将此 mixin 添加到您的 ViewSet：

class MyModelViewSet(SelectSerializerMixin, ModelViewSet):
    queryset = models.MyModel.objects.all()
    serializer_class = serializers.SomeSerializer
    retrieve_serializer_class = serializers.AnotherSerializer
    list_serializer_class = serializers.OneMoreSerializer

但是，如果您需要具有一组动态字段的序列化程序（例如，您有一个处理程序，但您只需要在响应中返回特定字段），您可以使用 Ykh 的回答中的方法。

https://***.com/a/44064046/2818865

【讨论】：

这是对这个常见问题的一个很好的答案。干得好