在spring boot应用中集成多个关系型数据库是常见的需求，尤其是在微服务架构或遗留系统改造中。虽然spring boot为单数据源提供了强大的自动配置能力，但当需要管理多个数据源时，开发者需要进行更细致的手动配置。本文将重点探讨在多数据源环境下，如何正确配置jpa以支持原生sql查询，并解决原生查询默认指向主数据源的问题。
Spring Boot多数据源JPA配置核心要素配置多个JPA数据源需要为每个数据源独立定义以下核心组件：
- 数据源（DataSource）：连接到特定数据库的物理连接池。
- 实体管理器工厂（EntityManagerFactory）：JPA的核心接口，用于创建EntityManager实例，管理实体生命周期和持久化操作。
- 事务管理器（PlatformTransactionManager）：管理与特定数据源关联的事务。
- JPA仓库（JpaRepositories）：指定扫描哪些包下的Repository接口与当前数据源关联。
为了避免不同数据源之间的混淆，尤其是在执行原生查询时，关键在于为每个实体管理器工厂分配一个唯一的“持久化单元名称”（Persistence Unit Name），并在注入EntityManager时明确指定该名称。
次要数据源（Pims）的配置示例假设我们有一个主数据源（powwow）和一个次要数据源（pims），以下是pims数据源的配置示例：
@Configuration
@PropertySource({"classpath:application.properties"}) // 可根据实际情况调整属性文件
@EnableJpaRepositories(
basePackages = {"com.xxxx.powwow.dao.pims", "com.xxxx.powwow.repositories.pims"}, // 指定Pims数据源的DAO和Repository包
entityManagerFactoryRef = "pimsEntityManager", // 引用Pims的EntityManagerFactory
transactionManagerRef = "pimsTransactionManager") // 引用Pims的TransactionManager
public class PersistencePimsAutoConfiguration {
// 从application.properties或其他配置源注入数据源相关属性
@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;
/**
* 定义Pims数据源
* 使用@ConfigurationProperties注解，将以"spring.datasource1"为前缀的属性绑定到DataSourceBuilder
*/
@Bean
@ConfigurationProperties(prefix="spring.datasource1")
public DataSource pimsDataSource() {
return DataSourceBuilder.create().build();
}
/**
* 定义Pims实体管理器工厂
* 这是解决原生查询问题的关键所在。
*/
@Bean
public LocalContainerEntityManagerFactoryBean pimsEntityManager() {
LocalContainerEntityManagerFactoryBean em = new LocalContainerEntityManagerFactoryBean();
em.setDataSource(pimsDataSource()); // 关联Pims数据源
em.setPackagesToScan(new String[] {"com.xxxx.powwow.entities.pims"}); // 指定Pims数据源的实体类包
HibernateJpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();
em.setJpaVendorAdapter(vendorAdapter);
// 设置Hibernate JPA属性
HashMap<String, Object> properties = new HashMap<>();
properties.put("hibernate.hbm2ddl.auto", hbm2ddl);
properties.put("hibernate.dialect", dialect);
em.setJpaPropertyMap(properties);
// *** 核心解决方案：设置唯一的持久化单元名称 ***
em.setPersistenceUnitName("pimsPersistenceUnit");
return em;
}
/**
* 定义Pims事务管理器
*/
@Bean
public PlatformTransactionManager pimsTransactionManager() {
JpaTransactionManager transactionManager = new JpaTransactionManager();
// 确保事务管理器关联到正确的实体管理器工厂
transactionManager.setEntityManagerFactory(pimsEntityManager().getObject());
return transactionManager;
}
} 在application.properties中，你需要为spring.datasource1配置Pims数据库的连接信息：
# Pims Data Source Configuration spring.datasource1.jdbc-url=jdbc:postgresql://localhost:5432/pims spring.datasource1.username=pims_user spring.datasource1.password=pims_password spring.datasource1.driver-class-name=org.postgresql.Driver # JPA/Hibernate Common Properties (can be specific to each datasource if needed) spring.jpa.hibernate.ddl-auto=none spring.jpa.database-platform=org.hibernate.dialect.PostgreSQLDialect spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialectDAO层中原生查询的正确姿势
一旦实体管理器工厂配置了PersistenceUnitName，在DAO层注入EntityManager时，就需要明确指定要使用的持久化单元。
@Component
@Transactional("pimsTransactionManager") // 确保事务管理器指向Pims数据源
public class BookingHistoryReportDao {
// *** 核心解决方案：通过unitName指定EntityManager关联的持久化单元 ***
@PersistenceContext(unitName = "pimsPersistenceUnit")
private EntityManager entityManager;
public void executeBookingHistoryReport(Date startDate, Date endDate, List<Integer> companyIds) {
final String sql = getSQLBookingHistoryReportDao();
try {
// 使用当前EntityManager执行原生SQL查询
Query qry = entityManager.createNativeQuery(sql);
List<String> merchants = qry.getResultList();
// ... 业务逻辑
} catch (Exception e) {
// 错误处理
throw new RuntimeException("Error executing query for BookingHistoryReport.", e);
}
}
private String getSQLBookingHistoryReportDao() {
// 这是一个针对Pims数据库的表
return "select company_name from Merchants limit 100";
}
} 通过在@PersistenceContext注解中明确指定unitName = "pimsPersistenceUnit"，我们确保了注入的entityManager实例是与pimsEntityManager（即Pims数据源）关联的，从而使得原生查询能够正确地作用于Pims数据库，而不是默认的主数据源。
注意事项与最佳实践-
主数据源的声明： 如果存在多个数据源，并且其中一个希望作为默认数据源（例如，当没有明确指定unitName时），可以在其DataSource、EntityManagerFactory和PlatformTransactionManager的@Bean定义上添加@Primary注解。
@Bean @Primary public DataSource primaryDataSource() { /* ... */ } @Bean @Primary public LocalContainerEntityManagerFactoryBean primaryEntityManager() { /* ... */ } @Bean @Primary public PlatformTransactionManager primaryTransactionManager() { /* ... */ }这有助于Spring在没有明确指定的情况下进行自动注入。
包扫描隔离： 确保每个数据源的@EnableJpaRepositories注解中的basePackages和LocalContainerEntityManagerFactoryBean中的packagesToScan指向各自独立的实体类、DAO和Repository接口所在的包。这能有效避免实体类或Repository被错误的数据源关联。
事务隔离： 在@Transactional注解中，务必通过value或transactionManagerRef属性明确指定要使用的事务管理器，例如@Transactional("pimsTransactionManager")。这确保了特定业务操作的事务作用于正确的数据源。
配置属性前缀： 为不同的数据源使用不同的配置前缀（例如spring.datasource1、spring.datasource2），这样在application.properties中可以清晰地管理各个数据源的配置。
DDL自动更新： 在多数据源环境中，通常建议将spring.jpa.hibernate.ddl-auto设置为none或validate，避免Hibernate在启动时对所有关联的数据库执行Schema更新，这可能导致意外的数据丢失或结构冲突。数据库Schema的更新通常通过Flyway或Liquibase等工具进行版本管理。
在Spring Boot应用中配置多个JPA数据源并正确执行原生SQL查询，核心在于为每个LocalContainerEntityManagerFactoryBean配置一个唯一的PersistenceUnitName，并在DAO层通过@PersistenceContext(unitName = "...")明确指定要注入的EntityManager实例。结合清晰的包扫描、事务管理以及合理的配置命名规范，可以构建出健壮且易于维护的多数据源Spring Boot应用。
以上就是Spring Boot多数据源JPA原生查询配置指南的详细内容，更多请关注知识资源分享宝库其它相关文章！
发表评论:
◎欢迎参与讨论，请在这里发表您的看法、交流您的观点。