17370845950

新闻动态
JPA CriteriaDelete与in子查询：确保数据操作正确执行

本文旨在解决jpa `criteriadelete`结合`in`表达式和子查询时，数据删除操作不生效的问题。核心原因在于执行dml操作（如删除）后，必须显式调用`javax.persistence.query`对象的`executeupdate()`方法，而非仅创建查询。文章将通过详细解析和示例代码，指导开发者正确执行此类批量删除操作，并强调相关的注意事项。

JPA CriteriaDelete操作不生效的常见原因

在使用JPA的Criteria API进行批量删除（CriteriaDelete）时，开发者可能会遇到一个常见的问题：即使构建了正确的查询逻辑，数据却未被删除。这尤其容易发生在涉及in表达式和子查询的复杂场景中。

例如，以下代码片段展示了尝试使用CriteriaDelete结合in表达式和子查询来删除实体Y的常见尝试：

// 假设 orphan, one_type, other_type, key, givenList 已定义
CriteriaBuilder criteriaBuilder = entityManager.getCriteriaBuilder();
CriteriaDelete criteriaDelete = criteriaBuilder.createCriteriaDelete(orphan);

Root deleteRoot = criteriaDelete.from(one_type); // 主查询的根实体

// 构建子查询，用于in表达式
CriteriaQuery criteriaQuery = criteriaBuilder.createQuery(other_type); // 子查询的返回类型
Root queryRoot = criteriaQuery.from(other_type); // 子查询的根实体
criteriaQuery.select(queryRoot.get(key)); // 子查询选择的字段
criteriaQuery.where(queryRoot.get("id").in(givenList)); // 子查询的过滤条件

// 将子查询的结果列表用于主删除查询的in表达式
entityManager.createQuery(criteriaDelete
        .where(deleteRoot.in(entityManager.createQuery(criteriaQuery).getResultList())));

尽管上述代码成功构建了一个Query对象，但当这段代码执行后，数据库中的数据并不会受到任何影响。这是因为，仅仅创建Query对象并不能触发实际的数据库操作。

解决方案：显式调用 executeUpdate()

JPA规范明确指出，对于数据操作语言（DML）操作，如批量删除（CriteriaDelete）或批量更新（CriteriaUpdate），在创建javax.persistence.Query对象后，必须显式调用其executeUpdate()方法来执行实际的数据库操作。

entityManager.createQuery(...)方法返回的是一个Query接口的实例，它代表了我们定义的数据库操作。但这个操作本身是惰性执行的，只有当我们明确告诉JPA去执行它时，它才会真正与数据库进行交互。对于查询操作（SELECT），我们通常调用getResultList()或getSingleResult()来获取结果，这些方法会触发查询执行。但对于DELETE或UPDATE操作，我们需要调用executeUpdate()。

正确执行 CriteriaDelete 的步骤：

  1. 构建 CriteriaDelete 对象： 定义要删除的实体类型和删除条件。
  2. 构建子查询（如果需要）： 创建独立的CriteriaQuery来获取in表达式所需的值列表。
  3. 执行子查询并获取结果： 使用entityManager.createQuery(subCriteriaQuery).getResultList()获取子查询的结果列表。
  4. 将结果应用于主 CriteriaDelete 的 where 子句： 使用deleteRoot.get("someField").in(resultList)构建删除条件。
  5. 创建主 Query 对象： 使用entityManager.createQuery(criteriaDelete)。
  6. 调用 executeUpdate()： 在创建的Query对象上调用executeUpdate()方法，触发数据库删除操作。

修正后的示例代码：

为了更清晰地说明，我们假设：

  • Y.class 是要删除的实体类型。
  • T.class 是用于子查询的实体类型。
  • Y 实体中有一个名为 "matchingFieldInY" 的字段，其值需要与T实体中名为"key"的字段匹配。
  • T 实体中有一个名为"id"的字段，用于子查询的过滤。
  • givenList 是一个包含T实体id的列表。
import javax.persistence.EntityManager;
import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.CriteriaDelete;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.criteria.Root;
import java.util.List;

// 假设 Y 和 T 是 JPA 实体
// class Y { private Object matchingFieldInY; ... }
// class T { private Object id; private Object key; ... }

public class JpaCriteriaDeleteExecutor {

    private EntityManager entityManager; // 假设 entityManager 已注入或获取

    public JpaCriteriaDeleteExecutor(EntityManager entityManager) {
        this.entityManager = entityManager;
    }

    public int deleteEntitiesWithSubquery(List givenList) {
        CriteriaBuilder cb = entityManager.getCriteriaBuilder();

        // 1. 构建子查询：获取T实体中'key'字段的值列表
        CriteriaQuery subCriteriaQuery = cb.createQuery(Object.class); // 子查询选择单个字段，返回类型为Object
        Root subQueryRoot = subCriteriaQuery.from(T.class);
        subCriteriaQuery.select(subQueryRoot.get("key")); // 选择T实体中的'key'字段
        subCriteriaQuery.where(subQueryRoot.get("id").in(givenList)); // 根据'id'列表过滤T实体

        // 2. 执行子查询，获取in表达式所需的值列表
        List keysToMatch = entityManager.createQuery(subCriteriaQuery).getResultList();

        // 3. 构建主 CriteriaDelete 查询
        CriteriaDelete deleteQuery = cb.createCriteriaDelete(Y.class);
        Root deleteRoot = deleteQuery.from(Y.class);

        // 4. 应用in谓词：删除Y实体中'matchingFieldInY'字段值在keysToMatch列表中的记录
        // 注意：这里假设Y实体有一个字段'matchingFieldInY'与T实体的'key'字段类型兼容
        deleteQuery.where(deleteRoot.get("matchingFieldInY").in(keysToMatch));

        // 5. 关键步骤：创建Query对象并调用executeUpdate()
        int deletedCount = entityManager.createQuery(deleteQuery).executeUpdate();

        System.out.println("成功删除了 " + deletedCount + " 条记录。");
        return deletedCount;
    }
}
注意事项


    

  • 
返回值： executeUpdate()方法返回一个int值，表示受DML操作影响的数据库记录数量。
    • 

  • 
事务管理： CriteriaDelete等DML操作必须在事务中执行。如果当前没有活动的事务，JPA提供者会抛出异常。
    • 

  • 
一级缓存（Persistence Context）： CriteriaDelete操作是直接针对数据库执行的，它会绕过JPA的一级缓存（Persistence Context）。这意味着，如果当前持久化上下文中有受影响的实体实例，它们将不会自动更新或从缓存中移除，可能导致缓存数据与数据库数据不一致。
    • 
解决方案： 在执行批量DML操作后，如果需要确保持久化上下文中的数据一致性，可以考虑调用entityManager.clear()来清空整个持久化上下文，或者使用entityManager.refresh(entity)来刷新特定的实体实例。但请注意，entityManager.clear()会使所有当前受管实体变为游离态，可能需要重新加载。
    

    • 

  • 
性能： 批量DML操作（如CriteriaDelete）通常比逐个加载实体再删除要高效得多，尤其是在处理大量数据时。
    • 



总结


当使用JPA的CriteriaDelete进行批量删除操作时，务必记住在构建Query对象后，显式调用executeUpdate()方法来触发实际的数据库操作。这是确保DML操作生效的关键一步。同时，正确处理事务和一级缓存的一致性问题，可以帮助开发者构建健壮、高效的JPA应用程序。
 
	









            
            

              
              
            

          
        
      
      


  
赣ICP备2024031479号