SerializerMethodField 來優化沒必要要的查詢

在 Django REST framework 善用 SerializerMethodField 來優化沒必要要的查詢首先來看一個例子，在通常狀況下，對於有父子關係的對象，咱們使用下面的方法來建立類。一個Article類，一個Article對象能夠有多個Comment實例，那麼Django中類的定義以下：python

from django.db import models
from django.contrib.auth.models import User

class Article(models.Model):
    title = models.CharField('文章標題', max_length=1024, blank=False)
    summary = models.TextField('文章簡介', blank=False)
    content = models.TextField('文章內容', blank=True, null=True)
    create_user = models.ForeignKey(User, related_name='article_create_user', verbose_name='建立用戶')
    create_time = models.DateTimeField('建立時間', auto_now_add=True)
    def __str__(self):
        return self.title

    def __unicode__(self):
        return self.title

    class Meta:
        ordering = ('-create_time',)


class Comment(models.Model):
    article = models.ForeignKey(Article, related_name='article_comments', verbose_name='文章')
    comment = models.CharField('評論', max_length=1024, blank=False)
    create_user = models.ForeignKey(User, related_name='article_comments_create_user', verbose_name='建立用戶')
    create_time =models.DateTimeField('建立時間', auto_now_add=True)
    
    def __str__(self):
    return self.comment

    def __unicode__(self):
        return self.comment

    class Meta:
        ordering = ('-create_time',)

根據上面類的定義，那麼在 Django REST framework 咱們一般按下面的方式定義 Serializer 類。在 ArticleSerializer 類中增長一個屬性 article_comments 來保存當前 Article 對象全部的評論集合。可是此時有個問題若是此 Article 對象所擁有的 Comment 比較多，此時就會影響性能。好比：django

#coding:utf-8
from rest_framework import serializers
from .models import Article, Comment

class ArticleSerializer(serializers.ModelSerializer):
    article_comments = serializers.PrimaryKeyRelatedField(many=True, required=False, read_only=True)
    class Meta:
        model = Article
        fields = ('id', 'title', 'summary', 'content', 'create_user', 'create_time', 'article_comments')

        
class CommentSerializer(serializers.ModelSerializer):
    class Meta:
        model = Comment
        fields = ('id', 'article', 'comment', 'create_user', 'create_time')

其實在不少時候咱們並不須要在查詢 Article 對象的時候查詢所擁有的 Comment 對象，不少時候咱們只是須要一個 Article 所擁有 Comment 對象的總數就能夠了，若是有須要再去查詢 Comment 列表詳細。此時咱們就能夠使用 Django REST framework 提供的 SerializerMethodField 來實現這個目的。以下：api

from rest_framework import serializers
from .models import Article, Comment

class ArticleSerializer(serializers.ModelSerializer):
    article_comments_count = serializers.SerializerMethodField()
    class Meta:
        model = Article
        fields = ('id', 'title', 'summary', 'content', 'create_user', 'create_time', 'article_comments_count')

    def get_article_comments_count(self, obj):
        return obj.article_comments.all().count()

class CommentSerializer(serializers.ModelSerializer):
    class Meta:
        model = Comment
        fields = ('id', 'article', 'comment', 'create_user_id', 'create_user_name', 'create_time')

首先在 ArticleSerializer 中去除 article_comments 屬性；而後在 ArticleSerializer 中增長一個屬性 article_comments_count，並把這個屬性添加到 Meta 的 fields 列表裏；添加一個 get_article_comments_count 方法，這個方法的命名規則就是在上面聲明的屬性前面加上個「get_」前綴，並接受一個 obj 參數，這個 obj 參數就是當前的 Article 對象實例。性能

此時在查看 Article 的api中就只顯示 Comment 的總數而不顯示具體列表了。優化