使用 hql 表达式而不是 Criteria 的动态 HQL 查询？

Question

出于各种原因，我正在尝试编写部分动态的 HQL 查询而不使用 Criteria API。我想知道是否有一种简单的方法可以使用 HQLs 表达式来短路 where 限制。例如，这是可以正常工作的原始查询：

SELECT customer 
FROM Customer as customer 
INNER JOIN customer.profile as profile 
WHERE profile.status IN :statusCodes
AND   profile.orgId IN :orgIds

StatusCodes 是字符串列表，orgIds 是整数列表。但是，任何一个都是可选的，如果传递 null 而不是集合，则不应限制。我试图这样做：

SELECT customer 
FROM Customer as customer 
INNER JOIN customer.profile as profile 
WHERE (:statusCodes IS NULL OR profile.status IN :statusCodes)
AND   (:orgIds IS NULL OR profile.orgId IN :orgIds)

不幸的是，这不起作用，但是否有任何其他方法可能有效，无论是使用不同的表达式还是传入默认值？

编辑：为了清楚起见，我正在寻找一种使用 NamedQuery 的方法，而不是以任何方式动态构建查询。

解决方案：我使用额外的查询参数来完成它。我创建了两个辅助方法：

private void setRequiredParameter(TypedQuery<?> query, String name, Object value) {
    query.setParameter(name, value);
}

private void setOptionalParameter(TypedQuery<?> query, String name, Object value) {
    query.setParameter(name, value);
    query.setParameter(name + "Optional", value == null ? 1 : 0);
}

这样的查询：

SELECT customer 
        FROM Customer as customer 
        INNER JOIN  customer.profile as profile 
        WHERE (:statusCodesOptional = 1 OR profile.status IN :statusCodes)
        AND (:orgIdsOptional = 1 OR profile.orgId  IN :orgIds)

Answer 1

我的建议是将所有参数放在地图中并动态构建查询，在构建之后执行之前设置查询所需的所有参数，从地图中获取值：

Map<String, Object> pars = new HashMap<String,Object>();
pars.put("statusCodes", statusCodes);
pars.put("orgIds", orgIds);

StringBuilder b = "SELECT customer FROM Customer as customer INNER JOIN customer.profile as profile where 1 = 1";
if (statusCodes != null) {
  b.append(" and profile.status in :statusCodes");
}
if (orgIds != null) {
  b.append(" and profile.orgId in :statusCodes");
}

...

Query q = session.createQuery(b.toString());

...

for (String p : q.getNamedParameters()) {
  q.setParameter(p, pars.get(p));
}

当然需要一些改进，例如在未设置参数时抛出异常，如果复杂度大于几个简单参数则使用类型化参数等等。

Answer 2

如果您绝对必须避免动态查询，您可以这样做，但要牺牲两个额外的参数：

SELECT customer 
  FROM Customer AS customer 
  JOIN customer.profile AS profile 
 WHERE (profile.status IN :statusCodes OR :statusCodeCount = 0)
   AND (profile.orgId IN :orgIds OR :orgIdCount = 0)

在您的 Java 代码中，您将执行以下操作：

session.getNamedQuery("your.query.name")
       .setParameterList("statusCodes", statusCodes)
       .setParameter("statusCodeCount", statusCodes.length)
       .setParameterList("orgIds", orgIds)
       .setParameter("orgIdCount", orgIds.length);

您需要确保数组长度为零而不是 null，或者提供额外的 if 检查以处理 null 场景。

话虽如此，HQL 确实更适合定义明确的（例如静态）查询。您可以解决动态参数，但无法解决动态排序。

Answer 3

您必须动态生成查询：

StringBuilder hql = 
    new StringBuilder("SELECT customer FROM Customer as customer INNER JOIN customer.profile as profile where 1 = 1")
if (statusCodes != null) {
    hql.append(" and profile.status IN :statusCodes");
}
if (orgIds != null) {
    hql.append(" and profile.orgId IN :orgIds");
}

当然，您还必须为查询设置参数，前提是它们不为空。