17370845950

新闻动态
JPA CriteriaDelete 与子查询：确保数据删除操作正确执行的关键

本文旨在解决jpa中`criteriadelete`结合子查询进行数据删除时，操作不生效的问题。核心原因在于，通过`entitymanager.createquery()`创建的删除查询对象需要显式调用`executeupdate()`方法才能实际执行dml操作，而非查询操作常用的`getresultlist()`。文章将详细阐述这一关键点，并提供正确的代码示例和注意事项，确保您的jpa `criteriadelete`能够按预期工作。

JPA CriteriaDelete 结合子查询的常见陷阱

在使用JPA的CriteriaDelete API构建复杂的删除逻辑，特别是涉及子查询时，开发者可能会遇到一个常见问题：代码逻辑看起来正确，但数据库中的数据并未发生任何改变。这通常发生在尝试使用in-expression结合子查询来指定删除条件时。

例如，以下代码片段展示了一个常见的错误模式：

// 假设 orphan, one_type, other_type, key, givenList 已正确定义
CriteriaDelete criteriaDelete = criteriaBuilder.createCriteriaDelete(orphan);
Root deleteRoot = criteriaDelete.from(one_type);
Root queryRoot = criteriaDelete.from(other_type);

// 构建子查询
CriteriaQuery criteriaQuery = criteriaBuilder.createQuery(Object.class); // 注意：这里需要一个独立的CriteriaQuery来构建子查询
Root subqueryRoot = criteriaQuery.from(other_type); // 子查询的Root
criteriaQuery.select(subqueryRoot.get(key)); // 子查询选择的字段

// 将子查询结果用于主删除查询的in条件
entityManager.createQuery(criteriaDelete
        .where(deleteRoot.in(entityManager.createQuery(criteriaQuery
                .where(subqueryRoot.get("id").in(givenList))).getResultList()))); // 错误：这里调用了getResultList()
上述代码的问题在于，entityManager.createQuery(...)返回的是一个javax.persistence.Query对象。对于DML（数据操作语言）操作，如DELETE、UPDATE或INSERT，仅仅创建Query对象或调用其getResultList()方法（这通常用于SELECT查询）并不会实际执行数据库操作。


解决方案：使用 executeUpdate()


JPA规范明确指出，对于执行DML操作的Query对象，必须调用executeUpdate()方法才能将操作提交到数据库。executeUpdate()方法会返回受影响的行数，这对于验证操作是否成功非常有用。


正确的做法是在创建并配置好CriteriaDelete查询后，获取Query对象并调用executeUpdate()。


以下是修正后的代码示例：
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 javax.persistence.Query; // 导入Query

// 假设 Y, T 是你的实体类型，key 是 T 实体中的一个属性名，givenList 是一个用于in条件的值列表

public class JpaCriteriaDeleteExecutor {

    private final EntityManager entityManager;
    private final CriteriaBuilder criteriaBuilder;

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

    public  int deleteEntitiesWithSubquery(Class targetEntityType, Class subqueryEntityType, String subqueryKeyProperty, java.util.List givenList) {
        // 1. 创建 CriteriaDelete 对象，指定要删除的实体类型
        CriteriaDelete criteriaDelete = criteriaBuilder.createCriteriaDelete(targetEntityType);
        Root deleteRoot = criteriaDelete.from(targetEntityType);

        // 2. 构建子查询 (Subquery)
        // 注意：这里需要一个新的 CriteriaQuery 来构建子查询
        CriteriaQuery subCriteriaQuery = criteriaBuilder.createQuery(Object.class);
        Root subqueryRoot = subCriteriaQuery.from(subqueryEntityType);

        // 子查询选择的字段，例如 'id' 或其他用于关联的键
        subCriteriaQuery.select(subqueryRoot.get(subqueryKeyProperty));

        // 子查询的 WHERE 条件
        subCriteriaQuery.where(subqueryRoot.get("id").in(givenList)); // 假设 T 实体有一个 'id' 属性

        // 3. 将子查询作为主删除查询的 WHERE 条件
        // 重要：不要在这里直接调用 getResultList()
        criteriaDelete.where(deleteRoot.get("somePropertyInY").in(
                entityManager.createQuery(subCriteriaQuery).getSelection() // 获取子查询的选择部分作为in条件
        ));

        // 4. 创建 JPA Query 对象并执行
        Query query = entityManager.createQuery(criteriaDelete);
        int affectedRows = query.executeUpdate(); // 关键：调用 executeUpdate()

        return affectedRows;
    }
}
代码解析：


    

  1. 
