具有可为空枚举的 Spring Data 查询答案

【问题标题】：Spring Data query with nullable Enum具有可为空枚举的 Spring Data 查询
【发布时间】：2014-09-10 07:58:23
【问题描述】：

我们有一个领域类

@Entity
public class Gallery implements Serializable {

    @Id
    @GeneratedValue
    private Long id;

    @Enumerated(EnumType.ORDINAL)
    private Status status;

    // more attributes and getters/setters
}

状态是一个枚举：

public enum Status {

    OPEN (0, "offen"),
    ACTIVE (1, "aktiv"),
    INACTIVE (2, "inaktiv");

    // attributes, constructor...
}

然后我们有一个带有查询的 Spring Data 存储库：

public interface GalleryRepository extends PagingAndSortingRepository<Gallery, Long> {

    @Query("SELECT g FROM Gallery g WHERE (:status IS NULL or g.status = :status)")
    public List<Gallery> findBySearchCriteria(@Param("status") Status status);
}

(:status IS NULL or g.status = :status) 的目的是在没有给出状态时我们想要所有数据，而在给出状态时只获取适当的数据。

当状态为空时，我们会从该查询中得到结果，但如果状态为例如，我们不会得到任何结果。 ACTIVE，尽管数据库中有 status=ACTIVE 的数据。

我们从查询中删除 :status IS NULL or，当状态为 ACTIVE 时我们会得到结果。查询看起来像

public interface GalleryRepository extends PagingAndSortingRepository<Gallery, Long> {

    @Query("SELECT g FROM Gallery g WHERE (g.status = :status)")
    public List<Gallery> findBySearchCriteria(@Param("status") Status status);
}

我让记录 SQL 和参数，当我手动运行 SQL（使用:status IS NULL or）时，我得到了预期的结果：

Hibernate: select gallery0_.id as id1_13_, gallery0_.institution_id as institut5_13_, gallery0_.internName as internNa2_13_, gallery0_.name as name3_13_, gallery0_.selectedShortId_id as selected6_13_, gallery0_.status as status4_13_ from Gallery gallery0_ where ? is null or gallery0_.status=?
2014-09-10 09:54:49,531 TRACE type.descriptor.sql.BasicBinder: binding parameter [1] as [VARBINARY] - ACTIVE
2014-09-10 09:54:49,531 TRACE type.descriptor.sql.BasicBinder: binding parameter [1] as [VARBINARY] - ACTIVE
2014-09-10 09:54:49,535 TRACE type.descriptor.sql.BasicBinder: binding parameter [2] as [VARBINARY] - ACTIVE
2014-09-10 09:54:49,535 TRACE type.descriptor.sql.BasicBinder: binding parameter [2] as [VARBINARY] - ACTIVE

SQL 是

select gallery0_.id as id1_13_, gallery0_.institution_id as institut5_13_, gallery0_.internName as internNa2_13_, gallery0_.name as name3_13_, gallery0_.selectedShortId_id as selected6_13_, gallery0_.status as status4_13_ 
from Gallery gallery0_ 
where 1 is null or gallery0_.status=1

当我们使用其他数据类型（例如字符串）时，构造（例如(:name IS NULL or g.name = :name) 会像预期的那样工作。

这个带有枚举的构造有什么问题吗？或者在 Spring Data/JPA 中不可能做到这一点？

我们有一个可能的解决方法是写入查询，一个有状态，一个没有。根据状态是否为空，我们将在存储库中调用适当的方法。

【问题讨论】：

标签： java hibernate jpa spring-data

【解决方案1】：

我在 spring 数据查询中遇到了与 Enum 参数非常相似的问题，并设法通过在查询中使用字符串来解决它（保持实体映射与 Enums 一样）：

public interface GalleryRepository extends PagingAndSortingRepository<Gallery, Long> {

@Query("SELECT g FROM Gallery g WHERE (:status IS NULL or g.status = :status)")
    public List<Gallery> findBySearchCriteria(@Param("status") String status);
}

【讨论】：

【解决方案2】：

您是否尝试过简单地使用方法名称创建查询？

public interface GalleryRepository extends JpaRepository<Gallery, Long> {
    public List<Gallery> findByStatus(Status status);
}

【讨论】：

这不起作用，因为当状态为空时，此方法会查找所有状态为空的画廊。但在这种情况下，我们想要所有画廊，无论它们具有何种状态。提示：在我们的系统中，查询更复杂，有更多可以设置或不设置的属性。所以查询似乎是合适的解决方案。

【解决方案3】：

你可以试试这个

public interface GalleryRepository extends PagingAndSortingRepository<Gallery, Long> {
    @Query(value = "SELECT g FROM Gallery g WHERE (CAST(:status AS string) IS NULL OR g.status = :status)")
    List<Gallery> findBySearchCriteria(@Param("status") Status status);
}

此方法也适用于日期。

【讨论】：