本文档旨在指导开发者如何在 Java spring Boot 项目的任何类中执行原生 sql 查询。我们将重点解决 TransactionRequiredException 异常，并提供正确的代码示例，确保数据库操作的顺利执行。本文将详细介绍如何使用 EntityManager 执行原生 SQL 查询，并提供示例代码和注意事项，帮助你避免常见的错误。
使用 EntityManager 执行原生 SQL 查询
在 spring boot 项目中，EntityManager 是与数据库交互的关键接口。它提供了执行各种数据库操作的方法，包括执行原生 SQL 查询。以下是如何在 Spring Boot 服务类中使用 EntityManager 执行原生 SQL 查询的步骤：
-
注入 EntityManager:
首先，确保你的类中注入了 EntityManager。这通常通过构造函数注入完成：
import javax.persistence.EntityManager; import lombok.RequiredArgsConstructor; import org.springframework.stereotype.Service; @Service @RequiredArgsConstructor public class MyService { private final EntityManager entityManager; // ... }@RequiredArgsConstructor 注解会自动生成一个包含 final 字段的构造函数，从而注入 EntityManager。
-
创建并执行原生 SQL 查询:
使用 entityManager.createNativeQuery() 方法创建原生 SQL 查询。然后，使用 executeUpdate() 方法执行该查询。
import org.springframework.transaction.annotation.Transactional; @Transactional public void executeNativeSqlQuery(String tableName) { String query = "DROP TABLE " + tableName; entityManager.createNativeQuery(query).executeUpdate(); }注意事项：
- @Transactional 注解至关重要。它确保该方法在事务上下文中执行，从而允许执行更新或删除操作。缺少此注解会导致 TransactionRequiredException 异常。
- 直接拼接 SQL 字符串时要格外小心，以避免 SQL 注入攻击。如果表名来自用户输入，请考虑使用参数化查询或转义特殊字符。
解决 TransactionRequiredException 异常
TransactionRequiredException 异常通常发生在尝试在没有事务上下文的情况下执行更新或删除操作时。为了解决这个问题，请确保以下几点：
-
使用 @Transactional 注解:
在执行更新或删除操作的方法上添加 @Transactional 注解。这会将该方法置于事务上下文中，允许执行这些操作。
import org.springframework.transaction.annotation.Transactional; @Transactional public void myMethod() { // 执行数据库更新或删除操作 } -
检查事务管理器配置:
确保你的 Spring Boot 项目配置了事务管理器。Spring Boot 通常会自动配置一个合适的事务管理器，但如果你的配置比较特殊，可能需要手动配置。
-
避免在只读事务中执行更新操作:
如果你的事务配置为只读，则无法执行更新或删除操作。确保事务的传播行为允许写入操作。
示例代码
以下是一个完整的示例，展示了如何在 Spring Boot 服务类中使用 EntityManager 执行原生 SQL 查询来删除表：
package com.example.demo.service; import javax.persistence.EntityManager; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Service; import org.springframework.transaction.annotation.Transactional; @Service @RequiredArgsConstructor @Slf4j public class MyService { private final EntityManager entityManager; /** * 删除指定名称的表。 * * @param tableName 要删除的表的名称。 */ @Transactional public void dropTable(String tableName) { try { String query = "DROP TABLE IF EXISTS " + tableName; entityManager.createNativeQuery(query).executeUpdate(); log.info("Table {} dropped successfully.", tableName); } catch (Exception e) { log.error("Error dropping table {}: {}", tableName, e.getMessage()); throw e; // 重新抛出异常，以便事务管理器可以处理 } } }
总结
通过正确使用 EntityManager 和 @Transactional 注解，你可以在 Spring Boot 项目中轻松执行原生 SQL 查询。记住，始终要注意 SQL 注入风险，并确保你的事务配置正确。 通过本教程，你应该能够避免 TransactionRequiredException 异常，并有效地管理数据库操作。
