示例一
Spring Data JPA之JpaSpecificationExecutor复杂动态查询实例
示例二
Spring Data Jpa同样提供了类似Hibernated 的Criteria的查询方式，要使用这种方式只要继承JpaSpecificationExecutor,该接口提供了如下一些方法
T findOne(Specification<T> var1);
List<T> findAll(Specification<T> var1);
Page<T> findAll(Specification<T> var1, Pageable var2);
List<T> findAll(Specification<T> var1, Sort var2);
long count(Specification<T> var1);
该接口通过Specification来定义查询条件，很多朋友可能使用的方式都是基于SQL的，对这种方式可能不太习惯，在下一讲中将会对Specification进行一下封装，让查询操作变得更加的简单方便。这里先简单看一下示例。
@Test
public void testSpecificaiton() {
List<Student> stus = studentSpecificationRepository.findAll(new Specification<Student>() {
@Override
public Predicate toPredicate(Root<Student> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) {
//root.get("address")表示获取address这个字段名称,like表示执行like查询,%zt%表示值
Predicate p1 = criteriaBuilder.like(root.get("address"), "%zt%");
Predicate p2 = criteriaBuilder.greaterThan(root.get("id"),3);
//将两个查询条件联合起来之后返回Predicate对象
return criteriaBuilder.and(p1,p2);
}
});
Assert.assertEquals(2,stus.size());
Assert.assertEquals("oo",stus.get(0).getName());
}
使用Specification的要点就是CriteriaBuilder，通过这个对象来创建条件，之后返回一个Predicate对象。这个对象中就有了相应的查询需求，我们同样可以定义多个Specification，之后通过Specifications对象将其连接起来。以下是一个非常典型的应用
@Test
public void testSpecificaiton2() {
//第一个Specification定义了两个or的组合
Specification<Student> s1 = new Specification<Student>() {
@Override
public Predicate toPredicate(Root<Student> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) {
Predicate p1 = criteriaBuilder.equal(root.get("id"),"2");
Predicate p2 = criteriaBuilder.equal(root.get("id"),"3");
return criteriaBuilder.or(p1,p2);
}
};
//第二个Specification定义了两个or的组合
Specification<Student> s2 = new Specification<Student>() {
@Override
public Predicate toPredicate(Root<Student> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) {
Predicate p1 = criteriaBuilder.like(root.get("address"),"zt%");
Predicate p2 = criteriaBuilder.like(root.get("name"),"foo%");
return criteriaBuilder.or(p1,p2);
}
};
//通过Specifications将两个Specification连接起来，第一个条件加where，第二个是and
List<Student> stus = studentSpecificationRepository.findAll(Specifications.where(s1).and(s2));
Assert.assertEquals(1,stus.size());
Assert.assertEquals(3,stus.get(0).getId());
}
这个代码生成的sql是select * from t_student where (id=2 or id=3) and (address like 'zt%' and name like 'foo%')，这其实是一个非常典型的应用，但是相信大家已经发现这个操作实在是太繁杂了，所以个人认为Specification这个方案其实就是为了让我们对其进行封装，而不是直接使用的。
另外在toPredicate中还有一个CriteriaQuery的参数，这个对象提供了更多有用的查询，如分组之类的，可以使用该对象组成复杂的SQL语句来查询。
示例三
DAO接口继承JpaSpecificationExecutor<T>。
该接口允许基于JPA标准的API规范的运行。
开始构建动态where子句要实现Specification<T>接口的
Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder cb);方法，该接口是领域驱动设计意义上的规范：
private Specification<ExportSubsidyPersonnel> getWhereClause(final long userId, final String agency, final Date startDate, final Date endDate,
final String jobLevel, final String certificateGrade, final String remark) {
return new Specification<ExportSubsidyPersonnel>() {
@Override
public Predicate toPredicate(Root<ExportSubsidyPersonnel> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) {
Predicate predicate = criteriaBuilder.conjunction();
predicate.getExpressions().add(
criteriaBuilder.and(root.<UserInfo>get("userInfo").in(userId))
);
if (!StringUtils.isEmpty(agency)) {
predicate.getExpressions().add(
criteriaBuilder.and(root.<String>get("agency").in(agency)));
}
predicate.getExpressions().add(
criteriaBuilder.between(root.<Date>get("time"), startDate, endDate)
);
if (!StringUtils.isEmpty(jobLevel)) {
predicate.getExpressions().add(
criteriaBuilder.and(root.<String>get("jobLevel").in(jobLevel)));
}
if (!StringUtils.isEmpty(certificateGrade)) {
predicate.getExpressions().add(
criteriaBuilder.and(root.<String>get("certificateGrade").in(certificateGrade)));
}
if (!Const.UNLIMITED.equals(remark)) {
predicate.getExpressions().add(
criteriaBuilder.and(root.<String>get("remark").in(remark)));
}
return predicate;
}
};
}
CriteriaBuilder接口用来构建Predicate，而Predicate接口用来连接子句，每次添加到predicate之前都要进行参数非空判断。
其中Root<X>接口代表where子句的引用类型，如，
root.<UserInfo>get("userInfo").in(userId),其中是ExportSubsidyPersonnel持有userInfo的属性，并且注解如下：
@ManyToOne(cascade = CascadeType.MERGE)
@JoinColumn(name = "userId")
private UserInfo userInfo;
in方法参数的userId即注解时的列名。相当于sql语法的in关键字。
CriteriaBuilder接口其中还包括equal等常用方法，对应sql语法的=。该接口用于构建标准查询，复合选择，表达式，谓词，排序。
最后将getWhereClause方法作为参数传入到被调用的方法中即可，如：
Page<ExportSubsidyPersonnel> exportSubsidyPersonnelPage = exportSubsidyPersonnelService
.querySubsidyPersonnelDetailed(getWhereClause(userId, agency, startDate, endDate, jobLevel,
certificateGrade, remark));
输出语句形如：
select
count(exportsubs0_.id) as col_0_0_
from
export_subsidy_personnel exportsubs0_
where
(
exportsubs0_.training_agency in (
?
)
)
and (
exportsubs0_.time between ? and ?
)
and (
exportsubs0_.remark in (
?
)
)
转：
网友评论