首页 > 资讯 > 后端开发 > Python >Spring Data JPA系列JpaSpecificationExecutor用法详解

737

分享到

Spring Data JPA系列JpaSpecificationExecutor用法详解

2024-04-02 19:04:59 737人浏览泡泡鱼

Python 官方文档：入门教程 => 点击学习

摘要

目录1、JpaSpecificationExecutor用法2、JpaSpecificationExecutor语法详解2.1 Specification 接口2.2 Root<

1、JpaSpecificationExecutor用法

我们来创建实体类，第一步：创建User类和UserAddress类

// User类
@Data
@Entity
@NoArgsConstructor
@AllArgsConstructor
@Builder
@ToString(exclude = "address")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Integer id;
    private String name;
    private String email;
    @Enumerated(value = EnumType.STRING)
    private SexEnum sex;
    private Integer age;
    private LocalDateTime createTime;
    private LocalDateTime updateTime;
    @OneToMany(mappedBy = "user",fetch = FetchType.EAGER)
    private List<UserAddress> address;
}
// Address类
@Entity
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@ToString(exclude = "user")
public class UserAddress {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;
    private String address;
    @ManyToOne(cascade = CascadeType.ALL)
    private User user;
}
// 性别枚举类
public enum SexEnum {
    BOY,
    GIRL
}

第二步：创建UserRepo ，我们继承JpaSpecificationExecutor接口

public interface UserRepo extends JpaSpecificationExecutor<User> {
}

第三步：测试，构造查询条件

name模糊查询
sex精准查询
age范围查询
address的in查询

    @Test
    public void test02(){
        User userQuery = User.builder()
                .name("jack")
                .email("123456@126.com")
                .sex(SexEnum.BOY)
                .age(20)
                .address(Lists.newArrayList(UserAddress.builder().address("shanghai").build()))
                .build();
        List<User> userList = userRepo.findAll(new Specification<User>() {
            @Override
            public Predicate toPredicate(Root<User> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
                List<Predicate> predicateList = new ArrayList<>();
                // name模糊查询
                if(StringUtils.isNotBlank(userQuery.getName())) {
                    predicateList.add(cb.like(root.get("name"),userQuery.getName()));
                }
                // sex精准查询
                if(userQuery.getSex()!=null) {
                    predicateList.add(cb.equal(root.get("sex"),userQuery.getSex()));
                }
                // age范围查询
                if(userQuery.getAge()!=null){
                    predicateList.add(cb.greaterThanOrEqualTo(root.get("age"),userQuery.getAge()));
                }
                // 关联查询
                if(!ObjectUtils.isEmpty(userQuery.getAddress())) {
                    predicateList.add(cb.in(root.join("address").get("address")).value(userQuery.getAddress().stream().map(a->a.getAddress()).collect(Collectors.toList())));
                }
                return query.where(predicateList.toArray(new Predicate[predicateList.size()])).getRestriction();
            }
        });
        System.out.println(userList);
    }

sql执行结果如下：

select user0_.id as id1_4_, user0_.age as age2_4_, user0_.create_time as create_t3_4_, user0_.email as email4_4_, user0_.name as name5_4_, user0_.sex as sex6_4_, user0_.update_time as update_t7_4_ from user user0_ inner join user_address address1_ on user0_.id=address1_.user_id where (user0_.name like ?) and user0_.sex=? and user0_.age>=20 and (address1_.address in (?))

2、JpaSpecificationExecutor语法详解

先看源码：

public interface JpaSpecificationExecutor<T> {
   Optional<T> findOne(@Nullable Specification<T> spec);
   List<T> findAll(@Nullable Specification<T> spec);
   Page<T> findAll(@Nullable Specification<T> spec, Pageable pageable);
   List<T> findAll(@Nullable Specification<T> spec, Sort sort);
   long count(@Nullable Specification<T> spec);
   boolean exists(Specification<T> spec);
}

findOne(@Nullable Specification spec)：根据Specification 条件查询单个对象
findAll(@Nullable Specification spec)：根据Specification 条件, 查询List结果
findAll(@Nullable Specification spec, Pageable pageable)：根据Specification 条件, 分页查询
findAll(@Nullable Specification spec, Sort sort)：根据Specification 条件，带排序的查询结果
count(@Nullable Specification spec)：根据Specification 条件，查询数量
exists(Specification spec)：根据Specification 条件，查询是否存在

2.1 Specification 接口

我们主要来看一下需要实现的方法：toPredicate(xx,xx,xx)

@Nullable
Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder criteriaBuilder);

调试代码

我们可以分别看到Root的实现类是RootImpl，CriteriaQuery的实现类是CriteriaQueryImpl,CriteriaBuilder的实现类是CriteriaBuilderImpl。这三个实现类都是由Hibernate实现，也就是说JpaSepcificationExecutor封装了原本需要我们直接操作Hibernate中Criteria的api。

2.2 Root< User >root

解释：这个root就相当于查询和操作的实体对象的根，我们就可以通过Path get(xx)的方法，来获取我们想要操作的字段。

<Y> Path<Y> get(String attributeName);

例如：获取User实体类中的name字段

predicateList.add(cb.like(root.get("name"),userQuery.getName()));

2.3 CriteriaQuery<?> query

这是一个Specific的顶层查询对象，它包含着查询的各个部分，比如select、from、where、group by 、Order by、distinct等。提供查询Root的方法,我们来看一下源码:

我们可以在上面的案例中看到query的用法：

return query.where(predicateList.toArray(new Predicate[predicateList.size()])).getRestriction();

我们可以再加一个groupBy的例子看看，如下所示：可以链式拼接