CriteriaDelete criteriaDelete = criteriaBuilder.createCriteriaDelete(targetEntityType);: 创建CriteriaDelete实例，指定要删除的实体类型Y。
    2. 

  2. 
Root deleteRoot = criteriaDelete.from(targetEntityType);: 为CriteriaDelete定义根（Root），代表要删除的实体。
    3. 

  3. 
CriteriaQuery subCriteriaQuery = criteriaBuilder.createQuery(Object.class);: 构建一个独立的CriteriaQuery用于子查询。子查询通常只选择一个或几个字段，因此Object.class作为选择类型是常见的。
    4. 

  4. 
Root subqueryRoot = subCriteriaQuery.from(subqueryEntityType);: 为子查询定义根，代表子查询中涉及的实体类型T。
    5. 

  5. 
subCriteriaQuery.select(subqueryRoot.get(subqueryKeyProperty));: 指定子查询要选择的字段，这个字段将用于主查询的in条件。
    6. 

  6. 
subCriteriaQuery.where(subqueryRoot.get("id").in(givenList));: 定义子查询的过滤条件。
    7. 

  7. 
criteriaDelete.where(deleteRoot.get("somePropertyInY").in(entityManager.createQuery(subCriteriaQuery).getSelection()));: 这是关键部分。主删除查询的where子句使用deleteRoot.get("somePropertyInY").in(...)。in操作符的参数不再是getResultList()的调用，而是entityManager.createQuery(subCriteriaQuery).getSelection()。getSelection()方法用于从子查询中获取其选择的表达式，这正是in操作符所期望的。
    8. 

  8. 
Query query = entityManager.createQuery(criteriaDelete);: 将CriteriaDelete对象转换为JPA的Query对象。
    9. 

  9. 
int affectedRows = query.executeUpdate();: 核心步骤。 调用executeUpdate()方法来执行删除操作。它返回实际删除的行数。
    10. 



注意事项与最佳实践


    

  • 
事务管理： DML操作（包括删除）必须在一个活动的事务中执行。如果当前没有事务，JPA提供者会抛出异常。确保你的deleteEntitiesWithSubquery方法或其调用者在一个事务上下文中运行（例如，通过Spring的@Transactional注解或手动管理事务）。
    • 

  • 
性能考量：
      

    • 
子查询优化： 复杂的子查询可能会影响性能。确保子查询的条件有适当的索引。
      • 

    • 
in子句大小： 如果givenList非常大，in子句可能会变得效率低下。对于超大的列表，可能需要考虑其他策略，例如分批删除或使用临时表。
      • 

    

    • 

  • 
错误处理： executeUpdate()在执行过程中如果遇到数据库错误（例如，违反外键约束），会抛出PersistenceException或其子类。应适当捕获和处理这些异常。
    • 

  • 
日志记录： 记录executeUpdate()返回的受影响行数，有助于验证操作是否成功以及进行故障排查。
    • 

  • 
getSelection() vs. getResultList()： 再次强调，getResultList()用于执行SELECT查询并获取结果集，而getSelection()用于在构建子查询时，将子查询的选择部分作为表达式嵌入到父查询中。对于DML操作，永远不要在where子句中直接调用getResultList()。
    • 



总结


当使用JPA的CriteriaDelete API结合子查询进行数据删除时，关键在于理解JPA Query对象的行为。EntityManager.createQuery()返回的Query对象，对于DML操作（如删除），必须显式调用executeUpdate()方法才能实际执行。忽略这一步会导致删除操作无声地失败。通过遵循正确的模式并注意事务管理和性能考量，可以确保您的JPA CriteriaDelete操作高效且可靠地执行。
 
	









            
            

              
              
            

          
        
      
      


  
赣ICP备2024031479号