0

0

JPA Criteria API:实现复杂多条件查询与高效分页

聖光之護

聖光之護

发布时间:2025-11-08 14:54:18

|

907人浏览过

|

来源于php中文网

原创

JPA Criteria API:实现复杂多条件查询与高效分页

本文详细介绍了如何利用jpa criteria api处理复杂的多条件查询与分页场景。针对需要对不同实体类型进行独立筛选并合并结果的需求,文章阐述了如何通过criteria api构建动态查询、添加限制条件,并结合分页参数实现高效且统一的数据检索。

1. 理解复杂查询与分页的挑战

在企业级应用开发中,数据查询往往不仅仅是简单的单表查询。例如,我们可能需要从一个包含多种员工类型(如教师、护理人员)的表中,根据不同的类型或多种条件进行筛选,并最终将这些筛选结果合并为一个统一的列表进行分页展示。传统的SQL拼接字符串容易出错且存在SQL注入风险,而JPA的Specification接口虽然提供了一定的抽象,但在处理跨多个独立条件或需要“联合”效果(即满足任一条件即可)的场景时,直接使用可能显得不够灵活。此时,JPA Criteria API作为一种类型安全、动态构建查询的强大工具,成为了解决此类复杂问题的理想选择。

2. JPA Criteria API 核心概念

JPA Criteria API 允许开发者以编程方式构建查询,而不是通过字符串形式的JPQL。它提供了一套丰富的接口来表示查询的各个部分。理解以下核心组件是使用Criteria API的基础:

  • CriteriaBuilder: 用于创建查询表达式、谓词(Predicate)、排序(Order)等查询构建元素。它是构建所有Criteria查询的起点。
  • CriteriaQuery: 定义了查询的整体结构,包括要查询的实体类型T、根(Root)、选择(Selection)、条件(Predicate)和排序(Order)等。
  • Root: 表示查询的起始实体,类似于SQL中的FROM子句。通过Root可以访问实体的属性。
  • Predicate: 表示查询条件,如相等、大于、小于、LIKE、AND、OR等。CriteriaBuilder提供了多种方法来创建Predicate。
  • Path / Join: Path用于访问实体的属性。当需要查询关联实体(如EmployeeEntity的type属性如果是一个关联实体EmployeeType)时,可以使用join()方法创建Join对象,从而在关联实体上添加条件。
  • EntityManager: 作为JPA的核心接口,用于管理实体生命周期和执行查询。

3. 构建动态筛选条件

假设我们有以下员工实体模型,其中EmployeeType是一个独立的实体:

Zeemo AI
Zeemo AI

一款专业的视频字幕制作和视频处理工具

下载
import javax.persistence.*;
import java.io.Serializable;

@Entity
@Table(name = "employees")
public class EmployeeEntity implements Serializable {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "employee_type_id")
    private EmployeeType type; // 关联到 EmployeeType 实体

    private String name;

    // 构造函数
    public EmployeeEntity() {}

    public EmployeeEntity(EmployeeType type, String name) {
        this.type = type;
        this.name = name;
    }

    // Getters and Setters
    public Long getId() { return id; }
    public void setId(Long id) { this.id = id; }
    public EmployeeType getType() { return type; }
    public void setType(EmployeeType type) { this.type = type; }
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }

    @Override
    public String toString() {
        return "EmployeeEntity{" +
               "id=" + id +
               ", type=" + (type != null ? type.getName() : "null") +
               ", name='" + name + '\'' +
               '}';
    }
}

@Entity
@Table(name = "employee_types")
class EmployeeType implements Serializable {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name; // 例如:"Teachers", "Carers"

    // 构造函数
    public EmployeeType() {}

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

    // Getters and Setters
    public Long getId() { return id; }
    public void setId(Long id) { this.id = id; }
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }

    @Override
    public String toString() {
        return "EmployeeType{" +
               "id=" + id +
               ", name='" + name + '\'' +
               '}';
    }
}

