如何在Django模型中存储重要查询？解决Manager实例访问报错

问题说明 #

在Django应用中有多个需要多处复用的重要查询，原本想在Model类中添加方法按需获取数据，但尝试使用classmethod和实例方法时，因调用Manager触发错误：AttributeError: Manager isn't accessible via ... instances。

原代码示例：

class XDL(models.Model):
    name = models.CharField(max_length = 20)
    Order_Code_Description = models.CharField(max_length = 355)
    Status = models.CharField(max_length = 20)
    Supplier = models.CharField(max_length = 100)

    @classmethod
    def get_count_xdls(cls):
        return cls.objects.all() # 查询示例

    def get_all_supps(self):
        return self.objects.all() # 查询示例

Django文档对此的解释：

管理器只能通过模型类访问，而不能通过模型实例访问，以此区分“表级操作”和“记录级操作”

最佳实践方案 #

1. 自定义Manager（官方推荐） #

将复用的查询逻辑封装到自定义Manager中，这是Django官方推荐的表级查询复用方式，逻辑清晰且符合框架设计。

示例代码：

class XDLManager(models.Manager):
    def get_all_xdls(self):
        return self.all()
    
    def get_unique_suppliers(self):
        # 更复杂的查询示例：获取所有唯一供应商
        return self.values_list('Supplier', flat=True).distinct()

class XDL(models.Model):
    name = models.CharField(max_length = 20)
    Order_Code_Description = models.CharField(max_length = 355)
    Status = models.CharField(max_length = 20)
    Supplier = models.CharField(max_length = 100)

    objects = XDLManager()  # 替换默认的objects管理器

使用方式：

# 获取所有XDL记录
all_xdls = XDL.objects.get_all_xdls()
# 获取所有唯一供应商
suppliers = XDL.objects.get_unique_suppliers()

2. 模型类方法（classmethod） #

如果查询逻辑和模型类强绑定，可使用classmethod，注意必须通过模型类调用，实例方法仅用于处理当前实例的记录级操作（不能在实例方法中用self.objects）。

修正后的示例代码：

class XDL(models.Model):
    # ... 字段定义
    
    @classmethod
    def get_count_xdls(cls):
        # 通过cls访问管理器，合法且符合表级操作逻辑
        return cls.objects.count()
    
    # 实例方法示例：仅处理当前实例相关的操作
    def update_status(self, new_status):
        self.Status = new_status
        self.save()

3. 自定义QuerySet（支持链式调用） #

若需要支持查询的链式调用（比如先过滤再应用自定义逻辑），可以自定义QuerySet，再让Manager返回该QuerySet。

示例代码：

class XDLQuerySet(models.QuerySet):
    def active(self):
        # 过滤出状态为active的记录
        return self.filter(Status='active')
    
    def from_supplier(self, supplier_name):
        # 过滤指定供应商的记录
        return self.filter(Supplier=supplier_name)

class XDLManager(models.Manager):
    def get_queryset(self):
        return XDLQuerySet(self.model, using=self._db)
    
    # 把QuerySet的方法映射到Manager上，方便直接调用
    def active(self):
        return self.get_queryset().active()
    
    def from_supplier(self, supplier_name):
        return self.get_queryset().from_supplier(supplier_name)

class XDL(models.Model):
    # ... 字段定义
    objects = XDLManager()

使用方式（支持链式调用）：

# 获取指定供应商的所有活跃XDL记录数量
count = XDL.objects.active().from_supplier('ABC Corp').count()

4. 模块级查询函数 #

如果查询逻辑涉及多个模型，或不想与单个模型绑定，可以将查询写在单独的模块（如queries.py）中，实现集中管理。

示例代码：

# 在app目录下创建queries.py
from .models import XDL

def get_active_xdls():
    return XDL.objects.filter(Status='active')

def get_supplier_xdl_count(supplier_name):
    return XDL.objects.filter(Supplier=supplier_name).count()

使用方式：

from .queries import get_active_xdls, get_supplier_xdl_count

active_xdls = get_active_xdls()
supplier_count = get_supplier_xdl_count('ABC Corp')

内容的提问来源于stack exchange，提问作者amir jj