将用户特定字段添加到Django REST Framework序列化程序

时间:2013-10-19 16:47:01

标签: python django django-rest-framework

我想在序列化程序中添加一个字段,其中包含特定于发出当前请求的用户的信息(我不想为此创建单独的端点)。这是我做的方式:

视图集

class ArticleViewSet(viewsets.ModelViewSet):
    queryset = Article.objects.all()
    serializer_class = ArticleSerializer
    filter_class = ArticleFilterSet

    def prefetch_likes(self, ids):
        self.current_user_likes = dict([(like.article_id, like.pk) for like in Like.objects.filter(user=self.request.user, article_id__in=ids)])

    def get_object(self, queryset=None):
        article = super(ArticleViewSet, self).get_object(queryset)
        self.prefetch_likes([article.pk])
        return article

    def paginate_queryset(self, queryset, page_size=None):
        page = super(ArticleViewSet, self).paginate_queryset(queryset, page_size)
        if page is None:
            return None

        ids = [article.pk for article in page.object_list]
        self.prefetch_likes(ids)

        return page

序列化程序:

class ArticleSerializer(serializers.ModelSerializer):
    class Meta:
        model = Article

    def to_native(self, obj):
        ret = super(ArticleSerializer, self).to_native(obj)

        if obj:
            view = self.context['view']
            ret['has_liked'] = False
            if hasattr(view, 'current_user_liked'):
                ret['has_liked'] = obj.pk in view.current_user_liked

        return ret

是否有更好的地方注入喜欢的文章的预取,或者更好的方式来执行此操作?

3 个答案:

答案 0 :(得分:26)

您可以使用SerializerMethodField

执行此操作

示例:

class PostSerializer(serializers.ModelSerializer):
    fav = serializers.SerializerMethodField('likedByUser')

    def likedByUser(self, obj):
        request = self.context.get('request', None)
        if request is not None:
            try:
                liked=Favorite.objects.filter(user=request.user, post=obj.id).count()
                return liked == 1
            except Favorite.DoesNotExist:
                return False
        return "error"

    class Meta:
        model = Post

然后你应该从这样的视图中调用serializer:

class PostView(APIVIEW):
     def get(self,request):
         serializers = PostSerializer(PostObjects,context={'request':request})

答案 1 :(得分:8)

我倾向于尝试在Like模型对象上尽可能多地放置这个,然后在自定义序列化器字段中将其余部分打包。

在序列化工具字段中,您可以通过其父序列化程序继承request参数访问context

所以你可能会这样做:

class LikedByUserField(Field):
    def to_native(self, article):
        request = self.context.get('request', None)
        return Like.user_likes_article(request.user, article)

user_likes_article类方法可以封装您的预取(和缓存)逻辑。

我希望有所帮助。

答案 2 :(得分:1)

根据Django Documentation - SerializerMethodField,我不得不稍微更改一下rapid2share的代码。

class ResourceSerializer(serializers.ModelSerializer):
    liked_by_user = serializers.SerializerMethodField()

    def get_liked_by_user(self, obj : Resource):
        request = self.context.get('request')
        return request is not None and obj.likes.filter(user=request.user).exists()