Spring Boot新增Boolean字段后无需修改所有JPA派生查询实现过滤

我需要给现有JPA实体InventoryEntity新增Boolean类型字段isInactive（默认值为false），要求所有查询默认过滤掉isInactive = true的数据，但不想修改超过40个已有的JPA派生查询方法，该如何实现？

实体类现有定义：

@Entity
@Table(name = "bbser_inventory")
@Getter
@Setter
@NoArgsConstructor
public class InventoryEntity extends BaseEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "bbser_inventory_gen")
    @SequenceGenerator(name = "bbser_inventory_gen", sequenceName = "bbser_inventory_seq", allocationSize = 1)
    @Column(name = "inventory_id")
    private Long inventoryId;

    @Column(name = "unit_id")
    private String unitId;

    // 其他原有字段...
    
    @Column(name = "is_inactive")
    @ColumnDefault("false")
    private Boolean isInactive;
}

部分已有的派生查询方法示例：

// 示例查询方法
List<InventoryEntity> findByUnitId(String unitId);

List<InventoryEntity> findByUnitIdAndHospitalIdAndGroupId(String unitId, Integer hospitalId, Integer groupId);

List<InventoryEntity> findByUnitIdAndStatusAliasIn(String unitId, Collection<String> status);

List<InventoryEntity> findByStatusAlias(String statusAlias);
// 还有40个类似的派生查询...

方法一：使用@Where注解（最简便，推荐） #

直接在InventoryEntity类上添加JPA的@Where注解，指定全局过滤条件。所有针对该实体的派生查询、JPQL查询都会自动带上这个过滤条件，完全不需要修改现有查询方法。

修改后的实体类：

@Entity
@Table(name = "bbser_inventory")
@Getter
@Setter
@NoArgsConstructor
@Where(clause = "is_inactive = false") // 新增全局过滤注解
public class InventoryEntity extends BaseEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "bbser_inventory_gen")
    @SequenceGenerator(name = "bbser_inventory_gen", sequenceName = "bbser_inventory_seq", allocationSize = 1)
    @Column(name = "inventory_id")
    private Long inventoryId;

    @Column(name = "unit_id")
    private String unitId;

    // 其他原有字段...
    
    @Column(name = "is_inactive")
    @ColumnDefault("false")
    private Boolean isInactive;
}

优势：

• 零修改现有查询方法，40个派生查询自动继承过滤条件
• 实现简单，注解生效后立即全局过滤
• 性能无额外开销，过滤条件直接拼接到底层SQL中

特殊场景处理：

如果需要偶尔查询包含isInactive = true的数据，只需写自定义JPQL手动覆盖过滤条件即可：

@Query("SELECT i FROM InventoryEntity i WHERE i.isInactive = true AND i.unitId = :unitId")
List<InventoryEntity> findInactiveByUnitId(@Param("unitId") String unitId);

方法二：自定义查询拦截器（适合动态过滤场景） #

如果你的过滤逻辑需要动态调整（比如根据当前用户角色决定是否过滤），可以实现Spring Data JPA的QueryRewriter或者结合JpaSpecificationExecutor做全局拦截。但这个方法复杂度较高，如果你只是固定过滤isInactive = false，完全没必要用这个方案。

注意事项 #

1. 确保数据库中is_inactive字段的默认值设置为false，和实体类的@ColumnDefault("false")保持一致，避免新增数据时出现null值
2. @Where注解的clause使用的是数据库字段名（is_inactive），不是实体类属性名（isInactive），别写错

内容的提问来源于stack exchange，提问作者Inod Umayanga