动态查询

动态查询

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

import java.util.List;

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.domain.Specification;

/**
 *	JpaSpecificationExecutor中定义的方法
 **/
 public interface JpaSpecificationExecutor<T> {
    
    
   	//根据条件查询一个对象
 	T findOne(Specification<T> spec);	
   	//根据条件查询集合
 	List<T> findAll(Specification<T> spec);
   	//根据条件分页查询
            //查询全部，分页
		//pageable：分页参数
		//返回值：分页pageBean（page：是springdatajpa提供的）
 	Page<T> findAll(Specification<T> spec, Pageable pageable);
   	//排序查询查询
            //Sort：排序参数
 	List<T> findAll(Specification<T> spec, Sort sort);
   	//统计查询
 	long count(Specification<T> spec);
}

对于JpaSpecificationExecutor，这个接口基本是围绕着Specification接口来定义的。我们可以简单的理解为，Specification构造的就是查询条件。
Specification ：查询条件
自定义我们自己的Specification实现类
实现
//root：查询的根对象（查询的任何属性都可以从根对象中获取）
//CriteriaQuery：顶层查询对象，自定义查询方式（了解：一般不用）
//CriteriaBuilder：查询的构造器，封装了很多的查询条件
//封装查询条件
Predicate toPredicate(Root root, CriteriaQuery<?> query, CriteriaBuilder cb);
2 搭建测试环境
1.打开IDEA工具如图所示，点击Create New Project。

2.选择Maven工程和JDK的版本，并点击Next。如图所示：

