如何使用 spring 管理的事务性 EntityManager 执行自定义 SQL 查询

java spring jpa spring-transactions

2022-09-04 20:40:10

我有一个基于Spring构建的应用程序。我让Spring做所有的魔术，只要我对映射到Java对象的实体进行操作，一切正常。@Transactional

但是，当我想对未映射到任何Java实体的表执行一些自定义工作时，我就卡住了。不久前，我找到了一个解决方案来执行如下自定义查询：

// em is instance of EntityManager
em.getTransaction().begin();
Statement st = em.unwrap(Connection.class).createStatement();
ResultSet rs = st.executeQuery("SELECT custom FROM my_data");
em.getTransaction().commit();

当我尝试使用从Spring注入注释的实体管理器时，我收到了几乎明显的异常：@PersistenceContext

java.lang.IllegalStateException: 
Not allowed to create transaction on shared EntityManager - 
use Spring transactions or EJB CMT instead

我最终设法提取了非共享实体管理器，如下所示：

@Inject
public void myCustomSqlExecutor(EntityManagerFactory emf){
    EntityManager em = emf.createEntityManager();
    // the em.unwrap(...) stuff from above works fine here
}

尽管如此，我发现这个解决方案既不舒适也不优雅。我只是想知道在这个Spring事务驱动的环境中是否有其他方法来运行自定义SQL查询？

对于那些好奇的人 - 当我尝试在我的应用程序和相关论坛中立即创建用户帐户时，出现了这个问题 - 我不希望论坛的用户表映射到我的任何Java实体。

答案 1

可以使用 createNativeQuery 在数据库上执行任意 SQL。

EntityManager em = emf.createEntityManager();
List<Object> results = em.createNativeQuery("SELECT custom FROM my_data").getResultList();

上述答案仍然成立，但我想编辑一些额外的信息，这些信息也可能与研究这个问题的人有关。

虽然您可以使用createNativeQuery方法通过EntityManager执行本机查询;如果您使用的是Spring框架，则有另一种（可以说是更好的）方法来做到这一点。

使用Spring执行查询的另一种方法是使用JDBCTemplate。可以在同一应用程序中同时使用 JDBCTemplate 和 JPA EntityManager。配置将如下所示：

基础结构配置.class：

@Configuration
@Import(AppConfig.class)
public class InfrastructureConfig {

    @Bean //Creates an in-memory database.
    public DataSource dataSource(){
        return new EmbeddedDatabaseBuilder().build(); 
    }   

    @Bean //Creates our EntityManagerFactory
    public AbstractEntityManagerFactoryBean entityManagerFactory(DataSource dataSource){
        LocalContainerEntityManagerFactoryBean emf = new LocalContainerEntityManagerFactoryBean();
        emf.setDataSource(dataSource);
        emf.setJpaVendorAdapter(new HibernateJpaVendorAdapter());

        return emf;
    }

    @Bean //Creates our PlatformTransactionManager. Registering both the EntityManagerFactory and the DataSource to be shared by the EMF and JDBCTemplate
    public PlatformTransactionManager transactionManager(EntityManagerFactory emf, DataSource dataSource){
        JpaTransactionManager tm = new JpaTransactionManager(emf);
        tm.setDataSource(dataSource);
        return tm;
    }

}

应用配置.class：

@Configuration
@EnableTransactionManagement
public class AppConfig {

    @Bean
    public MyService myTransactionalService(DomainRepository domainRepository) {
        return new MyServiceImpl(domainRepository);
    }

    @Bean
    public DomainRepository domainRepository(JdbcTemplate template){
        return new JpaAndJdbcDomainRepository(template);
    }

    @Bean
    public JdbcTemplate jdbcTemplate(DataSource dataSource){
        JdbcTemplate template = new JdbcTemplate(dataSource);
        return template;
    }
}

以及一个同时使用 JPA 和 JDBC 的示例存储库：

public class JpaAndJdbcDomainRepository implements DomainRepository{

    private JdbcTemplate template;
    private EntityManager entityManager;

    //Inject the JdbcTemplate (or the DataSource and construct a new JdbcTemplate)
    public DomainRepository(JdbcTemplate template){
        this.template = template;
    }

    //Inject the EntityManager
    @PersistenceContext
    void setEntityManager(EntityManager entityManager) {
        this.entityManager = entityManager;
    }

    //Execute a JPA query
    public DomainObject getDomainObject(Long id){
        return entityManager.find(id);
    }

    //Execute a native SQL Query
    public List<Map<String,Object>> getData(){
        return template.queryForList("select custom from my_data");
    }
}

答案 2

您可以使用 EntityManager.createNativeQuery（String sql）来使用直接 sql 代码，或者使用 EntityManager.createNamedQuery（String name）来执行预编译的查询。您仍然使用 spring 管理的实体管理器，但处理非托管对象