检查 Spring 数据 JPA 查询中的 List 参数是否为空

Question

我有一个 Spring Boot 应用程序并使用 Spring Data JPA 来查询 MySQL 数据库。

我需要得到一个用一些参数过滤的课程列表。

我通常使用语法param IS NULL or (/*do something with param*/)，这样如果参数为空，它就会忽略它。

使用简单的数据类型我没有问题，但是当涉及到对象列表时，我不知道如何检查 NULL 值。如何检查以下查询中的?3 参数是否为NULL？

@Query("SELECT DISTINCT c FROM Course c\n" +
       "WHERE c.courseDate < CURRENT_TIME\n" +
       "AND (?1 IS NULL OR (c.id NOT IN (3, 4, 5)))\n" +
       "AND (?2 IS NULL OR (c.title LIKE ?2 OR c.description LIKE ?2))\n" +
       "AND ((?3) IS NULL OR (c.category IN ?3)) ")
List<Course> getCoursesFiltered(Long courseId, String filter, List<Category> categories);

错误是：

无法提取结果集； SQL [不适用]；嵌套异常是 org.hibernate.exception.DataException: could not extract ResultSet[SQL: 1241, 21000]

在堆栈跟踪中我可以看到：

原因：java.sql.SQLException：操作数应包含 1 列

如果我的列表包含 3 个元素，则确实生成的查询将是 ... AND ((?3, ?4, ?5) IS NULL OR (c.category IN (?3, ?4, ?5)))。但是IS NULL 不能应用于多个元素（如果我的列表只包含一个元素，则查询可以正常工作）。

我尝试了size(?3) < 1、length(?3) < 1、(?3) IS EMPTY 等，但仍然没有运气。

Answer 1

Spring 使我们能够使用对象模型作为带有@Param 注释的查询参数。在动态查询中检查列表类型参数是否为空的另一种解决方法是在我们的搜索模型上放置一个 getter 方法。

假设您有一个名为 PersonSearchFilter 的搜索过滤器模型，您希望通过该模型搜索 Person 模型；

@Query(value = "SELECT a FROM Person a WHERE 1=1 "
            + "and (:#{#searchFilter.name} is null or a.name like %:#{#searchFilter.name}%) "
            + "and (:#{#searchFilter.statusListSize} = 0 or a.status in (:#{#searchFilter.statusList})) ")
Optional<List<Person>> findByFilter(@Param("searchFilter") PersonSearchFilter searchFilter);


public class PersonSearchFilter {

    private String name;
    private List<String> statusList;
    
    public String getName() {
        return name;
    }

    public List<String> getStatusList() {
        return statusList;
    }

    public int getStatusListSize() {
        return CollectionUtils.isEmpty(statusList) ? 0:statusList.size();
    }

}

Answer 2

好吧，我在半夜醒来后想到了一件事：

@Query("SELECT DISTINCT c FROM Course c\n" +
       "WHERE c.courseDate < CURRENT_TIME\n" +
       "AND (?1 IS NULL OR (c.id NOT IN (3, 4, 5)))\n" +
       "AND (?2 IS NULL OR (c.title LIKE ?2 OR c.description LIKE ?2))\n" +
       "AND (COALESCE(?3) IS NULL OR (c.category IN ?3)) ")
List<Course> getCoursesFiltered(Long courseId, String filter, List<Category> categories);

解决方案是在IS NULL 之外使用COALESCE，这样它就可以处理多个值。这样，如果列表至少包含一个非空值，则第二个表达式 ((c.category IN ?3)) 将完成过滤工作。

下次我至少要等一整晚才问问题:)

Answer 3

这并没有严格回答您的问题，但一个简单的解决方案是在您的存储库中使用另一种方法，该方法在调用查询之前检查您的列表并将它们默认为具有虚拟值的列表。比如：

@Query("SELECT DISTINCT c FROM Course c\n" +
       "WHERE c.courseDate < CURRENT_TIME\n" +
       "AND (?1 IS NULL OR (c.id NOT IN (3, 4, 5)))\n" +
       "AND (?2 IS NULL OR (c.title LIKE ?2 OR c.description LIKE ?2))\n" +
       "AND ('DUMMYVALUE' IN ?3 OR (c.category IN ?3)) ")
// make this private to keep it safe
private List<Course> getCoursesFiltered(Long courseId, String filter, List<Category> categories);

// public helper method to put a dummy value in the list that you can check for
public List<Course> getNullableCoursesFiltered(Long courseId, String filter, List<Category> categories) {
    if(categories == null) {
        categories = Arrays.asList("DUMMYVALUE");
    }
    return getCoursesFiltered(courseId, filter, categories);
}