在 Django 中，原生的 SQL 聚合函数 GROUP_CONCAT 是非常常用的，特别是在处理类似于将多行数据合并成一个字符串的需求时。虽然 Django 的 ORM 本身并不直接支持 GROUP_CONCAT，但是你可以通过自定义类来实现这个功能。

下面是一个实现 GROUP_CONCAT 功能的自定义类。通过这个方法，你可以将某个字段的值按分隔符合并在一起。

1. 使用 RawSQL 实现 GROUP_CONCAT

我们可以通过 Django 的 Func 类来实现原生 SQL 聚合函数 GROUP_CONCAT 的功能。Func 类允许我们直接执行 SQL 函数。

首先，我们需要定义一个自定义的聚合类，来实现 GROUP_CONCAT 的功能。

2. 实现代码

创建自定义 GROUP_CONCAT 聚合类

你可以通过继承 Django ORM 中的 Func 类来实现 GROUP_CONCAT。

from django.db.models import Func, Value

class GroupConcat(Func):
    function = 'GROUP_CONCAT'
    
    def __init__(self, expression, separator=Value(','), **extra):
        # 默认分隔符是逗号，可以通过参数指定分隔符
        super().__init__(expression, separator, **extra)
        
    def as_sql(self, compiler, connection, **extra_context):
        # 自定义 SQL 函数的拼接方式
        sql, params = super().as_sql(compiler, connection, **extra_context)
        return f"{sql} {self.function}({params[0]})", params

参数解释：

  • expression：用于聚合的字段。
  • separator：指定分隔符，默认为逗号。
  • extra_context：Django 用来处理 SQL 的额外参数，基本情况下你不需要修改这个。

3. 使用 GroupConcat

定义了 GroupConcat 类之后，你就可以在查询中使用它了。例如，如果我们有一个 Order 模型，其中有多个商品，并且想将 Product 的名字按逗号分隔组合成一个字符串，使用 GROUP_CONCAT 实现：

示例模型

假设有如下两个模型：

# models.py
from django.db import models

class Product(models.Model):
    name = models.CharField(max_length=255)
    price = models.DecimalField(max_digits=10, decimal_places=2)

class Order(models.Model):
    customer_name = models.CharField(max_length=255)
    products = models.ManyToManyField(Product)

查询并使用 GROUP_CONCAT

我们可以使用 GroupConcat 聚合函数来按客户名称聚合所有购买的商品名称：

from django.db.models import F
from myapp.models import Order, Product
from myapp.models import GroupConcat

# 使用 GroupConcat 聚合函数
orders = Order.objects.annotate(
    product_names=GroupConcat('products__name', separator=Value(', '))
).values('customer_name', 'product_names')

# 输出每个客户的订单和商品名称
for order in orders:
    print(f"Customer: {order['customer_name']} - Products: {order['product_names']}")

输出示例：

Customer: Alice - Products: Apple, Banana, Orange
Customer: Bob - Products: Milk, Bread

说明：

  • products__name：指的是通过 Order 和 Product 的关系来获取每个 Order 中所有产品的名字。
  • GroupConcat：用来将多个产品名按逗号拼接成一个字符串。
  • separator=Value(', ')：指定了分隔符为逗号和空格，可以根据需要调整。

4. 使用 GROUP_CONCAT 进行排序

你还可以在 GROUP_CONCAT 中使用 ORDER BY 来指定聚合后的顺序。例如，按价格升序排列商品名称：

class GroupConcat(Func):
    function = 'GROUP_CONCAT'
    
    def __init__(self, expression, separator=Value(','), order_by=None, **extra):
        # 允许添加 ORDER BY 子句
        self.order_by = order_by
        super().__init__(expression, separator, **extra)

    def as_sql(self, compiler, connection, **extra_context):
        sql, params = super().as_sql(compiler, connection, **extra_context)
        if self.order_by:
            sql += f" ORDER BY {self.order_by}"
        return f"{sql} {self.function}({params[0]})", params

# 按价格升序排列商品名称
orders = Order.objects.annotate(
    product_names=GroupConcat('products__name', separator=Value(', '), order_by=F('products__price'))
).values('customer_name', 'product_names')

for order in orders:
    print(f"Customer: {order['customer_name']} - Products: {order['product_names']}")

注意：

  • order_by=F('products__price')：表示按照 Product 的 price 字段进行排序。

5. 总结

通过自定义一个继承自 Func 的 GroupConcat 类，我们能够在 Django ORM 中实现 SQL 的 GROUP_CONCAT 聚合函数，支持指定分隔符、排序等操作。这个方法非常适合需要对数据进行合并的场景，如生成按分隔符合并的列表、按类别汇总数据等。