Spring Data JPA系列JpaSpecificationExecutor用法详解

什么是 JpaSpecificationExecutor

JpaSpecificationExecutor 是 Spring Data JPA 提供的一个接口，它提供了使用 JPA Criteria API 进行查询、分页、排序等操作的方法。在 Repository 接口中继承 JpaSpecificationExecutor 后，就可以使用其中的方法进行高级查询。

如何使用 JpaSpecificationExecutor 进行高级查询

Step 1：创建 Specification

Specification 是一个接口，用于定义查询条件。我们需要在实现类中实现 toPredicate 方法，在其中使用 CriteriaBuilder 和 CriteriaQuery 构建查询条件。下面是一个简单的例子：

public class UserSpecification implements Specification<User> {

    @Override
    public Predicate toPredicate(Root<User> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
        List<Predicate> predicates = new ArrayList<>();

        // 添加查询条件
        if (StringUtils.isNotBlank(name)) {
            predicates.add(cb.like(root.get("name"), "%" + name + "%"));
        }

        if (age != null) {
            predicates.add(cb.equal(root.get("age"), age));
        }

        return cb.and(predicates.toArray(new Predicate[predicates.size()]));
    }
}

在上面的例子中，我们定义了一个 UserSpecification 类，实现了 JpaSpecificationExecutor 接口。在 toPredicate 方法中，我们使用 Criteria API 来表示查询条件。在本例中，我们定义了两个查询条件：name 和 age。

Step 2：调用 JpaSpecificationExecutor 方法

在 Repository 接口中继承 JpaSpecificationExecutor 接口后，就可以使用其中的方法进行高级查询。例如，我们可以使用 findAll 方法来查询：

public interface UserRepository extends JpaRepository<User, Long>, JpaSpecificationExecutor<User> {

}

例如，我们要查询年龄为 18 的用户：

UserSpecification spec = new UserSpecification();
spec.setAge(18);

List<User> users = userRepository.findAll(spec);

或者，我们要查询名字中带有“Tom”的用户：

UserSpecification spec = new UserSpecification();
spec.setName("Tom");

List<User> users = userRepository.findAll(spec);

JpaSpecificationExecutor 方法详解

以下是 JpaSpecificationExecutor 接口的常用方法：

1. findAll(Specification spec)

查询符合条件的结果集，返回类型为 List。

2. findOne(Specification spec)

查询符合条件的单个结果，返回类型为 Optional。

3. count(Specification spec)

查询符合条件的结果总数。

4. exists(Specification spec)

判断是否存在符合条件的记录，返回类型为 boolean。

示例说明

示例 1：多条件查询

我们有一个 User 实体类，包含 name 和 age 两个属性。现在要查询名字为“Tom”且年龄为 18 的用户。

我们需要定义一个 UserSpecification 类，实现 toPredicate 方法：

public class UserSpecification implements Specification<User> {

    @Override
    public Predicate toPredicate(Root<User> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
        List<Predicate> predicates = new ArrayList<>();

        // 添加查询条件
        predicates.add(cb.equal(root.get("name"), "Tom"));
        predicates.add(cb.equal(root.get("age"), 18));

        return cb.and(predicates.toArray(new Predicate[predicates.size()]));
    }
}

然后，我们在 UserRepository 接口中继承 JpaSpecificationExecutor，就可以使用 findAll 方法查询符合条件的用户：

List<User> users = userRepository.findAll(new UserSpecification());

示例 2：分页查询

我们有一个 User 实体类，包含 name 和 age 两个属性。现在要查询名字为“Tom”的用户，并分页返回结果。

我们需要定义一个 UserSpecification 类，实现 toPredicate 方法：

public class UserSpecification implements Specification<User> {

    private String name;

    public UserSpecification(String name) {
        this.name = name;
    }

    @Override
    public Predicate toPredicate(Root<User> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
        List<Predicate> predicates = new ArrayList<>();

        // 添加查询条件
        if (StringUtils.isNotBlank(name)) {
            predicates.add(cb.like(root.get("name"), "%" + name + "%"));
        }

        return cb.and(predicates.toArray(new Predicate[predicates.size()]));
    }
}

然后，我们在 UserRepository 接口中继承 JpaSpecificationExecutor，就可以使用 findAll 方法进行分页查询：

int page = 0;
int size = 10;
String name = "Tom";

PageRequest pageRequest = PageRequest.of(page, size);
Page<User> users = userRepository.findAll(new UserSpecification(name), pageRequest);