本文详细介绍了在spring Boot应用中配置两个postgresql数据库并使用JPA进行操作的方法。重点解决在使用原生SQL查询时,次要数据库的查询错误地指向主要数据库导致“表不存在”的问题。核心解决方案在于为每个数据源明确指定PersistenceUnitName,并在@PersistenceContext注解中引用,确保EntityManager正确绑定到目标数据库。
在spring boot应用程序中处理多个数据源是一个常见的需求,尤其是在需要连接不同业务领域或遗留系统的数据库时。当涉及到jpa和原生sql查询时,如果不进行正确的配置,可能会遇到entitymanager默认指向主数据源,导致在次要数据源上执行原生查询时出现“表不存在”的错误。本文将深入探讨如何正确配置spring boot的双数据源jpa,并解决原生查询的常见陷阱。
多数据源JPA配置基础
在Spring Boot中配置多个JPA数据源,通常需要为每个数据源定义独立的DataSource、LocalContainerEntityManagerFactoryBean(实体管理器工厂)和PlatformTransactionManager(事务管理器)。这确保了每个数据库拥有独立的连接池、实体管理上下文和事务边界。
以下是配置次要数据源(例如名为pims的数据库)的关键步骤:
- 定义数据源:使用@ConfigurationProperties注解从配置文件加载数据源属性,并创建DataSource bean。
- 定义实体管理器工厂:创建LocalContainerEntityManagerFactoryBean,指定数据源、实体扫描包,并设置JPA属性。
- 定义事务管理器:创建JpaTransactionManager,并将其与对应的实体管理器工厂关联。
- 启用JPA仓库:使用@EnableJpaRepositories注解指定仓库接口的包路径,并关联对应的实体管理器工厂和事务管理器。
次要数据源配置示例
以pims数据库为例,其配置类PersistencePimsAutoConfiguration应如下所示:
import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.jdbc.DataSourceBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.PropertySource; import org.springframework.data.jpa.repository.config.EnableJpaRepositories; import org.springframework.orm.jpa.JpaTransactionManager; import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean; import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter; import org.springframework.transaction.PlatformTransactionManager; import javax.sql.DataSource; import java.net.InetAddress; import java.net.UnknownHostException; import java.util.HashMap; @Configuration @PropertySource({"classpath:application.properties"}) @EnableJpaRepositories( basePackages = {"com.xxxx.powwow.dao.pims", "com.xxxx.powwow.repositories.pims"}, entityManagerFactoryRef = "pimsEntityManager", transactionManagerRef = "pimsTransactionManager") public class PersistencePimsAutoConfiguration { private Logger logger = LogManager.getLogger(PersistencePimsAutoConfiguration.class); @Value("${spring.datasource1.jdbc-url}") private String url; @Value("${spring.datasource1.username}") private String username; @Value("${spring.jpa.hibernate.ddl-auto}") private String hbm2ddl; @Value("${spring.jpa.database-platform}") private String platform; @Value("${spring.jpa.properties.hibernate.dialect}") private String dialect; @Value("${spring.profiles.active}") private String profile; @Bean @ConfigurationProperties(prefix="spring.datasource1") public DataSource pimsDataSource() { return DataSourceBuilder.create().build(); } @Bean public LocalContainerEntityManagerFactoryBean pimsEntityManager() { LocalContainerEntityManagerFactoryBean em = new LocalContainerEntityManagerFactoryBean(); em.setDataSource(pimsDataSource()); em.setPackagesToScan(new String[] {"com.xxxx.powwow.entities.pims"}); HibernateJpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter(); em.setJpaVendorAdapter(vendorAdapter); HashMap<String, Object> properties = new HashMap<>(); properties.put("hibernate.hbm2ddl.auto", hbm2ddl); properties.put("hibernate.dialect", dialect); em.setJpaPropertyMap(properties); // *** 关键:为次要数据源设置唯一的持久化单元名称 *** em.setPersistenceUnitName("pimsPersistenceUnit"); String host = null; try { host = InetAddress.getLocalHost().getHostName(); } catch (UnknownHostException e) { throw new RuntimeException(e); } logger.info("Setting spring.datasource1 (pims): hibernate.hbm2ddl.auto='"+hbm2ddl+"', platform='"+platform+"', url='"+url+"', username='"+username+"', host='"+host+"', profile='"+profile+"'."); return em; } @Bean public PlatformTransactionManager pimsTransactionManager() { JpaTransactionManager transactionManager = new JpaTransactionManager(); transactionManager.setEntityManagerFactory(pimsEntityManager().getObject()); return transactionManager; } }
关键改进点:在pimsEntityManager()方法中,我们添加了em.setPersistenceUnitName(“pimsPersistenceUnit”);。这是解决原生查询问题的核心。PersistenceUnitName为这个实体管理器工厂定义了一个唯一的名称,使得在需要注入EntityManager时可以明确指定其来源。
解决原生查询“表不存在”问题
当在DAO层使用@PersistenceContext注入EntityManager时,如果没有明确指定unitName,Spring可能会注入默认的EntityManager(通常是主数据源的)。这会导致在次要数据源上执行原生查询时,查询实际上被发送到了主数据源,从而引发“表不存在”的错误。
为了确保EntityManager正确地与次要数据源关联,需要在@PersistenceContext注解中引用之前定义的PersistenceUnitName。
DAO层原生查询示例
以下是在com.xxxx.powwow.dao.pims包下的BookingHistoryReportDao中执行原生查询的正确方式:
import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import org.springframework.stereotype.Component; import org.springframework.transaction.annotation.Transactional; import javax.persistence.EntityManager; import javax.persistence.PersistenceContext; import javax.persistence.Query; import java.util.Date; import java.util.List; @Component @Transactional("pimsTransactionManager") // 确保使用正确的事务管理器 public class BookingHistoryReportDao { private Logger logger = LogManager.getLogger(BookingHistoryReportDao.class); // *** 关键:指定EntityManager所属的持久化单元 *** @PersistenceContext(unitName = "pimsPersistenceUnit") private EntityManager entityManager; public void executeBookingHistoryReport(Date startDate, Date endDate, List<Integer> companyIds) { final String sql = getSQLBookingHistoryReportDao(); try { Query qry = entityManager.createNativeQuery(sql); List<String> merchants = qry.getResultList(); logger.info("done"); } catch (Exception e) { logger.error("Error executing query for BookingHistoryReport.", e); logger.info(sql); } } private String getSQLBookingHistoryReportDao() { return "select company_name from Merchants limit 100"; } }
关键改进点:在BookingHistoryReportDao中,@PersistenceContext(unitName = “pimsPersistenceUnit”)明确告诉Spring,这里注入的EntityManager应该来自名为pimsPersistenceUnit的持久化单元,即我们为次要数据源pims配置的那个。这样,entityManager.createNativeQuery(sql)就会在正确的数据库上下文中执行。
注意事项与最佳实践
- 命名规范:为每个数据源相关的Bean(DataSource、EntityManager、TransactionManager以及PersistenceUnitName)使用清晰、一致的命名规范,例如primaryDataSource、secondaryEntityManager、primaryPersistenceUnit等,以增强代码可读性和可维护性。
- 事务管理:确保在DAO或Service层使用@Transactional注解时,明确指定其对应的事务管理器(如@Transactional(“pimsTransactionManager”)),以保证操作在正确的事务上下文中执行。
- 实体扫描:@EnableJpaRepositories和em.setPackagesToScan中的包路径必须准确无误,确保Spring能够找到对应的JPA实体和仓库接口。
- 主次数据源分离:建议将主数据源和次数据源的配置分别放在不同的配置类中,或者至少在同一个配置类中通过@Primary注解明确指定主数据源,以避免歧义。
- 配置文件管理:将数据库连接信息等敏感数据外部化到application.properties或application.yml文件中,并使用@ConfigurationProperties进行绑定,提高配置的灵活性和安全性。
总结
在Spring Boot应用中配置多个JPA数据源并成功执行原生查询,关键在于为每个数据源的LocalContainerEntityManagerFactoryBean设置唯一的PersistenceUnitName,并在DAO层通过@PersistenceContext(unitName = “…”)明确指定要注入的EntityManager所属的持久化单元。这一机制确保了即使使用原生查询,EntityManager也能正确地将操作路由到对应的数据库,从而避免了“表不存在”等常见的跨数据库上下文错误。遵循本文所述的配置和最佳实践,将能够构建出健壮、可维护的多数据源Spring Boot应用程序。