【自我提升】Spring Data JPA之Specification动态查询详解

news2024/11/25 8:19:01

写在前面:刷完Spring Data JPA的课后,发现Specification动态查询还挺有意思的,还应用到了规约设计模式,在此记录下学习过程和见解。

目录

一、应用场景

二、源码解析

三、规约模式

四、实际应用


一、应用场景

1. 简介

        有时我们在查询某个实体的时候,给定的条件是不固定的,这时就需要动态构建相应的查询语句,在Spring Data JPA中可以通过JpaSpecificationExecutor接口查询。相比JPQL,其优势是类型安全,更加的面向对象。

        Specification是一个设计模式,常常用于企业级应用开发中,其主要目的是将业务规则从业务逻辑中分离出来。在数据查询方面,Specification可以定义复杂的查询,使其更易于重用和测试。

2. 优缺点

  

优点:

  1. 动态查询:Specification允许你在运行时构建查询。你可以基于用户的输入或程序的状态动态地选择查询的条件、排序或分组。
  2. 复用:你可以定义一组基本的Specification,然后在不同的查询中重用它们。这使得你的代码更加简洁,也更易于测试和维护。
  3. 组合:你可以通过逻辑运算符(如AND和OR)来组合Specification。这使得你可以轻松地构建复杂的查询,而无需编写复杂的SQL语句。

缺点:

  1. 学习曲线:对于新手来说,理解和使用Specification可能有一定的难度。你需要对JPA Criteria API有一定的了解,而这个API本身也相当复杂。
  2. 性能:Specification是基于JPA Criteria API的,而这个API生成的SQL语句可能并不是最优的。如果你需要执行一些特别复杂或需要高性能的查询,直接编写SQL可能会更好。
  3. 灵活性:虽然Specification提供了大量的功能,但它仍然有一些限制。例如,它不支持JOIN ON子句,也不支持某些数据库特有的功能。

3.mybatis或者mybatisPlus和Specification动态查询比较(对标)

        MyBatis或MyBatis Plus并没有直接对应于Spring Data JPA中的Specification动态查询的功能,但是,通过其强大的动态SQL功能,可以实现类似的效果。在MyBatis中,可以使用 <if> 标签来动态的构建SQL查询。这允许你根据传入参数的值动态地添加或移除查询的一部分。

二、源码解析

        Specification接口是Spring Data JPA库中的一部分。这个接口定义了一个toPredicate方法,该方法接收一个RootCriteriaQueryCriteriaBuilder,并返回一个PredicatePredicate是JPA Criteria API中的一个接口,用于定义查询的条件。

  • root:查询的根对象(查询的任何属性都可以从根对象中获取)
  • CriteriaQuery:顶层查询对象,自定义查询方式(了解:一般不用)
  • CriteriaBuilder:查询的构造器,封装了很多的查询条件

        在Spring Data JPA中,这个接口主要被用于JpaSpecificationExecutor接口,这个接口定义了一些用于执行Specification查询的方法,如findAll(Specification<T> spec)

   JpaSpecificationExecutor接口的实现在SimpleJpaRepository类中。例如,findAll(Specification<T> spec)方法的实现如下:

@Override
public List<T> findAll(@Nullable Specification<T> spec) {
	TypedQuery<T> query = getQuery(spec, Sort.unsorted());
	return query.getResultList();
}

在这个方法中,首先调用了getQuery方法来创建一个TypedQuery,然后执行这个查询并返回结果。

getQuery方法的实现如下:

protected TypedQuery<T> getQuery(@Nullable Specification<T> spec, Sort sort) {
	CriteriaBuilder builder = entityManager.getCriteriaBuilder();
	CriteriaQuery<T> query = builder.createQuery(getDomainClass());

	Root<T> root = applySpecificationToCriteria(spec, query);
	query.select(root);

	if (sort.isSorted()) {
		query.orderBy(toOrders(sort, root, builder));
	}

	return applyRepositoryMethodMetadata(entityManager.createQuery(query));
}

在这个方法中,首先创建了一个CriteriaBuilderCriteriaQuery,然后调用了applySpecificationToCriteria方法来应用Specification到CriteriaQuery上,然后选择查询的结果,如果有排序的需求,就添加排序条件,最后创建并返回TypedQuery

applySpecificationToCriteria方法的实现如下:

