如何在JPA Criteria API/JPQL中实现带DISTINCT/ORDER BY/SEPARATOR的GROUP_CONCAT？

问题背景 #

需要通过JPA Criteria API和JPQL实现MySQL的GROUP_CONCAT功能，要求支持去重(DISTINCT)、排序(ORDER BY)和自定义分隔符(SEPARATOR)。已通过自定义方言注册了GROUP_CONCAT函数，但现有写法无法实现上述特性，错误地将分隔符与每个列值拼接，期望生成如下SQL：

GROUP_CONCAT(DISTINCT packages4_.package_name ORDER BY packages4_.package_name DESC SEPARATOR ' # ') as col_3_0_,

对应期望输出：Package-2 # Package-1

解决方案 #

1. 调整自定义方言：注册支持复杂参数的GROUP_CONCAT函数 #

原有的StandardSQLFunction仅支持简单参数列表，无法适配GROUP_CONCAT的特殊语法。改用SQLFunctionTemplate定义函数模板，允许传入完整的SQL参数片段：

package com.mypackage;

import org.hibernate.dialect.MySQL8Dialect;
import org.hibernate.dialect.function.SQLFunctionTemplate;
import org.hibernate.type.StandardBasicTypes;

public class CustomMySQLDialect extends MySQL8Dialect {
    public CustomMySQLDialect() {
        super();
        // 注册支持复杂语法的GROUP_CONCAT函数
        registerFunction(
            "GROUP_CONCAT",
            new SQLFunctionTemplate(
                StandardBasicTypes.STRING,
                "GROUP_CONCAT(?1)"
            )
        );
    }
}

2. JPQL实现方式 #

直接在JPQL中编写完整的GROUP_CONCAT语法即可：

SELECT p.id, GROUP_CONCAT(DISTINCT p.packageName ORDER BY p.packageName DESC SEPARATOR ' # ') 
FROM Package p 
GROUP BY p.id

3. Criteria API实现方式 #

通过拼接包含DISTINCT、ORDER BY和SEPARATOR的完整表达式，作为参数传入cb.function()：

// 假设packagesJoin是关联查询的Join对象
Expression<String> groupConcatContent = cb.literal("DISTINCT ")
    .concat(packagesJoin.get("packageName"))
    .concat(cb.literal(" ORDER BY "))
    .concat(packagesJoin.get("packageName"))
    .concat(cb.literal(" DESC SEPARATOR ' # '"));

// 构造GROUP_CONCAT函数表达式
Expression<String> groupConcatExpr = cb.function(
    "GROUP_CONCAT", 
    String.class,
    groupConcatContent
);

// 将表达式加入查询的select列表
criteriaQuery.multiselect(/* 其他字段 */, groupConcatExpr, /* 其他字段 */);

此写法会生成符合预期的SQL，实现去重、排序和自定义分隔符的需求。

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