Spring JPA Repository动态查询

时间:2015-05-25 04:02:22

标签: java spring jpa spring-data spring-data-jpa

目前我一直在使用以下Spring JPA Repository基础自定义查询,它工作正常,

 @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 + "))";
}

3 个答案:

答案 0 :(得分:10)

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

使用方法创建界面:

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
    }
}

在现有的Repository界面中扩展新界面:

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

最后,在其他地方调用该方法:

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

查询实施

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

您正在连接的word必须是valid JPQL identifier,即:后跟java identifier start,可选后跟java identifier part。这意味着,如果您的CSV包含foo bar,baz,则会尝试使用foo 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();
}

答案 1 :(得分:3)

我自己一直在寻找解决方案: &#34; Custom&#34;的命名存储库接口和实现非常严格(如How to add custom method to 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;
    }
}

&#34;原作&#34;存储库

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

您现在可以使用&#34;原创&#34;存储库使用新的自定义方法

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

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

答案 2 :(得分:2)

Spring Data JPA可以使用“规范”创建自定义和动态查询: Spring Data - Specifications

首先,扩展了JPARepositoryCRUDRepository的接口也应该实现JpaSpecificationExecutor<...>,这就是您所需要的。 您的存储库现在有了一个接受findAll对象的新方法Specification<...>,您可以通过覆盖方法toPredicate(...)使用Beerbajay用来创建条件查询的方法,在那里您可以自由构建(几乎)您想要的任何查询:

Specification<...> spec = new Specification<...>() {
   	@Override
   	public Predicate toPredicate(Root<...> entity, CriteriaQuery<?> query, CriteriaBuilder cb) {			    
   	    List<Predicate> conditions = buildManyPredicates(cb, entity);
   	    return cb.and(conditions.toArray(new Predicate[conditions.size()]));
   	}
 };

repository.findAll(spec, PageRequest.of(0, 10));

这解决了Spring Data试图解析您在自定义界面中添加的方法的问题(因为没有自定义界面)