private Root<T> applySpecificationToCriteria(@Nullable Specification<T> spec, CriteriaQuery<?> query) {
	Root<T> 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,然后添加这个PredicateCriteriaQuery的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<Customer> {
    @Override
    public boolean isSatisfiedBy(Customer customer) {
        return customer.isVip();
    }
}

public class IsRegisteredForMoreThanOneYear implements Specification<Customer> {
    @Override
    public boolean isSatisfiedBy(Customer customer) {
        return customer.getRegisteredDate().isBefore(LocalDate.now().minusYears(1));
    }
}

然后,我们可以将这两个规约组合起来,检查一个客户是否满足这两个条件:

Specification<Customer> spec = new IsVip().and(new IsRegisteredForMoreThanOneYear());
boolean isSatisfied = spec.isSatisfiedBy(customer);

我们还可以使用or方法来组合规约,检查一个客户是否满足这两个条件中的任意一个:

Specification<Customer> spec = new IsVip().or(new IsRegisteredForMoreThanOneYear());
boolean isSatisfied = spec.isSatisfiedBy(customer);

        在这个例子中,我们将每个业务规则封装为一个单独的规约,然后使用andor方法将这些规约组合起来。这样做的好处是我们可以将复杂的业务规则分解为多个简单的规约,这些规约可以独立地重用和测试。同时,我们也可以在运行时动态地组合规约,从而实现动态的业务规则。

四、实际应用

单个条件查询

    /**
     * 根据条件,查询单个对象
     *
     */
    @Test
    public void testSpec() {
        //匿名内部类
        /**
         * 自定义查询条件
         *      1.实现Specification接口(提供泛型:查询的对象类型)
         *      2.实现toPredicate方法(构造查询条件)
         *      3.需要借助方法参数中的两个参数(
         *          root:获取需要查询的对象属性
         *          CriteriaBuilder:构造查询条件的,内部封装了很多的查询条件(模糊匹配,精准匹配)
         *       )
         *  案例:根据客户名称查询,查询客户名为传智播客的客户
         *          查询条件
         *              1.查询方式
         *                  cb对象
         *              2.比较的属性名称
         *                  root对象
         *
         */
        Specification<Customer> spec = new Specification<Customer>() {
            @Override
            public Predicate toPredicate(Root<Customer> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
                //1.获取比较的属性
                Path<Object> custName = root.get("custId");
                //2.构造查询条件  :    select * from cst_customer where cust_name = '传智播客'
                /**
                 * 第一个参数:需要比较的属性(path对象)
                 * 第二个参数:当前需要比较的取值
                 */
                Predicate predicate = cb.equal(custName, "传智播客");//进行精准的匹配  (比较的属性,比较的属性的取值)
                return predicate;
            }
        };
        Customer customer = customerDao.findOne(spec);
        System.out.println(customer);
    }

多条件查询

    /**
     * 多条件查询
     *      案例:根据客户名(传智播客)和客户所属行业查询(it教育)
     *
     */
    @Test
    public void testSpec1() {
        /**
         *  root:获取属性
         *      客户名
         *      所属行业
         *  cb:构造查询
         *      1.构造客户名的精准匹配查询
         *      2.构造所属行业的精准匹配查询
         *      3.将以上两个查询联系起来
         */
        Specification<Customer> spec = new Specification<Customer>() {
            @Override
            public Predicate toPredicate(Root<Customer> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
                Path<Object> custName = root.get("custName");//客户名
                Path<Object> custIndustry = root.get("custIndustry");//所属行业

                //构造查询
                //1.构造客户名的精准匹配查询
                Predicate p1 = cb.equal(custName, "传智播客");//第一个参数,path(属性),第二个参数,属性的取值
                //2..构造所属行业的精准匹配查询
                Predicate p2 = cb.equal(custIndustry, "it教育");
                //3.将多个查询条件组合到一起:组合(满足条件一并且满足条件二:与关系,满足条件一或满足条件二即可:或关系)
                Predicate and = cb.and(p1, p2);//以与的形式拼接多个查询条件
                // cb.or();//以或的形式拼接多个查询条件
                return and;
            }
        };
        Customer customer = customerDao.findOne(spec);
        System.out.println(customer);
    }

模糊查询

/**
     * 案例:完成根据客户名称的模糊匹配,返回客户列表
     *      客户名称以 ’传智播客‘ 开头
     *
     * equal :直接的到path对象(属性),然后进行比较即可
     * gt,lt,ge,le,like : 得到path对象,根据path指定比较的参数类型,再去进行比较
     *      指定参数类型:path.as(类型的字节码对象)
     */
    @Test
    public void testSpec3() {
        //构造查询条件
        Specification<Customer> spec = new Specification<Customer>() {
            @Override
            public Predicate toPredicate(Root<Customer> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
                //查询属性:客户名
                Path<Object> custName = root.get("custName");
                //查询方式:模糊匹配
                Predicate like = cb.like(custName.as(String.class), "传智播客%");
                return like;
            }
        };
//        List<Customer> 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<Customer> 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);
        //分页查询
        Page<Customer> page = customerDao.findAll(null, pageable);
        System.out.println(page.getContent()); //得到数据集合列表
        System.out.println(page.getTotalElements());//得到总条数
        System.out.println(page.getTotalPages());//得到总页数
    }

参考:黑马程序员Spring Data JPA 9小时视频

不负时光,坚持学习,变得更强!!!!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/746886.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

Linux中安装Tomcat

前提条件&#xff1a; 虚拟机中已经提前安装好jdk1.8。 安装步骤&#xff1a; 1.下载安装包 首先去Apache官网下载&#xff08;Apache Tomcat - Apache Tomcat 9 Software Downloads&#xff09; 2.上传到 linux 中&#xff0c;我这里上传的目录是&#xff1a; /opt 3. 解压…

element-plus坑总结

reactive和ref对比 // 定义变量 import { reactive } from vue; const person reactive({name: "John",age: 25, });// 赋值修改 person.name "Tom"; person.age 26;// 使用变量 <div>{{ person.name }}</div> <button click"perso…

layui介绍以及登录功能的实现

一. layui简介 1.1 layui介绍 Layui 是一套开源免费的 Web UI 组件库&#xff0c;采用自身轻量级模块化规范&#xff0c;遵循原生态的 HTML/CSS/JavaScript 开发模式&#xff0c;非常适合网页界面的快速构建。Layui 区别于一众主流的前端框架&#xff0c;它更多是面向于后端开…

3、Linux-进程管理类

进程管理类 进程是正在执行的一个程序或命令&#xff0c;每一个进程都是一个运行的实体&#xff0c;都有自己的地址空间&#xff0c;并占用一定的系统资源。 7.10.1 ps 查看当前系统进程状态 ps:process status 进程状态 1&#xff09;基本语法 ps aux | grep xxx &#xff08…

Python 导入引用其他文件的函数(持续更新)

文章目录 构造初始化文件结构&#xff0c;以此为例。【1】导入同目录且同级下其他文件的函数&#xff08;c.py文件导入d.py文件的函数&#xff09;&#xff08;1&#xff09;只引入d.py文件&#xff08;2&#xff09;直接引入函数&#xff08;3&#xff09;引入全部函数 【2】导…

docker服务启动过程分析

How docker.service start&#xff1f; just by ref 我们先了解docker的各个核心组件的介绍 runc&#xff1a;runc实现了容器的底层功能&#xff0c;例如创建、运行等。runc通过调用内核接口为容器创建和管理cgroup、namespace等Linux内核功能&#xff0c;来实现容器的核心特…

Spring5学习笔记--详细一文通

Spring5学习笔记--详细一文通 1 Spring 框架概述1.1 Spring 5 简述1.2 Spring5入门案例1.2.1 Spring5下载1.1.2 打开 idea 工具&#xff0c;创建普通 Java 工程1.2.3 导入 Spring5 相关 jar 包1.2.4 创建普通类&#xff0c;在这个类创建普通方法1.2.5 创建 Spring 配置文件&…

同时多项目多个node版本-比nvm好用的volta

一、node版本问题场景&#xff1a; 1、服务器上跑的多个node项目需要不同的node版本&#xff0c;且没条件上docker。 2、开发环境中多个项目需要node版本不同&#xff0c;且同时不止是一个项目在开发中&#xff0c;用了nvm进行node版本管理和切换&#xff0c;但是太麻烦。 二…

如何开发一款软件?

创建软件的步骤 1. 头脑风暴 创意生成是制作应用程序的第一步。考虑这个问题的最好方法是将你的应用想象成解决问题。 你自己的经历可以成为灵感的重要来源。试着想想你面临的问题&#xff0c;无论是软件和计算机&#xff0c;还是你的一般生活。很有可能&#xff0c;你面临的…

3DVR全景乡村振兴创新展示,助力数字化乡村建设

导语&#xff1a; 随着社会进步和科技发展&#xff0c;3D虚拟现实&#xff08;VR&#xff09;全景技术在乡村振兴领域展现出巨大的潜力和创新空间。通过结合3DVR全景技术和乡村振兴理念&#xff0c;我们可以为乡村带来全新的展示方式和体验&#xff0c;推动乡村振兴的进程。本…

MiniGPT4 在RTX-3090 Ubuntu服务器部署步骤详解

主要参考知乎帖子&#xff1a; MiniGPT-4 本地部署 RTX 3090 - 知乎 MiniGPT-4部署比麻烦&#xff0c;首先需要获取LLaMA权重&#xff0c;并结合Vicuna的bitwise XOR增量文件完成Vicuna模型权重生成&#xff0c;最后准备好预训练的MiniGPT-4进行模型部署。为了便于理解&#…

Photoshop简单案例(10)——利用PS修改证件照尺寸为1寸(或其他)

目录 一、项目介绍二、基本流程三、效果演示 一、项目介绍 本文介绍一下利用Photoshop修改证件照尺寸为1寸的方法。 二、基本流程 首先打开新建一个空白画布&#xff0c;设置画布宽度和高度分别为25mm和35mm&#xff0c;分辨率为300&#xff0c;背景颜色与证件照背景相同&am…

基于GPT4All的大型语言模型设计生态系统

GPT4All 一套专为强大、定制的大型语言模型设计的生态系统,能够在消费级CPU上本地运行。在GPT4All中,所使用的模型是一个3GB至8GB的文件,读者可以自行下载该文件,并将其插入到GPT4All的开源生态系统软件中。这一软件生态系统由Nomic AI提供支持并进行维护,其目的是确保系统…

04-树 (数据结构和算法)

4.1 树的基本概念 树&#xff08;Tree&#xff09;是n&#xff08;n>0&#xff09;个结点的有限集&#xff0c;它或为空树&#xff08;n 0&#xff09;&#xff1b;或为非空树&#xff0c;对于非空树 T&#xff1a; 有且只有一个称之为根的结点 除根节点以外的其他结点可…

随手笔记——关于齐次变换矩阵的理解

随手笔记——关于齐次变换矩阵的理解 说明符号坐标系表示&#xff08;coordinate representation&#xff09;坐标系变换&#xff08;coordinate transformation&#xff09;点的操作&#xff08;point operator&#xff09; 说明 齐次变换矩阵的几种解释&#xff0c; 主要从坐…

十大排序算法【原理】【步骤】【动图】【C++实现】

十大排序算法 排序算法可以分为内部排序和外部排序&#xff0c;内部排序是数据记录在内存中进行排序&#xff0c;而外部排序是因排序的数据很大&#xff0c;一次不能容纳全部的排序记录&#xff0c;在排序过程中需要访问外存。常见的内部排序算法有&#xff1a;插入排序、希尔…

【面试题32】include和require的区别及用法

文章目录 一、前言二 、include和require的区别三、include和require的用法介绍3.1 include的用法3.2 require的用法及示例 四、include和require的用法示例4.1 包含文件4.2 包含文件并将结果赋值给变量4.3 动态包含文件4.4 使用绝对路径包含文件4.5 包含文件失败处理4.6 包含文…

MATLAB 的函数计算与作图

基本初等函数的输入系统运算与操作函数的输入函数值的计算1. 数值计算方式2. 符号计算方式2.1 函数&#xff1a;sym2.2 函数&#xff1a;syms 函数的作图1. 一般函数 yf(x) 的作图&#xff08;二维&#xff09;作图基本形式作多重线作图的线型和颜色作图的网格和标记、图例、字…

React Dva项目创建Model,并演示数据管理与函数调用

本文的话 我们讲一下定义Model 也就是Dva中redux的部分 我们打开一个刚创建的Dva项目 看到 src下的models 下 就是Model部分 这里 他给我们了一个案例 如果用 react-redux 管理 模块多了之后会看着比较乱 或 很麻烦 但是 大家会发现 在Model中 他将这些都放在一起了 只需要创建…

css属性

1、形状相关的 宽、高、边线&#xff08;粗细、线样式、颜色&#xff09;、弧度、前景色、背景色、透明度 圆角矩形&#xff1a; 随着radius的增加&#xff0c;角会越来越圆&#xff0c;当设置为高的一半&#xff08;高200是直径&#xff09;时&#xff0c;就会成圆角 宽高都是…