如何在JPA Criteria API中手动设置别名并嵌入原生SQL片段？

问题背景 #

项目基于JPA Criteria API构建，无法切换到原生SQL或jOOQ，但需要在查询中嵌入原生SQL片段（如PostgreSQL的JSONB_PATH_QUERY操作）。当前尝试通过拼接实体别名的方式嵌入原生SQL时，出现以下问题：

• root.getAlias()返回null
• 手动调用root.alias("test")后，生成的SQL仍使用JPA自动分配的默认别名（如ae1_0）

示例代码 #

@Autowired
EntityManager em;

@Test
void f() {
    CriteriaBuilder cb = em.getCriteriaBuilder();
    CriteriaQuery<Object> query = cb.createQuery();
    var root = query.from(AgreementEntity.class);
    query.select(root.get("id"));
    query.where(
        cb.isTrue(
            nativeSql(
                cb,
                """
                EXISTS(
                    SELECT 1
                    FROM JSONB_PATH_QUERY(
                       %s.complex_jsonb_column,
                       '$[*].x'
                    ) as x
                    WHERE x::text = '"123"'
                )
                """.formatted(root.getAlias())
            )
        )
    );
    em.createQuery(query).getResultList();
}

Expression<Boolean> nativeSql(CriteriaBuilder cb, String sql) {
    var exp = cb.function(sql, Boolean.class);
    SelfRenderingSqmFunction<?> sexp = (SelfRenderingSqmFunction<?>) exp;
    SqmFunctionDescriptor sdesc = sexp.getFunctionDescriptor();
    FieldUtils.setProtectedFieldValue("useParenthesesWhenNoArgs", sdesc, false);
    return exp;
}

生成的错误SQL #

select
    ae1_0.id 
from
    agora.agreement_agora2 ae1_0 
where
    EXISTS(     SELECT
        1     
    FROM
        JSONB_PATH_QUERY(        null.complex_jsonb_column,        '$[*].x'     ) as x 
    WHERE
        x::text = '"123"' ) 

解决方案 #

方案一：通过参数传递避免手动拼接别名 #

问题根源是JPA在查询渲染阶段才会确定最终的实体别名，提前调用getAlias()无法获取到正确值。可以修改自定义nativeSql方法，支持传入字段表达式，让JPA自动处理别名和字段引用：

修改后的nativeSql方法

import org.apache.commons.lang3.reflect.FieldUtils;
import org.hibernate.query.sqm.function.SelfRenderingSqmFunction;
import org.hibernate.query.sqm.function.SqmFunctionDescriptor;

import jakarta.persistence.criteria.CriteriaBuilder;
import jakarta.persistence.criteria.Expression;

Expression<Boolean> nativeSql(CriteriaBuilder cb, String sqlTemplate, Expression<?>... args) {
    // 使用占位符{0}, {1}...对应传入的参数，JPA会自动解析为带别名的字段引用
    SelfRenderingSqmFunction<Boolean> function = (SelfRenderingSqmFunction<Boolean>) cb.function(
        "({0})", Boolean.class, args
    );
    SqmFunctionDescriptor descriptor = function.getFunctionDescriptor();
    try {
        // 关闭无参数时的括号渲染，避免SQL语法错误
        FieldUtils.setProtectedFieldValue("useParenthesesWhenNoArgs", descriptor, false);
    } catch (IllegalAccessException e) {
        throw new RuntimeException("Failed to modify function descriptor", e);
    }
    return function;
}

调用方式

query.where(
    cb.isTrue(
        nativeSql(
            cb,
            """
            EXISTS(
                SELECT 1
                FROM JSONB_PATH_QUERY(
                   {0},
                   '$[*].x'
                ) as x
                WHERE x::text = '"123"'
            )
            """,
            root.get("complex_jsonb_column") // 直接传入字段表达式，JPA自动处理别名
        )
    )
);

这样生成的SQL会自动将{0}替换为正确的ae1_0.complex_jsonb_column，无需手动拼接别名。

方案二：用Criteria API完全重写EXISTS子查询 #

如果希望避免嵌入原生SQL，可以通过Criteria API结合PostgreSQL特定函数，实现等价的查询逻辑：

@Test
void f() {
    CriteriaBuilder cb = em.getCriteriaBuilder();
    CriteriaQuery<Object> query = cb.createQuery();
    var root = query.from(AgreementEntity.class);
    query.select(root.get("id"));

    // 构建关联主查询的子查询
    Subquery<Integer> subquery = query.subquery(Integer.class);
    Root<AgreementEntity> subRoot = subquery.correlate(root); // 关联主查询的root，保证别名一致

    // 调用JSONB_PATH_QUERY函数提取JSON数组中的x字段
    Expression<String> jsonPathResult = cb.function(
        "JSONB_PATH_QUERY",
        String.class,
        subRoot.get("complex_jsonb_column"),
        cb.literal("$[*].x")
    );

    // 转换类型并筛选条件：x::text = '"123"'
    Expression<String> castedResult = cb.function(
        "cast",
        String.class,
        jsonPathResult,
        cb.literal("text")
    );
    subquery.select(cb.literal(1))
            .where(cb.equal(castedResult, "\"123\""));

    // 主查询使用exists条件
    query.where(cb.exists(subquery));

    em.createQuery(query).getResultList();
}

这种方式完全基于Criteria API构建，不需要依赖原生SQL片段，同时能保证别名的正确性。

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