现在,我们将使用Criteria API构建一个查询,实现按员工类型和名称进行筛选,并支持“联合”逻辑(例如,查询教师或护理人员)。

import javax.persistence.EntityManager;
import javax.persistence.TypedQuery;
import javax.persistence.criteria.*;
import java.util.ArrayList;
import java.util.List;

public class EmployeeRepositoryCriteria {

    public List findEmployeesByCriteria(
            String typeName1, String typeName2, String nameFilter,
            int pageNumber, int pageSize, EntityManager entityManager) {

        CriteriaBuilder cb = entityManager.getCriteriaBuilder();
        CriteriaQuery cq = cb.createQuery(EmployeeEntity.class);
        Root employee = cq.from(EmployeeEntity.class);

        List
 predicates = new ArrayList<>();

        // 1. 添加员工类型筛选条件 (模拟“联合”效果:typeName1 或 typeName2)
        // 注意:这里假设type是一个关联实体,通过join来访问其属性
        Join employeeTypeJoin = employee.join("type", JoinType.INNER);

        Predicate typePredicate1 = cb.equal(employeeTypeJoin.get("name"), typeName1);
        Predicate typePredicate2 = cb.equal(employeeTypeJoin.get("name"), typeName2);

        // 使用 cb.or() 实现逻辑 OR,即员工类型是 typeName1 或 typeName2
        predicates.add(cb.or(typePredicate1, typePredicate2));

        // 2. 添加员工名称模糊筛选条件
        if (nameFilter != null && !nameFilter.trim().isEmpty()) {
            predicates.add(cb.like(employee.get("name"), "%" + nameFilter.trim() + "%"));
        }

        // 组合所有条件
        if (!predicates.isEmpty()) {
            cq.where(cb.and(predicates.toArray(new Predicate[0])));
        }

        // 添加排序
        cq.orderBy(cb.asc(employee.get("name")));

        // 创建TypedQuery
        TypedQuery query = entityManager.createQuery(cq);

        // 设置分页参数
        query.setFirstResult(pageNumber * pageSize); // 起始索引
        query.setMaxResults(pageSize);               // 每页最大记录数

        return query.getResultList();
    }

    // 为了获取总记录数,通常需要另一个CriteriaQuery
    public long countEmployeesByCriteria(
            String typeName1, String typeName2, String nameFilter,
            EntityManager entityManager) {

        CriteriaBuilder cb = entityManager.getCriteriaBuilder();
        CriteriaQuery countCq = cb.createQuery(Long.class);
        Root employee = countCq.from(EmployeeEntity.class);
        countCq.select(cb.count(employee)); // 选择计数

        List
 predicates = new ArrayList<>();

        Join employeeTypeJoin = employee.join("type", JoinType.INNER);
        Predicate typePredicate1 = cb.equal(employeeTypeJoin.get("name"), typeName1);
        Predicate typePredicate2 = cb.equal(employeeTypeJoin.get("name"), typeName2);
        predicates.add(cb.or(typePredicate1, typePredicate2));

        if (nameFilter != null && !nameFilter.trim().isEmpty()) {
            predicates.add(cb.like(employee.get("name"), "%" + nameFilter.trim() + "%"));
        }

        if (!predicates.isEmpty()) {
            countCq.where(cb.and(predicates.toArray(new Predicate[0])));
        }

        return entityManager.createQuery(countCq).getSingleResult();
    }
}

在上述代码中:

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

673

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

319

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

344

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

1082

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

355

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

671

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

563

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

406

2024.04.29

虚拟号码教程汇总
虚拟号码教程汇总

本专题整合了虚拟号码接收验证码相关教程,阅读下面的文章了解更多详细操作。

25

2025.12.25

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2万人学习

C# 教程
C# 教程

共94课时 | 5.4万人学习

Java 教程
Java 教程

共578课时 | 38.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号