如何优化Django可浏览API中模型字符串表示的数据库查询

问题原因 #

DRF的可浏览API（Browsable API）在渲染页面时，会在列表项展示、表单生成等多个环节调用模型的__str__方法。你的Budget模型__str__中直接引用self.client.name，如果关联的Client对象未被预取，每次调用都会触发单独的数据库查询，进而导致N+1问题。

尽管你在视图中使用了select_related("client")，但DRF可浏览API的部分渲染逻辑（比如表单选项生成、侧边栏快捷操作）可能没有复用视图的预取查询集，因此仍会触发重复查询。

解决方案 #

1. 自定义模型管理器，默认预取关联对象

让Budget模型的默认查询集自动预取client，确保所有获取Budget实例的场景（包括可浏览API）都能避免重复查询：

from django.db import models

class BudgetManager(models.Manager):
    def get_queryset(self):
        return super().get_queryset().select_related('client')

class Budget(models.Model):
    name = models.CharField(max_length=128, verbose_name="Budget name")
    client = models.ForeignKey(Client, related_name="budgets", on_delete=models.PROTECT)
    
    # 替换默认管理器
    objects = BudgetManager()

    class Meta:
        constraints = [models.UniqueConstraint(fields=["client", "name"], name="unique_client_budget_name_combination")]
        ordering = ["name"]

    def __str__(self):
        return f"{self.name} ({self.client.name})"

2. 在序列化器中显式关联client字段，激活缓存

通过序列化器访问client.name，确保视图预取的client对象被缓存，后续调用__str__时直接使用内存中的数据：

from rest_framework import serializers

class BudgetDisplaySerializer(serializers.ModelSerializer):
    # 显式序列化client的name字段
    client_name = serializers.CharField(source='client.name', read_only=True)

    class Meta:
        model = Budget
        fields = ['id', 'name', 'client_name']

3. 优化__str__方法，添加本地缓存

在模型中添加属性缓存client.name，避免重复访问外键触发查询：

class Budget(models.Model):
    # ... 现有字段 ...

    @property
    def _cached_client_name(self):
        if not hasattr(self, '__client_name'):
            # 仅在首次访问时获取，后续直接用缓存值
            self.__client_name = self.client.name
        return self.__client_name

    def __str__(self):
        return f"{self.name} ({self._cached_client_name})"

验证优化效果 #

修改后，用django-debug-toolbar重新检测：

• 重复查询次数会大幅减少，耗时会接近仅使用self.name作为__str__的情况。
• 所有Budget实例的client数据会通过JOIN查询一次性获取，彻底解决N+1问题。

内容的提问来源于stack exchange，提问作者Hans Bambel