详解Spring Data JPA动态条件查询的写法

下面就来详细讲解下“详解Spring Data JPA动态条件查询的写法”的完整攻略。

1. 什么是动态条件查询

动态条件查询是指根据不同条件进行查询，也就是查询条件是可变的，不固定的。这种查询方法在实际应用中非常常见，比如根据不同的查询条件查询订单信息，查询用户信息等等。在 Spring Data JPA 中，我们可以使用 Specification 来实现动态条件查询。

2. Spring Data JPA 动态条件查询的写法

2.1. 使用 Specification 进行查询

在 Spring Data JPA 中，我们使用 Specification 接口来定义查询条件，其中 Specification 接口中的 toPredicate 方法可以将查询条件转换为 Predicate 类型，这样我们就可以将其作为参数传递给 JpaSpecificationExecutor 中的方法进行查询。下面是一个示例：

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

在 UserRepository 接口中，我们继承了 JpaSpecificationExecutor 接口，并将实体类型指定为 User，这样就可以使用 Specification 接口进行查询了。

2.2. 使用 JpaSpecificationExecutor 接口进行查询

在 Spring Data JPA 中，我们可以使用 JpaSpecificationExecutor 接口中的方法进行动态条件查询，下面是一个示例：

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

    List<User> findAll(Specification<User> spec);

}

在 UserRepository 接口中，我们定义了一个 findAll 方法，其中的参数 spec 就是我们的查询条件，这个查询条件可以由用户动态设置。

2.3. 实现动态查询条件

在 Spring Data JPA 中，我们可以使用 CriteriaQuery 和 CriteriaBuilder 接口来实现动态查询条件，下面是一个查询用户信息的示例：

public static Specification<User> getUserSpec(User user) {
    return (root, query, cb) -> {
        List<Predicate> predicates = new ArrayList<>();

        if (StringUtils.isNotBlank(user.getUsername())) {
            predicates.add(cb.like(root.get("username"), "%" + user.getUsername() + "%"));
        }
        if (user.getAge() != null) {
            predicates.add(cb.equal(root.get("age"), user.getAge()));
        }
        if (StringUtils.isNotBlank(user.getGender())) {
            predicates.add(cb.equal(root.get("gender"), user.getGender()));
        }

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

在这个示例中，我们定义了一个名为 getUserSpec 的方法，该方法返回值为 Specification<User>，这个方法接受一个 User 类型的参数，用于指定查询条件。在方法内部，我们使用 CriteriaBuilder 创建 Predicate 对象，并将它们添加到一个 ArrayList 中，最后返回一个 and 条件的 Predicate 对象。

这个示例中使用的查询条件包括用户名、年龄和性别，如果用户不传递某些参数，那么这些查询条件就会被忽略。

2.4. 实现动态排序条件

除了实现动态查询条件，我们还可以实现动态排序条件。在 Spring Data JPA 中，我们可以使用 Sort 和 Order 类来实现动态排序条件。下面是一个示例：

public static Sort getSort(String sortBy, String sortOrder) {
    List<Order> orders = new ArrayList<>();

    if (StringUtils.isBlank(sortBy) || StringUtils.isBlank(sortOrder)) {
        return Sort.unsorted();
    }

    String[] sortBys = sortBy.split(",");
    String[] sortOrders = sortOrder.split(",");

    for (int i = 0; i < sortBys.length && i < sortOrders.length; i++) {
        String fieldName = sortBys[i].trim();
        String orderStr = sortOrders[i].trim();
        Order order = "asc".equalsIgnoreCase(orderStr) ? Order.asc(fieldName) : Order.desc(fieldName);
        orders.add(order);
    }

    return orders.size() > 0 ? Sort.by(orders) : Sort.unsorted();
}

在这个示例中，我们定义了一个名为 getSort 的方法，该方法返回值为 Sort，这个方法接受两个参数 sortBy 和 sortOrder，用于指定排序字段和排序顺序。在方法内部，我们使用 Order 类创建排序对象，并将它们添加到一个 ArrayList 中，最后返回一个 Sort 对象。如果用户不传递排序字段和排序顺序，那么返回一个未排序的 Sort 对象。

3. 示例

以上是关于 Spring Data JPA 动态条件查询的完整攻略，请根据上面的步骤实现自己的动态条件查询。下面是两个基于用户信息的查询示例：

3.1. 查询指定名字（模糊查询）和性别的用户

User user = new User();
user.setUsername("张三");
user.setGender("男");

List<User> userList = userRepository.findAll(getUserSpec(user));

在这个示例中，我们创建了一个名为 user 的 User 对象，然后设置了他的用户名和性别，接着调用了 userRepository.findAll(getUserSpec(user)) 方法进行查询，这个方法会自动将查询条件转换为 Predicate 对象，然后返回符合条件的所有用户信息。

3.2. 查询年龄在指定年龄段内的用户（并按照年龄从小到大排序）

Specification<User> ageSpec = (root, query, cb) -> {
    query.orderBy(cb.asc(root.get("age")));
    return cb.between(root.get("age"), 18, 30);
};
List<User> userList = userRepository.findAll(ageSpec);

在这个示例中，我们创建了一个名为 ageSpec 的 Specification<User> 对象，这个对象用于查询年龄在 18 到 30 岁之间的用户信息，并按照年龄从小到大排序。接着调用了 userRepository.findAll(ageSpec) 方法进行查询，这个方法会自动将查询条件转换为 Predicate 对象和排序对象，然后返回符合条件的所有用户信息。