JPA（3）Specifications查询

一 Specifications动态查询

有时我们在查询某个实体的时候，给定的条件是不固定的，这时就需要动态构建相应的查询语句，在Spring Data JPA中可以通过JpaSpecificationExecutor接口查询。相比JPQL,其优势是类型安全,更加的面向对象。

import java.util.List;

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.domain.Specification;

/**
 *	JpaSpecificationExecutor中定义的方法
 **/
 public interface JpaSpecificationExecutor<T> {
   	//根据条件查询一个对象
 	T findOne(Specification<T> spec);	
   	//根据条件查询集合
 	List<T> findAll(Specification<T> spec);
   	//根据条件分页查询
 	Page<T> findAll(Specification<T> spec, Pageable pageable);
   	//排序查询查询
 	List<T> findAll(Specification<T> spec, Sort sort);
   	//统计查询
 	long count(Specification<T> spec);
}

Specification

对于JpaSpecificationExecutor，这个接口基本是围绕着Specification接口来定义的。我们可以简单的理解为，Specification构造的就是查询条件。
Specification接口中只定义了如下一个方法

    //构造查询条件
    /**
    *	root	：Root接口，代表查询的根对象，可以通过root获取实体中的属性
    *	query	：代表一个顶层查询对象，用来自定义查询
    *	cb		：用来构建查询，此对象里有很多条件方法
    **/
    public Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder cb);

用法

findOne

	public void testSpec() {
		//匿名内部类
		/**
		 * 自定义查询条件
		 *      1.实现Specification接口（提供泛型：查询的对象类型）
		 *      2.实现toPredicate方法（构造查询条件）
		 *      3.需要借助方法参数中的两个参数（
		 *          root：获取需要查询的对象属性
		 *          CriteriaBuilder：构造查询条件的，内部封装了很多的查询条件（模糊匹配，精准匹配）
		 *       ）
		 *  案例：根据客户名称查询，查询客户名为传智播客的客户
		 *          查询条件
		 *              1.查询方式
		 *                  cb对象
		 *              2.比较的属性名称
		 *                  root对象
		 *
		 */
		Specification<Customer> spec = new Specification<Customer>() {
			@Override
			public Predicate toPredicate(Root<Customer> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
				//1.获取比较的属性
				Path<Object> custId = root.get("custId");//查询的式属性名，不是表的字段名
				//2.构造查询条件  ：    select * from cst_customer where cust_id = 3
				/**
				 * 第一个参数：需要比较的属性（path对象）
				 * 第二个参数：当前需要比较的取值
				 */
				Predicate predicate = cb.equal(custId, 3);//进行精准的匹配  （比较的属性，比较的属性的取值）
				return predicate;
			}
		};
		Optional<Customer> customer = customerDao.findOne(spec);
		System.out.println(customer.get());
	}

多条件拼接

	public void testSpec1() {
		/**
		 *  root:获取属性
		 *      客户名
		 *      所属行业
		 *  cb：构造查询
		 *      1.构造客户名的精准匹配查询
		 *      2.构造所属行业的精准匹配查询
		 *      3.将以上两个查询联系起来
		 */
		Specification<Customer> spec = new Specification<Customer>() {
			@Override
			public Predicate toPredicate(Root<Customer> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
				Path<Object> custName = root.get("custName");//客户名
				Path<Object> custAddress = root.get("custAddress");//地址

				//构造查询
				//1.构造客户名的精准匹配查询
				Predicate p1 = cb.equal(custName, "黑马程序员");//第一个参数，path（属性），第二个参数，属性的取值
				//2..构造所属行业的精准匹配查询
				Predicate p2 = cb.equal(custAddress, "hangz");
				//3.将多个查询条件组合到一起：组合（满足条件一并且满足条件二：与关系，满足条件一或满足条件二即可：或关系）
				Predicate and = cb.and(p1, p2);//以与的形式拼接多个查询条件
				// cb.or();//以或的形式拼接多个查询条件
				return and;
			}
		};
		Optional<Customer> customer = customerDao.findOne(spec);
		System.out.println(customer);
	}

模糊匹配

• equal ：直接的到path对象（属性），然后进行比较即可
• gt，lt,ge,le,like : 得到path对象，根据path指定比较的参数类型，再去进行比较
  指定参数类型：path.as(类型的字节码对象)

	public void testSpec3() {
		//构造查询条件
		Specification<Customer> spec = new Specification<Customer>() {
			@Override
			public Predicate toPredicate(Root<Customer> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
				//查询属性：客户名
				Path<Object> custName = root.get("custName");
				//查询方式：模糊匹配
				Predicate like = cb.like(custName.as(String.class), "d%");
				return like;
			}
		};

		List<Customer> list = customerDao.findAll(spec);
		for (Customer customer : list) {
			System.out.println(customer);
		}
	}

排序

	public void testSpec3() {
		//构造查询条件
		Specification<Customer> spec = new Specification<Customer>() {
			@Override
			public Predicate toPredicate(Root<Customer> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
				//查询属性：客户名
				Path<Object> custName = root.get("custName");
				//查询方式：模糊匹配
				Predicate like = cb.like(custName.as(String.class), "d%");
				return like;
			}
		};

		Sort sort = new Sort(Sort.Direction.DESC,"custId");
		List<Customer> list = customerDao.findAll(spec, sort);
		for (Customer customer : list) {
			System.out.println(customer);
		}
	}

分页查询

创建PageRequest的过程中，需要调用他的构造方法传入两个参数

• 第一个参数：当前查询的页数（从0开始）
• 第二个参数：每页查询的数量

	public void testSpec4() {

		Specification<Customer> spec = new Specification<Customer>() {
			@Override
			public Predicate toPredicate(Root<Customer> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
				//查询属性：客户名
				Path<Object> custName = root.get("custName");
				//查询方式：模糊匹配
				Predicate like = cb.like(custName.as(String.class), "d%");
				return like;
			}
		};
		//PageRequest对象是Pageable接口的实现类

		Pageable pageable = PageRequest.of(0,1);;
		//分页查询
		Page<Customer> page = customerDao.findAll(spec, pageable);
		System.out.println(page.getContent()); //得到数据集合列表
		System.out.println(page.getTotalElements());//得到总条数
		System.out.println(page.getTotalPages());//得到总页数
	}

方法对应关系