写在前面:刷完Spring Data JPA的课后,发现Specification动态查询还挺有意思的,还应用到了规约设计模式,在此记录下学习过程和见解。
目录
一、应用场景
二、源码解析
三、规约模式
四、实际应用
1. 简介
有时我们在查询某个实体的时候,给定的条件是不固定的,这时就需要动态构建相应的查询语句,在Spring Data JPA中可以通过JpaSpecificationExecutor接口查询。相比JPQL,其优势是类型安全,更加的面向对象。
Specification是一个设计模式,常常用于企业级应用开发中,其主要目的是将业务规则从业务逻辑中分离出来。在数据查询方面,Specification可以定义复杂的查询,使其更易于重用和测试。
2. 优缺点
优点:
- 动态查询:Specification允许你在运行时构建查询。你可以基于用户的输入或程序的状态动态地选择查询的条件、排序或分组。
- 复用:你可以定义一组基本的Specification,然后在不同的查询中重用它们。这使得你的代码更加简洁,也更易于测试和维护。
- 组合:你可以通过逻辑运算符(如AND和OR)来组合Specification。这使得你可以轻松地构建复杂的查询,而无需编写复杂的SQL语句。
缺点:
- 学习曲线:对于新手来说,理解和使用Specification可能有一定的难度。你需要对JPA Criteria API有一定的了解,而这个API本身也相当复杂。
- 性能:Specification是基于JPA Criteria API的,而这个API生成的SQL语句可能并不是最优的。如果你需要执行一些特别复杂或需要高性能的查询,直接编写SQL可能会更好。
- 灵活性:虽然Specification提供了大量的功能,但它仍然有一些限制。例如,它不支持JOIN ON子句,也不支持某些数据库特有的功能。
3.mybatis或者mybatisPlus和Specification动态查询比较(对标)
MyBatis或MyBatis Plus并没有直接对应于Spring Data JPA中的Specification动态查询的功能,但是,通过其强大的动态SQL功能,可以实现类似的效果。在MyBatis中,可以使用
Specification接口是Spring Data JPA库中的一部分。这个接口定义了一个toPredicate方法,该方法接收一个Root、CriteriaQuery和CriteriaBuilder,并返回一个Predicate。Predicate是JPA Criteria API中的一个接口,用于定义查询的条件。
在Spring Data JPA中,这个接口主要被用于JpaSpecificationExecutor接口,这个接口定义了一些用于执行Specification查询的方法,如findAll(Specification
spec)。 JpaSpecificationExecutor接口的实现在SimpleJpaRepository类中。例如,findAll(Specification
spec)方法的实现如下:
@Override public ListfindAll(@Nullable Specification spec) { TypedQuery query = getQuery(spec, Sort.unsorted()); return query.getResultList(); }
在这个方法中,首先调用了getQuery方法来创建一个TypedQuery,然后执行这个查询并返回结果。
getQuery方法的实现如下:
protected TypedQuerygetQuery(@Nullable Specification spec, Sort sort) { CriteriaBuilder builder = entityManager.getCriteriaBuilder(); CriteriaQuery query = builder.createQuery(getDomainClass()); Root root = applySpecificationToCriteria(spec, query); query.select(root); if (sort.isSorted()) { query.orderBy(toOrders(sort, root, builder)); } return applyRepositoryMethodMetadata(entityManager.createQuery(query)); }
在这个方法中,首先创建了一个CriteriaBuilder和CriteriaQuery,然后调用了applySpecificationToCriteria方法来应用Specification到CriteriaQuery上,然后选择查询的结果,如果有排序的需求,就添加排序条件,最后创建并返回TypedQuery。
applySpecificationToCriteria方法的实现如下:
private RootapplySpecificationToCriteria(@Nullable Specification spec, CriteriaQuery> query) { Root root = query.from(getDomainClass()); if (spec == null) { return root; } CriteriaBuilder builder = entityManager.getCriteriaBuilder(); Predicate predicate = spec.toPredicate(root, query, builder); if (predicate != null) { query.where(predicate); } return root; }
在这个方法中,首先创建了一个Root,然后如果有Specification的话,就调用toPredicate方法来创建一个Predicate,然后添加这个Predicate到CriteriaQuery的where条件中。
这就是Spring Data JPA中Specification动态查询的基本实现。在实际的应用中,我们只需要实现Specification接口,并提供一个toPredicate方法来定义我们的查询规则,Spring Data JPA就会自动地为我们执行查询。
规约模式(Specification Pattern)是一种特殊的设计模式,最早由Eric Evans在他的《领域驱动设计》一书中提出。规约模式的主要思想是将业务规则从业务对象中分离出来,这样就可以将这些规则独立地重用和组合。一个规约(Specification)是一个独立的业务规则,它通常会实现一个方法(在Java中通常是isSatisfiedBy),该方法接收一个业务对象,然后检查这个对象是否满足规约的条件。
例如,假设我们有一个Customer类,我们需要检查一个客户是否满足“是VIP客户”和“注册超过一年”的规则。首先,我们可以定义一个IsVip规约和一个IsRegisteredForMoreThanOneYear规约:
public class IsVip implements Specification{ @Override public boolean isSatisfiedBy(Customer customer) { return customer.isVip(); } } public class IsRegisteredForMoreThanOneYear implements Specification { @Override public boolean isSatisfiedBy(Customer customer) { return customer.getRegisteredDate().isBefore(LocalDate.now().minusYears(1)); } }
然后,我们可以将这两个规约组合起来,检查一个客户是否满足这两个条件:
Specificationspec = new IsVip().and(new IsRegisteredForMoreThanOneYear()); boolean isSatisfied = spec.isSatisfiedBy(customer);
我们还可以使用or方法来组合规约,检查一个客户是否满足这两个条件中的任意一个:
Specificationspec = new IsVip().or(new IsRegisteredForMoreThanOneYear()); boolean isSatisfied = spec.isSatisfiedBy(customer);
在这个例子中,我们将每个业务规则封装为一个单独的规约,然后使用and和or方法将这些规约组合起来。这样做的好处是我们可以将复杂的业务规则分解为多个简单的规约,这些规约可以独立地重用和测试。同时,我们也可以在运行时动态地组合规约,从而实现动态的业务规则。
单个条件查询
/** * 根据条件,查询单个对象 * */ @Test public void testSpec() { //匿名内部类 /** * 自定义查询条件 * 1.实现Specification接口(提供泛型:查询的对象类型) * 2.实现toPredicate方法(构造查询条件) * 3.需要借助方法参数中的两个参数( * root:获取需要查询的对象属性 * CriteriaBuilder:构造查询条件的,内部封装了很多的查询条件(模糊匹配,精准匹配) * ) * 案例:根据客户名称查询,查询客户名为传智播客的客户 * 查询条件 * 1.查询方式 * cb对象 * 2.比较的属性名称 * root对象 * */ Specificationspec = new Specification () { @Override public Predicate toPredicate(Root root, CriteriaQuery> query, CriteriaBuilder cb) { //1.获取比较的属性 Path
多条件查询
/** * 多条件查询 * 案例:根据客户名(传智播客)和客户所属行业查询(it教育) * */ @Test public void testSpec1() { /** * root:获取属性 * 客户名 * 所属行业 * cb:构造查询 * 1.构造客户名的精准匹配查询 * 2.构造所属行业的精准匹配查询 * 3.将以上两个查询联系起来 */ Specificationspec = new Specification () { @Override public Predicate toPredicate(Root root, CriteriaQuery> query, CriteriaBuilder cb) { Path
模糊查询
/** * 案例:完成根据客户名称的模糊匹配,返回客户列表 * 客户名称以 ’传智播客‘ 开头 * * equal :直接的到path对象(属性),然后进行比较即可 * gt,lt,ge,le,like : 得到path对象,根据path指定比较的参数类型,再去进行比较 * 指定参数类型:path.as(类型的字节码对象) */ @Test public void testSpec3() { //构造查询条件 Specificationspec = new Specification () { @Override public Predicate toPredicate(Root root, CriteriaQuery> query, CriteriaBuilder cb) { //查询属性:客户名 Path custName = root.get("custName"); //查询方式:模糊匹配 Predicate like = cb.like(custName.as(String.class), "传智播客%"); return like; } }; // List list = customerDao.findAll(spec); // for (Customer customer : list) { // System.out.println(customer); // } //添加排序 //创建排序对象,需要调用构造方法实例化sort对象 //第一个参数:排序的顺序(倒序,正序) // Sort.Direction.DESC:倒序 // Sort.Direction.ASC : 升序 //第二个参数:排序的属性名称 Sort sort = new Sort(Sort.Direction.DESC,"custId"); List list = customerDao.findAll(spec, sort); for (Customer customer : list) { System.out.println(customer); } }
分页查询
/** * 分页查询 * Specification: 查询条件 * Pageable:分页参数 * 分页参数:查询的页码,每页查询的条数 * findAll(Specification,Pageable):带有条件的分页 * findAll(Pageable):没有条件的分页 * 返回:Page(springDataJpa为我们封装好的pageBean对象,数据列表,共条数) */ @Test public void testSpec4() { Specification spec = null; //PageRequest对象是Pageable接口的实现类 /** * 创建PageRequest的过程中,需要调用他的构造方法传入两个参数 * 第一个参数:当前查询的页数(从0开始) * 第二个参数:每页查询的数量 */ Pageable pageable = new PageRequest(0,2); //分页查询 Pagepage = customerDao.findAll(null, pageable); System.out.println(page.getContent()); //得到数据集合列表 System.out.println(page.getTotalElements());//得到总条数 System.out.println(page.getTotalPages());//得到总页数 }
参考:黑马程序员Spring Data JPA 9小时视频
不负时光,坚持学习,变得更强!!!!