本文详解如何在 Django QuerySet 中对指定字段(如 partner)进行分组,并将关联字段(如 partner_id)聚合成 Python 列表,借助 PostgreSQL 特有的 ArrayAgg 聚合器实现高效、简洁的注解式查询。
本文详解如何在 django queryset 中对指定字段(如 `partner`)进行分组,并将关联字段(如 `partner_id`)聚合成 python 列表,借助 postgresql 特有的 `arrayagg` 聚合器实现高效、简洁的注解式查询。
在 Django 开发中,常需将关系型数据“扁平化”为结构化字典集合,例如:将多个 Offer 实例按 partner 分组,并把每个分组下的所有 partner_id 汇总为一个列表。这种需求无法通过 .values() 或 .distinct() 直接满足,而需借助数据库层面的聚合能力。
Django 为 PostgreSQL 提供了强大的聚合工具——ArrayAgg,它可将一组值收集成 PostgreSQL 的 ARRAY 类型,Django 会自动将其映射为 Python list。配合 .values() 与 .annotate(),即可优雅达成目标。
✅ 正确实现方式
from django.contrib.postgres.aggregates import ArrayAgg
queryset = Offer.objects \
.values('partner') \
.annotate(partner_ids=ArrayAgg('partner_id')) \
.order_by('partner')执行后将返回如下结构的 QuerySet:
<QuerySet [
{'partner': 'xex', 'partner_ids': ['x_999', 'x_888']},
{'partner': 'quiup', 'partner_ids': ['q_888', 'q_777']}
]>⚠️ 注意事项:
Django Unfold下载提供使用 django-unfold (v0.56+) 构建高级 Django 管理界面的专业指导。当用户提及 django-unfold、unfold admin 等内容时使用此技能。
- ArrayAgg 是 PostgreSQL 专属功能,仅在使用 PostgreSQL 数据库时可用;SQLite/MySQL 不支持,强行使用将抛出 NotSupportedError。
- 若需去重(避免同一 partner_id 多次出现),可添加 distinct=True 参数:
ArrayAgg('partner_id', distinct=True)- 若字段可能为 NULL,可结合 filter 排除空值:
ArrayAgg('partner_id', filter=~Q(partner_id__isnull=True))- .values('partner') 必须出现在 .annotate() 之前,否则分组逻辑失效;且所有 .values() 中未声明的字段,均不可在后续 .annotate() 中引用(除非是聚合字段)。
? 进阶建议:重构模型以提升可维护性
当前模型中,partner 和 partner_id 均为字符串字段,属于典型的 Primitive Obsession(原始类型迷恋)反模式。长期来看,应将其建模为实体关系:
class Partner(models.Model):
code = models.CharField(max_length=50, unique=True)
name = models.CharField(max_length=100)
def __str__(self):
return self.name
class Offer(models.Model):
partner = models.ForeignKey(Partner, on_delete=models.PROTECT, related_name='offers')
partner_id = models.CharField(max_length=100, unique=True)
def __str__(self):
return f'{self.partner.code} - {self.partner_id}'重构后,查询更语义化、更高效:
# 获取每个 Partner 及其所有 Offer ID 列表(N+1 优化版)
Partner.objects.prefetch_related('offers').annotate(
offer_ids=ArrayAgg('offers__partner_id')
).values('code', 'name', 'offer_ids')这不仅提升查询表达力,还天然支持外键约束、索引优化、事务一致性与 Admin 集成。
✅ 总结
- 对 PostgreSQL 用户:ArrayAgg 是解决「分组 + 列表聚合」问题的标准方案,简洁可靠;
- 避免滥用字符串模拟关系,尽早引入 ForeignKey 模型抽象;
- 生产环境务必确认数据库后端兼容性,并在测试中覆盖聚合边界场景(如空分组、NULL 值)。
掌握 ArrayAgg 不仅能写出更高效的查询,更是迈向领域驱动设计(DDD)与高质量 Django 架构的重要一步。


















