Spring Boot多数据源事务管理：解决实体保存失败问题-java教程-PHP中文网

Spring Boot多数据源事务管理：解决实体保存失败问题

本文深入探讨了spring boot多数据源环境下实体保存失败的问题，特别是当使用多个jpa数据源时，由于事务管理器未明确指定而导致的`transactionrequiredexception`。文章详细介绍了如何正确配置和使用多数据源，并提供了通过在`@transactional`注解中显式指定事务管理器名称来解决实体无法持久化到非主数据源的实用解决方案。

在构建复杂的企业级应用时，经常会遇到需要连接多个数据库的场景，例如读写分离、数据归档、或集成不同业务系统的数据。Spring Boot通过其强大的自动化配置能力，使得多数据源的集成变得相对简单。然而，当涉及到事务管理时，尤其是使用Spring Data JPA在多个数据源之间进行实体持久化操作时，如果不进行恰当的配置，可能会遇到实体无法保存的错误。

多数据源配置概述

在Spring Boot应用中配置多数据源，通常需要为每个数据源定义独立的DataSource、EntityManagerFactory和PlatformTransactionManager。以下是一个典型的Kotlin语言配置示例，展示了主数据源（Primary）和辅助数据源（Secondary）的配置结构：

主数据源配置 (PrimaryConfig.kt)

@Configuration
@EnableJpaRepositories(
    basePackages = ["org.my.app.repository.primary"],
    entityManagerFactoryRef = "primaryDbEntityManager",
    transactionManagerRef = "primaryDbTransactionManager"
)
class PrimaryConfig {
    @Primary
    @Bean
    @ConfigurationProperties("spring.primary-db")
    fun primaryDbDataSource(): DataSource {
        return DataSourceBuilder.create()
            .driverClassName("org.postgresql.Driver")
            .url("jdbc:postgresql://127.0.0.1:5432/primary_db")
            .username("postgres")
            .password("********")
            .build()
    }

    @Primary
    @Bean
    fun primaryDbEntityManager(): LocalContainerEntityManagerFactoryBean {
        val em = LocalContainerEntityManagerFactoryBean()
        em.dataSource = primaryDbDataSource()
        em.setPackagesToScan("org.my.app.entity.primary")
        em.jpaVendorAdapter = HibernateJpaVendorAdapter()
        val properties = HashMap<String, String?>()
        properties["hibernate.dialect"] = "org.hibernate.dialect.PostgreSQLDialect"
        properties["hibernate.temp.use_jdbc_metadata_defaults"] = "false"
        em.setJpaPropertyMap(properties)
        return em
    }

    @Primary
    @Bean(name = ["primaryDbTransactionManager"])
    fun primaryDbTransactionManager(): PlatformTransactionManager {
        val transactionManager = JpaTransactionManager()
        transactionManager.entityManagerFactory = primaryDbEntityManager().getObject()
        return transactionManager
    }
}

登录后复制

辅助数据源配置 (SecondaryConfig.kt)

@Configuration
@EnableJpaRepositories(
    basePackages = ["org.my.app.repository.secondary"],
    entityManagerFactoryRef = "secondaryDbEntityManager",
    transactionManagerRef = "secondaryDbTransactionManager"
)
class SecondaryConfig {
    @Bean
    @ConfigurationProperties("spring.secondary-db")
    fun secondaryDbDataSource(): DataSource {
        return DataSourceBuilder.create()
            .driverClassName("org.postgresql.Driver")
            .url("jdbc:postgresql://127.0.0.1:5432/secondary_db")
            .username("postgres")
            .password("********")
            .build()
    }

    @Bean
    fun secondaryDbEntityManager(): LocalContainerEntityManagerFactoryBean {
        val em = LocalContainerEntityManagerFactoryBean()
        em.dataSource = secondaryDbDataSource()
        em.setPackagesToScan("org.my.app.entity.secondary")
        em.jpaVendorAdapter = HibernateJpaVendorAdapter()
        val properties = HashMap<String, String?>()
        properties["hibernate.dialect"] = "org.hibernate.dialect.PostgreSQLDialect"
        properties["hibernate.temp.use_jdbc_metadata_defaults"] = "false"
        em.setJpaPropertyMap(properties)
        return em
    }

