深入解析 Java Criteria API 的使用与实例

最新推荐文章于 2025-05-18 06:00:00 发布

原创最新推荐文章于 2025-05-18 06:00:00 发布 · 885 阅读

CC 4.0 BY-SA版权

文章标签：

在 Java 开发中，javax.persistence.criteria API 提供了一种类型安全的方式来构建查询语句。它允许开发者通过面向对象的方式来定义查询逻辑，避免了传统 SQL 查询中可能出现的拼接错误和类型不匹配问题。本文将详细介绍如何使用 Criteria API 构建查询，并通过具体的实例展示其强大功能。

一、核心组件概述

1. CriteriaBuilder

CriteriaBuilder 是 Criteria API 的入口点，用于构建查询对象及其表达式。我们可以通过 EntityManager.getCriteriaBuilder() 或 EntityManagerFactory.getCriteriaBuilder() 获取其实例。

EntityManager entityManager = ......;
CriteriaBuilder criteriaBuilder = entityManager.getCriteriaBuilder();

2. CriteriaQuery

CriteriaQuery 对象代表一个查询，它通过 CriteriaBuilder 的 createQuery 方法创建。该接口提供了多种方法来定义查询的各个子句，例如 select() 定义选择子句，where() 定义条件子句。

CriteriaQuery<Employee> criteriaQuery = criteriaBuilder.createQuery(Employee.class);

3. Root

Root<T> 表示目标实体的根类型。它通过 CriteriaQuery.from(Class<T> entityClass) 方法获取，用于引用目标实体。

Root<Employee> employeeRoot = criteriaQuery.from(Employee.class);

二、构建查询

构建查询的过程是通过 CriteriaQuery 的方法逐步完成的。我们首先通过 select() 方法指定查询结果的类型，然后通过 where() 方法添加条件。

criteriaQuery.select(employeeRoot);
criteriaQuery.where(criteriaBuilder.equal(employeeRoot.get("dept"), "Admin"));

在上述代码中，我们使用了 CriteriaBuilder.equal(Expression<?> x, Object y) 方法，它返回一个 Predicate 实例，用于定义查询条件。

三、执行查询

查询的执行通过 EntityManager.createQuery() 方法完成，该方法返回一个 TypedQuery<T> 实例，用于执行查询并获取结果。

TypedQuery<Employee> typedQuery = entityManager.createQuery(criteriaQuery);
List<Employee> list = typedQuery.getResultList();

四、实例解析

为了更好地理解 Criteria API 的使用，我们通过一个具体的例子来展示如何构建和执行查询。

1. 实体类定义

首先，我们定义一个简单的实体类 Employee，用于存储员工信息。

@Entity
public class Employee {
    @Id
    @GeneratedValue
    private long id;
    private String name;
    private double salary;
    private String dept;

    // 省略构造方法、getter 和 setter 方法
}

2. 查询实现

接下来，我们通过 Criteria API 实现两个查询：查询所有员工和查询部门为“Admin”的员工。

public class ExampleMain {
    private static EntityManagerFactory entityManagerFactory =
            Persistence.createEntityManagerFactory("example-unit");

    public static void main(String[] args) {
        try {
            persistEmployees();
            findAllEmployees();
            findAdmins();
        } finally {
            entityManagerFactory.close();
        }
    }

    public static void persistEmployees() {
        Employee employee1 = Employee.create("Diana", 2000, "IT");
        Employee employee2 = Employee.create("Rose", 3500, "Admin");
        Employee employee3 = Employee.create("Denise", 2500, "Admin");
        Employee employee4 = Employee.create("Mike", 4000, "IT");
        Employee employee5 = Employee.create("Linda", 4500, "Sales");

        EntityManager em = entityManagerFactory.createEntityManager();
        em.getTransaction().begin();
        em.persist(employee1);
        em.persist(employee2);
        em.persist(employee3);
        em.persist(employee4);
        em.persist(employee5);
        em.getTransaction().commit();
        em.close();
    }

    private static void findAllEmployees() {
        System.out.println("-- All employees --");
        EntityManager em = entityManagerFactory.createEntityManager();
        CriteriaBuilder cb = em.getCriteriaBuilder();
        CriteriaQuery<Employee> query = cb.createQuery(Employee.class);
        Root<Employee> employeeRoot = query.from(Employee.class);
        query.select(employeeRoot);

        TypedQuery<Employee> typedQuery = em.createQuery(query);
        typedQuery.getResultList().forEach(System.out::println);

        em.close();
    }

    private static void findAdmins() {
        System.out.println("-- All employees with 'Admin' dept --");
        EntityManager em = entityManagerFactory.createEntityManager();
        CriteriaBuilder cb = em.getCriteriaBuilder();
        CriteriaQuery<Employee> query = cb.createQuery(Employee.class);
        Root<Employee> employee = query.from(Employee.class);
        query.select(employee)
             .where(cb.equal(employee.get("dept"), "Admin"));

        TypedQuery<Employee> typedQuery = em.createQuery(query);
        typedQuery.getResultList().forEach(System.out::println);

        em.close();
    }
}

3. 输出结果

运行上述代码后，输出结果如下：

-- All employees --
Employee{id=1, name='Diana', salary=2000.0, dept='IT'}
Employee{id=2, name='Rose', salary=3500.0, dept='Admin'}
Employee{id=3, name='Denise', salary=2500.0, dept='Admin'}
Employee{id=4, name='Mike', salary=4000.0, dept='IT'}
Employee{id=5, name='Linda', salary=4500.0, dept='Sales'}

-- All employees with 'Admin' dept --
Employee{id=2, name='Rose', salary=3500.0, dept='Admin'}
Employee{id=3, name='Denise', salary=2500.0, dept='Admin'}