3.填写项目名称和保存的地址，并点击Finish。如图所示：
4.导入相应的依赖jar包的代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.txw</groupId>
    <artifactId>jpa_day03</artifactId>
    <version>1.0-SNAPSHOT</version>
    <!--打包的方式-->
    <packaging>jar</packaging>
    <!--锁定版本号-->
    <properties>
        <spring.version>5.0.2.RELEASE</spring.version>
        <hibernate.version>5.0.7.Final</hibernate.version>
        <slf4j.version>1.6.6</slf4j.version>
        <log4j.version>1.2.12</log4j.version>
        <c3p0.version>0.9.1.2</c3p0.version>
        <mysql.version>5.1.6</mysql.version>
    </properties>
    <dependencies>
        <!-- junit单元测试 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <!-- spring beg -->
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.6.8</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${
    
    spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${
    
    spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>${
    
    spring.version}</version>
        </dependency>
        <!-- spring对orm框架的支持包-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-orm</artifactId>
            <version>${
    
    spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>${
    
    spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${
    
    spring.version}</version>
        </dependency>
        <!-- spring end -->
        <!-- hibernate beg -->
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-core</artifactId>
            <version>${
    
    hibernate.version}</version>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-entitymanager</artifactId>
            <version>${
    
    hibernate.version}</version>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>5.2.1.Final</version>
        </dependency>
        <!-- hibernate end -->
        <!-- c3p0 beg -->
        <dependency>
            <groupId>c3p0</groupId>
            <artifactId>c3p0</artifactId>
            <version>${
    
    c3p0.version}</version>
        </dependency>
        <!-- c3p0 end -->
        <!-- log end -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>${
    
    log4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${
    
    slf4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>${
    
    slf4j.version}</version>
        </dependency>
        <!-- log end -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${
    
    mysql.version}</version>
        </dependency>
        <!-- spring data jpa 的坐标-->
        <dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring-data-jpa</artifactId>
            <version>1.9.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>${
    
    spring.version}</version>
        </dependency>
        <!-- el beg 使用spring data jpa 必须引入 -->
        <dependency>
            <groupId>javax.el</groupId>
            <artifactId>javax.el-api</artifactId>
            <version>2.2.4</version>
        </dependency>
        <dependency>
            <groupId>org.glassfish.web</groupId>
            <artifactId>javax.el</artifactId>
            <version>2.2.4</version>
        </dependency>
        <!-- el end -->
        <!--导入lombok依赖jar包-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
        </dependency>
    </dependencies>
</project>

5.编写客户的实体类代码如下：

package com.txw.domain;

import lombok.Data;
import lombok.ToString;
import javax.persistence.*;
import java.io.Serializable;
/**
 * 客户的实体类
 *   配置映射关系
 *     1.实体类和表的映射关系
 *        @Entity:声明实体类
 *        @Table : 配置实体类和表的映射关系
 *            name : 配置数据库表的名称
 *     2.实体类中属性和表中字段的映射关系
 * @author: Adair
 */
@Entity
@Table(name = "cst_customer")
@Data   // 自动生成set和get方法
@ToString    // 重写toString方法
@SuppressWarnings("all")         // 注解警告信息
public class Customer implements Serializable {
    
    
    /**
     * @Id：声明主键的配置
     * @GeneratedValue:配置主键的生成策略
     *      strategy
     *          GenerationType.IDENTITY ：自增，mysql
     *                 * 底层数据库必须支持自动增长（底层数据库支持的自动增长方式，对id自增）
     *          GenerationType.SEQUENCE : 序列，oracle
     *                  * 底层数据库必须支持序列
     *          GenerationType.: jpa提供的一种机制，通过一张数据库表的形式帮助我们完成主键自增
     *          GenerationType.AUTO ： 由程序自动的帮助我们选择主键生成策略
     * @Column:配置属性和字段的映射关系
     *      name：数据库表中字段的名称
     */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "cust_id")
    private Long custId;          // 客户的主键
    @Column(name = "cust_name")
    private String custName;        // 客户名称
    @Column(name="cust_source")
    private String custSource;     // 客户来源
    @Column(name="cust_level")
    private String custLevel;        // 客户级别
    @Column(name="cust_industry")
    private String custIndustry;    // 客户所属行业
    @Column(name="cust_phone")
    private String custPhone;       // 客户的联系方式
    @Column(name="cust_address")
    private String custAddress;       // 客户地址
}

6.在resources目录创建applicationContext.xml的代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:jdbc="http://www.springframework.org/schema/jdbc" xmlns:tx="http://www.springframework.org/schema/tx"
       xmlns:jpa="http://www.springframework.org/schema/data/jpa" xmlns:task="http://www.springframework.org/schema/task"
       xsi:schemaLocation="
		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
		http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc.xsd
		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd
		http://www.springframework.org/schema/data/jpa
		http://www.springframework.org/schema/data/jpa/spring-jpa.xsd">
    <!--spring 和 spring data jpa的配置-->
    <!-- 1.创建entityManagerFactory对象交给spring容器管理-->
    <bean id="entityManagerFactoty" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <!--配置的扫描的包（实体类所在的包） -->
        <property name="packagesToScan" value="com.txw.domain" />
        <!-- jpa的实现厂家 -->
        <property name="persistenceProvider">
            <bean class="org.hibernate.jpa.HibernatePersistenceProvider"/>
        </property>
        <!--jpa的供应商适配器 -->
        <property name="jpaVendorAdapter">
            <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
                <!--配置是否自动创建数据库表 -->
                <property name="generateDdl" value="false" />
                <!--指定数据库类型 -->
                <property name="database" value="MYSQL" />
                <!--数据库方言：支持的特有语法 -->
                <property name="databasePlatform" value="org.hibernate.dialect.MySQLDialect" />
                <!--是否显示sql -->
                <property name="showSql" value="true" />
            </bean>
        </property>
        <!--jpa的方言 ：高级的特性 -->
        <property name="jpaDialect" >
            <bean class="org.springframework.orm.jpa.vendor.HibernateJpaDialect" />
        </property>
         </bean>
    <!--2.创建数据库连接池 -->
    <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
        <property name="user" value="root"></property>
        <property name="password" value="123456"></property>
        <property name="jdbcUrl" value="jdbc:mysql:///jpa?characterEncoding=utf-8" ></property>
        <property name="driverClass" value="com.mysql.jdbc.Driver"></property>
    </bean>
    <!--3.整合spring dataJpa-->
    <jpa:repositories base-package="com.txw.dao" transaction-manager-ref="transactionManager"
                      entity-manager-factory-ref="entityManagerFactoty" ></jpa:repositories>
    <!--4.配置事务管理器 -->
    <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
        <property name="entityManagerFactory" ref="entityManagerFactoty"></property>
    </bean>
       <!-- 5. 配置包扫描-->
    <context:component-scan base-package="com.txw" ></context:component-scan>
</beans>

7.创建CustomerDao接口的代码如下：

package com.txw.dao;

import com.txw.domain.Customer;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
/**
 *符合SpringDataJpa的dao层接口规范
 *        JpaRepository<操作的实体类类型，实体类中主键属性的类型>
 *            * 封装了基本CRUD操作
 *        JpaSpecificationExecutor<操作的实体类类型>
 *            * 封装了复杂查询（分页）
 * @author: Adair
 */
@SuppressWarnings("all")         // 注解警告信息
public interface CustomerDao extends JpaRepository<Customer,Long>, JpaSpecificationExecutor<Customer> {
    
    
}

3 使用动态查询完成查询单个对象
编写测试代码如下：

package com.txw.test;

import com.txw.dao.CustomerDao;
import com.txw.domain.Customer;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import javax.persistence.criteria.*;
/**
 * Spec的测试类
 * @author: Adair
 */
@RunWith(SpringJUnit4ClassRunner.class)  // 声明spring提供的单元测试环境
@ContextConfiguration(locations = "classpath:applicationContext.xml")  // 指定spring容器的配置信息
@SuppressWarnings("all")         // 注解警告信息
public class SpecTest {
    
    
    // 声明CustomerDao业务对象
    @Autowired
    private CustomerDao customerDao;
    /**
     * 根据条件，查询单个对象
     */
    @Test
    public void testSpec() {
    
    
        //匿名内部类
        /**
         * 自定义查询条件
         *      1.实现Specification接口（提供泛型：查询的对象类型）
         *      2.实现toPredicate方法（构造查询条件）
         *      3.需要借助方法参数中的两个参数（
         *          root：获取需要查询的对象属性
         *          CriteriaBuilder：构造查询条件的，内部封装了很多的查询条件（模糊匹配，精准匹配）
         *       ）
         *  案例：根据客户名称查询，查询客户名为Adair的客户
         *          查询条件
         *              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("custName");
                // 2.构造查询条件  ：    select * from cst_customer where cust_name = 'Adair'
                /**
                 * 第一个参数：需要比较的属性（path对象）
                 * 第二个参数：当前需要比较的取值
                 */
                //进行精准的匹配  （比较的属性，比较的属性的取值）
                Predicate predicate = cb.equal(custName, "Adair");
                return predicate;
            }
        };
        Customer customer = customerDao.findOne(spec);
        System.out.println(customer);
    }
}

运行结果如图所示：
4 动态查询完成多条件拼接
编写测试代码如下：

package com.txw.test;

import com.txw.dao.CustomerDao;
import com.txw.domain.Customer;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import javax.persistence.criteria.*;
/**
 * Spec的测试类
 * @author: Adair
 */
@RunWith(SpringJUnit4ClassRunner.class)           // 声明spring提供的单元测试环境
@ContextConfiguration(locations = "classpath:applicationContext.xml")     // 指定spring容器的配置信息
@SuppressWarnings("all")         // 注解警告信息
public class SpecTest {
    
    
    // 声明CustomerDao业务对象
    @Autowired
    private CustomerDao customerDao;
    /**
     * 多条件查询
     *      案例：根据客户名（学无止路）和客户所属行业查询（笔记）
     *
     */
    @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, "笔记");
                // 3.将多个查询条件组合到一起：组合（满足条件一并且满足条件二：与关系，满足条件一或满足条件二即可：或关系）
                Predicate and = cb.and(p1, p2); // 以与的形式拼接多个查询条件
                // cb.or() ; // 以或的形式拼接多个查询条件
                return and;
            }
        };
        Customer customer = customerDao.findOne(spec);
        System.out.println(customer);
    }
}

