DRF里 SerializerMethodField 的使用

May 28, 2018

现公司的项目使用 DRF 框架开发 Restful API；由于做了前后端分离，后端开发不用考虑前端页面的展示，只要专心写 API 就好了；而且 DRF 也为接口开发提供了很多便利性，很多情况下，按套路简单写写 Model – Serializer – View ，很快就能撸好一大批接口；生活似乎会很美好。

项目开发了大半年，功能越加越多，接口数量也跟着膨胀，有些问题也跟随着浮出水面，有些与接口设计有关，有些是框架限制并没有很完美的解决方法。

最初为了维护的方便，让 App 和后台使用了同一套的 API；可惜结果越来越不遂人意。App 开发人员开始抱怨接口返回数据太多，导致响应太慢。而作为后端开发也开始感觉到另一方面的不便，由于 App 和后台所面向的人群不同，同一接口的话，得同时考虑到不同调用方的权限处理，思虑太多，代码反而更难维护；根据接口的用户做拆分反而能够写出浅显易维护的代码。
由于大量使用 ModelSerializer ，如果需求上只是简单返回 Model 上的字段，是挺方面。可是需求一复杂，返回结果并不能直接对应到某个Model，就有些蛋疼了；常常是用着 DRF 框架的一系列东西，到最后直接拿拼凑出来的 dict 作为接口返回对象。

这边要提的是使用 SerializerMethodField 来解决 Model 上并没有直接对应字段的问题。问题所对应的场景如下：

当前有 产品 和 产品收藏 两张表；当用户调用产品列表接口时，要一并返回用户是否收藏了该产品(is_favorite)。两张表的简单定义如下

# 产品表
class Product(Model):
    product_uuid = models.UUIDField(
        primary_key=True, default=uuid.uuid4, editable=False)
    name = models.CharField(max_length=40)


# 产品收藏表
class Collection(CommonInfo):
    collection_uuid = models.UUIDField(
        primary_key=True, default=uuid.uuid4, editable=False)
    agent = models.ForeignKey(
        'User', on_delete=models.DO_NOTHING)

这个需求麻烦的地方，在于返回的数据跟调用者是相关的，而这又没法通过简单的给 Model 添加 Property 来解决；所以在 Model这个层面是无解。在 Serializer 这个层面，如果之前没接触过 SerializerMethodField ，写出的代码/方案会很丑（比如定义一个普通的 Serializer类，然后定义 product 和 is_favorite 字段）。以下是使用 SerializerMethodField 之后，个人比较满意的做法：

class ProductSerializer(ModelSerializer):
    is_favorite = serializers.SerializerMethodField()

    class Meta:
        model = models.Product
        fields = ('product_uuid', 'name', 'is_favorite')

    def get_is_favorite(self, obj):
        ''' 获取 当前用户是否收藏了该产品 '''
        request = self.context.get('request', None)
        if not request:
            return False
        if not request.user or request.user.is_anonymous:
            return False
        return Collection.objects.filter(
            product=obj.pk, user=request.user.pk).exists()

参考链接：

更多