return query.where(predicateList.toArray(new Predicate[predicateList.size()])).groupBy(root.get("age")).getRestriction();

执行的SQL如下所示：

2.4 CriteriaBuilder cb

CriteriaBuilder是用来构建CritiaQuery的构建对象，其实就相当于条件或者条件组合，并以Predicate的形式返回，基本提供了所有常用的方法。

通过源码我们可以看到CriteriaBuilder 提供了and、any等用来查询条件的组合；还提供了between、equal、exist等用来做查询条件的查询。

例如：equal

predicateList.add(cb.equal(root.get("sex"),userQuery.getSex()));

例如：like

predicateList.add(cb.like(root.get("name"),userQuery.getName()));

例如：greaterThanEqualTo

predicateList.add(cb.greaterThanOrEqualTo(root.get("age"),userQuery.getAge()));

解释: 我们利用equal、like、greaterThanEqualTo 可以返回Predicate，而Predicate又可以组合起来，就构成了复杂的查询条件，完全满足日常开发使用。

以上就是spring Data JPA系列JpaSpecificationExecutor用法详解的详细内容，更多关于Spring Data JPA JpaSpecificationExecutor的资料请关注编程网其它相关文章！

您可能感兴趣的文档:

点击免费下载>>软考高级考试备考技巧/历年真题/备考精华资料

--结束END--

本文标题: Spring Data JPA系列JpaSpecificationExecutor用法详解

本文链接: https://www.lsjlt.com/news/168616.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑，方便收藏和打印～

下载Word文档

去做题

猜你喜欢

Spring Data JPA系列JpaSpecificationExecutor用法详解

目录1、JpaSpecificationExecutor用法2、JpaSpecificationExecutor语法详解2.1 Specification 接口2.2 Root<...

99+

2022-11-13
Spring Data JPA系列QueryByExampleExecutor使用详解

目录1、QueryByExampleExecutor用法1.1 介绍1.2 QueryByExampleExecutor接口1.3 QueryByExampleExecutor实践1...

99+

2022-11-13
详解Spring Data JPA系列之投影（Projection）的用法

本文介绍了Spring Data JPA系列之投影（Projection）的用法，分享给大家在JPA的查询中，有一个不方便的地方，@Query注解，如果查询直接是Select C from Customer c...

99+

2023-05-31

spring data jpa
Spring Data JPA 注解Entity关联关系使用详解

目录1、OneToOne关联关系1.1 解读OneToOne源码1.2 mappedBy 注意事项1.3 CascadeType 用法1.4 orphanRemoval属性用法1.5...

99+

2022-11-13
Spring Data JPA注解Entity使用示例详解

目录1、JPA协议中关于Entity的相关规定需要注意的是：2、常用注解2.1 JPA支持的注解2.2 常用注解3、联合主键3.1 @IdClass3.2 @Embeddable与@...

99+

2022-11-13
详解Spring Data JPA使用@Query注解（Using @Query）

经过几天的折腾，终于到了学习一个重量级的查询方式上，使用@Query注解，使用注解有两种方式，一种是JPQL的SQL语言方式，一种是原生SQL的语言，略有区别，后者我们更熟悉一些。话不多说，看代码。1、在CustomerRepository...

99+

2023-05-31

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

我们在使用SpringData JPA框架时，进行条件查询，如果是固定条件的查询，我们可以使用符合框架规则的自定义方法以及@Query注解实现。如果是查询条件是动态的，框架也提供了查询接口。JpaSpecificationExecutor...

99+

2023-05-31

spring data jpa
Spring Data JPA 在 @Query 中使用投影的方法示例详解

Spring Data JPA 在 @Query 中使用投影的方法关于投影的基本使用可以参考这篇文章：https://www.baeldung.com/spring-data-jp...

99+

2022-11-13
Spring Data Jpa 中原生查询 REGEXP 的使用详解

目录Spring Data Jpa原生查询 REGEXP 的使用spring data jpa 原生查询（查一个json中的某一字段）Spring Data Jpa原生查询 REGE...

99+

2022-11-12
SpringBoot系列之MongoDB Aggregations用法详解

目录1、前言2、什么是聚合？3、环境搭建4、数据initialize5、例子应用参考资料1、前言在上一章的学习中，我们知道了Spring Data MongoDB的基本用法，但是对...

99+

2022-11-13
【Spring框架全系列】方法注解@Bean的使用

📬📬哈喽，大家好，我是小浪。上篇博客我们介绍了五大类注解的使用方法，以及如何解决Spring使用五大类注解生成bean-Name的问题；那么，谈到如何更简单的读取和存储对象，这里我们还需要介绍另外一个"方...

99+

2023-09-27

java spring boot spring
C#多线程系列之async和await用法详解

目录async和awaitasyncawait从以往知识推导创建异步任务创建异步任务并返回Task异步改同步说说 await Task说说 async Task<TR...

99+

2022-11-13
Go基础教程系列之WaitGroup用法实例详解

正常情况下，新激活的goroutine（协程）的结束过程是不可控制的，唯一可以保证终止goroutine（协程）的行为是main goroutine（协程）的终止。也就是说，我们并不...

99+

2022-11-13
JavaScript系列从入门到精通系列第二十篇：使用工厂方法创建JavaScript对象，JavaScript构造函数详解，JavaScript类概念的介绍

文章目录一：使用工厂方法创建对象 1：原始写法 2：工厂方式 3：结果验证二：构造函数 1：什么是构造函数 2：构造函数和普通函数的区别 3：构造函数的执行流程三：类 1：什么是类 2：如何检查一个对象是否是个类的实例 3：Obje...

99+

2023-10-20

javascript udp 开发语言