    @Bean(name = ["secondaryDbTransactionManager"])
    fun secondaryDbTransactionManager(): PlatformTransactionManager { // 注意方法名与Bean名称一致
        val transactionManager = JpaTransactionManager()
        transactionManager.entityManagerFactory = secondaryDbEntityManager().getObject()
        return transactionManager
    }
}

登录后复制

在上述配置中，@EnableJpaRepositories注解用于指定每个数据源对应的Repository接口所在的包，并明确关联了其entityManagerFactoryRef和transactionManagerRef。@Primary注解则用于标记默认的主数据源配置。

遇到的问题：事务管理与实体保存失败

在配置好多个数据源后，开发者通常会为每个数据源创建独立的Repository来处理相应的实体。例如：

辅助数据源Repository (SecondaryDbRepository.kt)

package org.my.app.repository.secondary

import org.my.app.entity.secondary.SecondaryEntity
import org.springframework.stereotype.Service
import org.springframework.transaction.annotation.Transactional
import javax.persistence.EntityManager

@Service
class SecondaryDbRepository(
    @Qualifier("secondaryDbEntityManager")
    private val entityManager: EntityManager
) {
    @Transactional // 问题所在：未指定事务管理器
    fun batchInsert(entityList: List<SecondaryEntity>) {
        for (entity in entityList) {
            entityManager.persist(entity)
        }
        entityManager.clear()
    }
}

登录后复制

当尝试在一个服务层方法中同时保存实体到主数据源和辅助数据源时，可能会遇到以下异常：

javax.persistence.TransactionRequiredException: no transaction is in progress
    at org.hibernate.internal.AbstractSharedSessionContract.checkTransactionNeededForUpdateOperation(AbstractSharedSessionContract.java:398) ~[hibernate-core-5.3.10.Final.jar:5.3.10.Final]
    ...

登录后复制

以及

java.lang.IllegalArgumentException: attempt to create event with null entity

登录后复制

这些异常表明，尽管在batchInsert方法上使用了@Transactional注解，但Spring事务管理器并未正确地为辅助数据源启动一个事务。

问题根源分析

出现TransactionRequiredException: no transaction is in progress的原因在于，当Spring容器中存在多个PlatformTransactionManager类型的Bean时，@Transactional注解默认无法确定应该使用哪一个事务管理器。虽然我们为主数据源使用了@Primary注解，使其成为默认的事务管理器，但对于非主数据源的Repository方法，Spring仍然需要明确的指示来选择正确的事务管理器。

AISEO

AI创作对SEO友好的文案和文章

查看详情

在上述SecondaryDbRepository的batchInsert方法中，@Transactional注解没有指定其应使用的事务管理器。因此，Spring可能尝试使用默认的（即主数据源的）事务管理器，或者根本无法找到合适的事务管理器来处理辅助数据源的持久化操作，从而导致“无事务进行中”的错误。

解决方案：显式指定事务管理器

解决此问题的关键是在@Transactional注解中显式地指定要使用的事务管理器名称。这个名称应与在配置类中通过@Bean(name = ["..."])定义事务管理器时所指定的名称一致。

修正后的辅助数据源Repository (SecondaryDbRepository.kt)

package org.my.app.repository.secondary

import org.my.app.entity.secondary.SecondaryEntity
import org.springframework.stereotype.Service
import org.springframework.transaction.annotation.Transactional
import javax.persistence.EntityManager

@Service
class SecondaryDbRepository(
    @Qualifier("secondaryDbEntityManager")
    private val entityManager: EntityManager
) {
    @Transactional("secondaryDbTransactionManager") // 显式指定事务管理器
    fun batchInsert(entityList: List<SecondaryEntity>) {
        for (entity in entityList) {
            entityManager.persist(entity)
        }
        entityManager.clear()
    }
}

