使用Spring Data JPA的Specification构建数据库查询

Spring Data JPA最为优秀的特性就是能够经过自定义方法名称生成查询来轻松建立查询SQL。Spring Data JPA提供了一个Repository编程模型，最简单的方式就是经过扩展JpaRepository，咱们得到了一堆通用的CRUD方法，例如save，findAll，delete等。而且使用这些关键字能够构建不少的数据库单表查询接口：

public interface CustomerRepository extends JpaRepository<Customer, Long> {
  Customer findByEmailAddress(String emailAddress);
  List<Customer> findByLastname(String lastname, Sort sort);
  Page<Customer> findByFirstname(String firstname, Pageable pageable);
}

• findByEmailAddress生成的SQL是根据email_address字段查询Customer表的数据
• findByLastname根据lastname字段查询Customer表的数据
• findByFirstname根据firstname字段查询Customer表的数据

以上全部的查询都不用咱们手写SQL，查询生成器自动帮咱们工做，对于开发人员来讲只须要记住一些关键字，如：findBy、delete等等。可是，有时咱们须要建立复杂一点的查询，就没法利用查询生成器。可使用本节介绍的Specification来完成。

笔者仍是更愿意手写SQL来完成复杂查询，可是有的时候偶尔使用一下Specification来完成任务，也仍是深得我心。不排斥、不盲从。没有最好的方法，只有最合适的方法！

1、使用Criteria API构建复杂的查询

是的，除了specification，咱们还可使用Criteria API构建复杂的查询，可是没有specification好用。咱们来看一下需求：在客户生日当天，咱们但愿向全部长期客户(2年以上)发送优惠券。咱们如何该检索Customer？

咱们有两个谓词查询条件：

• 生日
• 长期客户-2年以上的客户。

下面是使用JPA 2.0 Criteria API的实现方式：

LocalDate today = new LocalDate();

CriteriaBuilder builder = em.getCriteriaBuilder();
CriteriaQuery<Customer> query = builder.createQuery(Customer.class);
Root<Customer> root = query.from(Customer.class);

Predicate hasBirthday = builder.equal(root.get(Customer_.birthday), today);
Predicate isLongTermCustomer = builder.lessThan(root.get(Customer_.createdAt), today.minusYears(2); 

query.where(builder.and(hasBirthday, isLongTermCustomer));
em.createQuery(query.select(root)).getResultList();

• 第一行LocalDate用于比较客户的生日和今天的日期。em是javax.persistence.EntityManager
• 下三行包含用于查询Customer实体的JPA基础结构实例的样板代码。
• 而后，在接下来的两行中，咱们将构建谓词查询条件
• 在最后两行中，where用于链接两个谓词查询条件，最后一个用于执行查询。

此代码的主要问题在于，谓词查询条件不易于重用，您须要先设置 CriteriaBuilder, CriteriaQuery，和Root。另外，代码的可读性也不好。

2、specification

为了可以定义可重用谓词条件，咱们引入了Specification接口。

public interface Specification<T> {
  Predicate toPredicate(Root<T> root, CriteriaQuery query, CriteriaBuilder cb);
}

结合Java 8的lambda表达式使用Specification接口时，代码变得很是简单

public CustomerSpecifications {
   //查询条件：生日为今天
  public static Specification<Customer> customerHasBirthday() {
    return (root, query, cb) ->{ 
        return cb.equal(root.get(Customer_.birthday), today);
    };
  }
  //查询条件：客户建立日期在两年之前
  public static Specification<Customer> isLongTermCustomer() {
    return (root, query, cb) ->{ 
        return cb.lessThan(root.get(Customer_.createdAt), new LocalDate.minusYears(2));
    };
  }
}

如今能够经过CustomerRepository执行如下操做：

customerRepository.findAll(hasBirthday());
customerRepository.findAll(isLongTermCustomer());

咱们建立了能够单独执行的可重用谓词查询条件，咱们能够结合使用这些单独的谓词来知足咱们的业务需求。咱们可使用 and(…)   和 or(…)链接specification。

customerRepository.findAll(where(customerHasBirthday()).and(isLongTermCustomer()));

与使用JPA Criteria API相比，它读起来很流利，提升了可读性并提供了更多的灵活性。

期待您的关注

• 向您推荐博主的系列文档：《手摸手教您学习SpringBoot系列-16章97节》
• 本文转载注明出处（必须带链接，不能只转文字）：字母哥博客。