如何在JPA Criteria API中调用PostgreSQL的jsonb_path_exists函数？

问题核心是PostgreSQL的jsonb_path_exists函数要求第二个参数为jsonpath类型，而JPA默认将字符串参数解析为varchar，导致函数签名不匹配，抛出不存在该函数的异常。以下是几种可行的解决方式：

方法1：使用PostgreSQL内置的to_jsonpath函数转换类型 #

直接在Criteria调用中，将字符串形式的JSON路径通过to_jsonpath函数转换为PostgreSQL的jsonpath类型，匹配函数签名：

// 构造JSON路径字符串
var jsonQuery = jsonPath + " ? (@ ==\"" + value + "\")";
// 定义字符串表达式
Expression<String> jsonPathStrExpr = criteriaBuilder.literal(jsonQuery);
// 将字符串转为jsonpath类型的表达式
Expression<?> jsonPathTypeExpr = criteriaBuilder.function(
    "to_jsonpath", 
    Object.class, 
    jsonPathStrExpr
);

// 构建查询条件
Predicate existsPredicate = criteriaBuilder.isTrue(
    criteriaBuilder.function(
        "jsonb_path_exists", 
        Boolean.class, 
        entityRoot.get("json"), // 对应target jsonb参数
        jsonPathTypeExpr       // 对应path jsonpath参数
    )
);

生成的SQL会自动包含to_jsonpath转换，完全符合PostgreSQL的函数参数要求。

方法2：通过Hibernate自定义函数注册（适用于Hibernate作为JPA实现） #

如果使用Hibernate作为JPA Provider，可以通过自定义函数注册，明确指定参数类型，避免手动转换：

1. 引入Hibernate Types库（用于支持jsonpath类型）：

<dependency>
    <groupId>com.vladmihalcea</groupId>
    <artifactId>hibernate-types-55</artifactId>
    <version>2.19.0</version>
</dependency>

2. 注册自定义函数：

import com.vladmihalcea.hibernate.type.json.JsonPathType;
import org.hibernate.annotations.FunctionRegistration;
import org.hibernate.type.BooleanType;
import org.hibernate.type.JsonBinaryType;

@FunctionRegistration(
    name = "jsonb_path_exists",
    returnType = BooleanType.class,
    parameterTypes = {JsonBinaryType.class, JsonPathType.class}
)
public class JsonPathFunctionRegistrar {}

3. 在Criteria中直接调用函数，Hibernate会自动处理类型映射：

var jsonQuery = jsonPath + " ? (@ ==\"" + value + "\")";
Predicate existsPredicate = criteriaBuilder.isTrue(
    criteriaBuilder.function(
        "jsonb_path_exists", 
        Boolean.class, 
        entityRoot.get("json"),
        criteriaBuilder.literal(jsonQuery)
    )
);

方法3：使用原生SQL片段（兜底方案） #

如果上述方法都不适用，可以直接在Criteria中嵌入原生SQL片段来构建条件：

var jsonQuery = jsonPath + " ? (@ ==\"" + value + "\")";
Predicate existsPredicate = criteriaBuilder.sqlRestriction(
    "jsonb_path_exists(json, to_jsonpath(?))",
    jsonQuery,
    String.class
);

这种方式直接生成符合要求的原生SQL，绕过JPA的类型映射限制。

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