登录后复制

通过将@Transactional("secondaryDbTransactionManager")添加到batchInsert方法上，我们明确告诉Spring，这个方法应该使用名为secondaryDbTransactionManager的事务管理器来管理其事务。这样，Spring就能正确地为辅助数据源启动和管理事务，从而解决实体保存失败的问题。

同样地，对于主数据源的Repository，虽然@Primary注解使其成为默认，但为了代码的清晰性和避免潜在的混淆，也可以显式指定事务管理器：

package org.my.app.repository.primary

import org.my.app.entity.primary.PrimaryEntity
import org.springframework.stereotype.Service
import org.springframework.transaction.annotation.Transactional
import javax.persistence.EntityManager

@Service
class PrimaryDbRepository(
    @Qualifier("primaryDbEntityManager")
    private val entityManager: EntityManager
) {
    @Transactional("primaryDbTransactionManager") // 显式指定事务管理器
    fun batchInsert(entityList: List<PrimaryEntity>) {
        for (entity in entityList) {
            entityManager.persist(entity)
        }
        entityManager.clear()
    }
}

登录后复制

注意事项与最佳实践

命名一致性： 确保在@Bean(name = ["..."])中定义的事务管理器名称与@Transactional("...")中引用的名称完全一致。

服务层事务管理： 在实际应用中，通常建议在服务层（Service Layer）而非Repository层进行事务管理。如果服务层方法需要跨多个Repository操作，并且这些Repository可能关联不同的数据源，那么服务层的方法也需要显式指定事务管理器。例如：

@Service
class MyService(
    private val primaryRepository: PrimaryDbRepository,
    private val secondaryRepository: SecondaryDbRepository
) {
    @Transactional("primaryDbTransactionManager") // 或者根据业务逻辑选择合适的事务管理器
    fun saveToPrimaryAndSecondary(primaryData: List<PrimaryEntity>, secondaryData: List<SecondaryEntity>) {
        primaryRepository.batchInsert(primaryData)
        // 如果需要在一个事务中保存到两个数据源，并且这两个数据源不能使用JTA，
        // 那么需要考虑分布式事务解决方案，或者将操作拆分。
        // 否则，下面的操作将独立于上面的primaryDbTransactionManager事务。
        secondaryRepository.batchInsert(secondaryData)
    }

    @Transactional("secondaryDbTransactionManager")
    fun saveOnlyToSecondary(secondaryData: List<SecondaryEntity>) {
        secondaryRepository.batchInsert(secondaryData)
    }
}

登录后复制

请注意，如果一个服务方法同时调用了不同数据源的Repository方法，并且每个Repository方法都有自己的@Transactional注解，那么外部的@Transactional（如果存在）会尝试传播其事务。但如果外部事务管理器与内部Repository方法期望的事务管理器不匹配，仍然可能出现问题。在多数据源场景下，通常推荐将对不同数据源的操作封装在各自独立的事务方法中，或者在服务层根据业务逻辑明确指定事务管理器。

分布式事务（JTA）： 如果业务场景要求对多个数据源的操作必须原子性地成功或失败（即需要跨多个数据库的ACID事务），那么仅靠Spring的本地事务管理器是不够的。此时需要引入分布式事务解决方案，如使用JTA（Java Transaction API）和XA兼容的数据源。但这会增加配置的复杂性，并需要一个JTA事务管理器（如Atomikos、Narayana等）。

总结

在Spring Boot多数据源应用中，当存在多个PlatformTransactionManager实例时，为了确保@Transactional注解能够正确地为非主数据源启动事务，必须在注解中通过value或transactionManager属性显式指定要使用的事务管理器名称。这一简单的改动能够有效解决TransactionRequiredException: no transaction is in progress的问题，保障实体能够顺利持久化到目标数据库。理解并正确应用这一机制，是构建健壮多数据源Spring应用的基石。

以上就是Spring Boot多数据源事务管理：解决实体保存失败问题的详细内容，更多请关注php中文网其它相关文章！