春季 JPA 存储库动态查询

java spring jpa spring-data spring-data-jpa

2022-09-01 16:04:52

目前我一直在使用以下春季JPA存储库基本自定义查询，它工作正常，

 @Query("SELECT usr FROM User usr  WHERE usr.configurable = TRUE "
              + "AND (" +
                        "lower(usr.name) like lower(:filterText) OR lower(usr.userType.classType.displayName) like lower(:filterText) OR lower(usr.userType.model) like lower(:filterText)"
              +      ")"
              + "")
  public List<User> findByFilterText(@Param("filterText") String filterText, Sort sort);

当筛选文本将是逗号分隔值时，我需要修改此查询。但按照以下方式，它将是一个动态查询，我该如何执行它。

我需要构建的动态查询，

String sql = "SELECT usr FROM User usr WHERE usr.configurable = TRUE";

for(String word : filterText.split(",")) {
                sql += " AND (lower(usr.name) like lower(:" + word + ") OR lower(usr.userType.classType.displayName) like lower(:" + word + ") OR lower(usr.userType.model) like lower(:" + word + "))";
}

答案 1

根据 JB Nizet 和 spring-data 文档，您应该使用自定义接口 + 存储库实现。

使用以下方法创建一个接口：

public interface MyEntityRepositoryCustom {
    List<User> findByFilterText(Set<String> words);
}

创建一个实现：

@Repository
public class MyEntityRepositoryImpl implements MyEntityRepositoryCustom {
    @PersistenceContext
    private EntityManager entityManager;

    public List<User> findByFilterText(Set<String> words) {
        // implementation below
    }
}

在现有存储库界面中扩展新界面：

public interface MyEntityRepository extends JpaRepository<MyEntity, Long>, MyEntityRepositoryCustom {
    // other query methods
}

最后，在其他地方调用该方法：

dao.findByFilterText(new HashSet<String>(Arrays.asList(filterText.split(","))));

查询实现

生成变量的方法，即通过将一些字符串连接到查询中是错误的。不要这样做。sql

要连接的标识符必须是有效的 JPQL 标识符，即后跟 java 标识符 start，后跟一些 java 标识符部分（可选）。这意味着，如果您的 CSV 包含，您将尝试用作标识符，并且会得到异常。word:foo bar,bazfoo bar

您可以改用 CriteriaBuilder 以安全的方式构造查询：

public List<User> findByFilterText(Set<String> words) {
    CriteriaBuilder cb = entityManager.getCriteriaBuilder();
    CriteriaQuery<User> q = cb.createQuery(User.class);
    Root<User> user = q.from(User.class);

    Path<String> namePath = user.get("name");
    Path<String> userTypeClassTypeDisplayName = 
                     user.get("userType").get("classType").get("displayName");
    Path<String> userTypeModel = user.get("userType").get("model");
    List<Predicate> predicates = new ArrayList<>();
    for(String word : words) {
        Expression<String> wordLiteral = cb.literal(word);
        predicates.add(
                cb.or(
                    cb.like(cb.lower(namePath), cb.lower(wordLiteral)),
                    cb.like(cb.lower(userTypeClassTypeDisplayName),
                            cb.lower(wordLiteral)),
                    cb.like(cb.lower(userTypeModel), cb.lower(wordLiteral))
                )
        );
    }
    q.select(doc).where(
            cb.and(predicates.toArray(new Predicate[predicates.size()]))
    );

    return entityManager.createQuery(q).getResultList();
}

答案 2

我自己一直在寻找解决方案：“自定义”存储库接口的命名和引入非常严格（如前所述如何向Spring Data JPA添加自定义方法)

所以，为了清楚起见，整个代码：（但@beerbajay是对的）

自定义方法接口

public interface MyEntityRepositoryCustom {
    List<MyEntity> findSpecial();
}

自定义方法实现

public class MyEntityRepositoryImpl implements MyEntityRepositoryCustom {
    @PersistenceContext
    private EntityManager em;

    //custom method implementation
    public List<Object> findSpecial() {
        List<Object> list = em.createNativeQuery("select name, value from T_MY_ENTITY").getResultList();
        return list;
    }
}

“原始”存储库

@Repository
public interface MyEntityRepository extends JpaRepository<MyEntity,Long>, MyEntityRepositoryCustom {
    //original methods here... do not redefine findSpecial()...
}

现在，您可以将“原始”存储库与新的自定义方法结合使用

@Service
public class MyService {
    @Autowired
    private DataRepository r;

    public void doStuff() {
        List<Object> list = r.findSpecial();
    }
}