运行结果如图所示：
方法对应关系如表所示：

5 模糊匹配查询列表
编写测试代码如下：

package com.txw.test;

import com.txw.dao.CustomerDao;
import com.txw.domain.Customer;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import javax.persistence.criteria.*;
import java.util.List;
/**
 * Spec的测试类
 * @author: Adair
 */
@RunWith(SpringJUnit4ClassRunner.class)           // 声明spring提供的单元测试环境
@ContextConfiguration(locations = "classpath:applicationContext.xml")     // 指定spring容器的配置信息
@SuppressWarnings("all")         // 注解警告信息
public class SpecTest {
    
    
    // 声明CustomerDao业务对象
    @Autowired
    private CustomerDao customerDao;
    /**
     * 案例：完成根据客户名称的模糊匹配，返回客户列表
     *      客户名称以 ’学无止路‘ 开头
     * 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);
        }
    }
}

运行结果如图所示：
6 排序
编写测试代码如下：

package com.txw.test;

import com.txw.dao.CustomerDao;
import com.txw.domain.Customer;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import javax.persistence.criteria.*;
import java.util.List;
/**
 * Spec的测试类
 * @author: Adair
 */
@RunWith(SpringJUnit4ClassRunner.class)           // 声明spring提供的单元测试环境
@ContextConfiguration(locations = "classpath:applicationContext.xml")     // 指定spring容器的配置信息
@SuppressWarnings("all")         // 注解警告信息
public class SpecTest {
    
    
    // 声明CustomerDao业务对象
    @Autowired
    private CustomerDao customerDao;
    /**
     * 案例：完成根据客户名称的模糊匹配，返回客户列表
     *      客户名称以 ’学无止路‘ 开头
     * 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;
            }
        };
        // 添加排序
        // 创建排序对象,需要调用构造方法实例化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);
        }
    }
}

运行结果如图所示：
7 分页
编写测试代码如下：

package com.txw.test;

import com.txw.dao.CustomerDao;
import com.txw.domain.Customer;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
/**
 * Spec的测试类
 * @author: Adair
 */
@RunWith(SpringJUnit4ClassRunner.class)           // 声明spring提供的单元测试环境
@ContextConfiguration(locations = "classpath:applicationContext.xml")     // 指定spring容器的配置信息
@SuppressWarnings("all")         // 注解警告信息
public class SpecTest {
    
    
    // 声明CustomerDao业务对象
    @Autowired
    private CustomerDao customerDao;
    /**
     * 分页查询
     *      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());		// 得到总页数
    }
}

运行结果如图所示：