Django-Rest-Framework序列化器在多个视图中使用不同的字段

15

我是 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 谢谢您提供有趣的解决方案,但在我的当前应用程序中,我只创建了两个非常相似的序列化程序,仅有一个额外字段不同。 - sorryMike
难道这不是我建议你做的吗?使用两个不同的序列化程序? - e4c5
@e4c5 是的,谢谢你的建议。我以为你在问 get_serializer_class。 - sorryMike
3个回答

47

当有人刚开始使用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

这样生活就简单多了。


2
感谢分享您的经验!这里节省了很多时间 :+1: - Constantin De La Roche

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

1
您也可以使用下一个方法:
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://dev59.com/IlcP5IYBdhLWcg3worn_#44064046


这是对这个常见问题的一个非常好的答案。干得好! - Jmichelsen

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接