Spring Boot多数据源JPA配置与原生查询实践

本文详细介绍了在Spring Boot应用中配置和管理多个JPA数据源的方法，特别聚焦于如何解决在使用原生SQL查询时可能遇到的“表不存在”问题。通过引入PersistenceUnitName明确绑定EntityManager到特定数据源，并结合@EnableJpaRepositories和@Transactional注解，确保不同数据源上的实体管理和事务操作的正确性与隔离性。

1. 引言与问题背景

在企业级应用开发中，为了满足不同的业务需求或数据隔离策略，一个spring boot应用常常需要连接到多个数据库。spring data jpa为多数据源配置提供了强大的支持。然而，当涉及到原生sql查询时，开发者可能会遇到一个常见的问题：尽管非原生jpa查询（如通过repository方法）在特定数据源上运行正常，但原生sql查询却错误地指向了默认或主数据库，导致“表不存在”（relation “table_name” does not exist）的错误。

这个问题通常源于EntityManager未能正确地与预期的特定数据源关联。Spring JPA在默认情况下，如果没有明确指定，可能会将@PersistenceContext注入的EntityManager与主数据源关联。解决此问题的关键在于明确地将每个数据源的EntityManager绑定到一个唯一的持久化单元名称（PersistenceUnitName）。

2. 多数据源配置核心：PersistenceUnitName

为了确保EntityManager能够正确地指向其所属的数据源，我们需要在配置LocalContainerEntityManagerFactoryBean时为其指定一个唯一的PersistenceUnitName，并在需要注入EntityManager的地方通过@PersistenceContext注解引用这个名称。

2.1 数据源与JPA配置类

以下是一个针对名为“pims”的次要数据源的配置示例，展示了如何设置PersistenceUnitName：

package com.xxxx.powwow.config;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", // 引用pims数据源的EntityManagerFactory        transactionManagerRef = "pimsTransactionManager") // 引用pims数据源的事务管理器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;    /**     * 配置pims数据源。     * 使用@ConfigurationProperties注解从application.properties中读取以"spring.datasource1"为前缀的配置。     */    @Bean    @ConfigurationProperties(prefix="spring.datasource1")    public DataSource pimsDataSource() {        return DataSourceBuilder.create().build();    }    /**     * 配置pims数据源的EntityManagerFactory。     * 关键在于通过em.setPersistenceUnitName("pimsPersistenceUnit")设置唯一的持久化单元名称。     */    @Bean(name = "pimsEntityManager") // 明确指定Bean名称    public LocalContainerEntityManagerFactoryBean pimsEntityManager() {        LocalContainerEntityManagerFactoryBean em = new LocalContainerEntityManagerFactoryBean();        em.setDataSource(pimsDataSource());        em.setPackagesToScan(new String[] {"com.xxxx.powwow.entities.pims"}); // 扫描pims数据源对应的实体类包        em.setPersistenceUnitName("pimsPersistenceUnit"); // 设定唯一的持久化单元名称        HibernateJpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();        em.setJpaVendorAdapter(vendorAdapter);        HashMap properties = new HashMap();        properties.put("hibernate.hbm2ddl.auto", hbm2ddl);        properties.put("hibernate.dialect", dialect);        em.setJpaPropertyMap(properties);        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;    }    /**     * 配置pims数据源的事务管理器。     */    @Bean(name = "pimsTransactionManager") // 明确指定Bean名称    public PlatformTransactionManager pimsTransactionManager() {        JpaTransactionManager transactionManager = new JpaTransactionManager();        transactionManager.setEntityManagerFactory(pimsEntityManager().getObject());        return transactionManager;    }}

关键点说明：

@Configuration：声明这是一个配置类。@PropertySource({“classpath:application.properties”})：加载外部属性文件。@EnableJpaRepositories：启用JPA仓库功能。basePackages：指定该数据源对应的Repository和DAO接口所在的包。entityManagerFactoryRef：引用该数据源的EntityManagerFactory Bean名称。transactionManagerRef：引用该数据源的PlatformTransactionManager Bean名称。pimsDataSource()：通过DataSourceBuilder和@ConfigurationProperties构建数据源，从application.properties中读取spring.datasource1前缀的配置。pimsEntityManager()：em.setDataSource(pimsDataSource())：关联数据源。em.setPackagesToScan()：指定该数据源对应的实体类所在的包，Hibernate会扫描这些包以发现@Entity注解的类。em.setPersistenceUnitName(“pimsPersistenceUnit”)：这是解决问题的核心。它为该EntityManagerFactory定义了一个唯一的逻辑名称，后续在注入EntityManager时可以通过此名称进行引用。em.setJpaPropertyMap()：设置Hibernate相关的JPA属性。pimsTransactionManager()：配置事务管理器，并将其与pimsEntityManager关联。

2.2 DAO层使用EntityManager

在DAO（数据访问对象）层，当需要使用EntityManager执行原生查询时，必须明确指定它应该关联哪个持久化单元。

package com.xxxx.powwow.dao.pims;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") // 确保使用pims数据源的事务管理器public class BookingHistoryReportDao {    private Logger logger = LogManager.getLogger(BookingHistoryReportDao.class);    // 通过unitName明确指定注入pims数据源的EntityManager    @PersistenceContext(unitName = "pimsPersistenceUnit")     private EntityManager entityManager;    public void executeBookingHistoryReport(Date startDate, Date endDate, List companyIds) {        final String sql = getSQLBookingHistoryReportDao();        try {            // 使用正确关联的EntityManager执行原生查询            Query qry = entityManager.createNativeQuery(sql);            List merchants = qry.getResultList();            logger.info("Done executing native query on pims database.");        } catch (Exception e) {            logger.error("Error executing query for BookingHistoryReport.", e);            logger.info("SQL attempted: " + sql);        }    }    private String getSQLBookingHistoryReportDao() {        // 假设Merchants表在pims数据库中        return "select company_name from Merchants limit 100";    }}

关键点说明：

@Component：声明这是一个Spring组件。@Transactional(“pimsTransactionManager”)：指定该DAO类中的方法将使用名为pimsTransactionManager的事务管理器。这对于确保操作在正确的数据库事务上下文中执行至关重要。@PersistenceContext(unitName = “pimsPersistenceUnit”)：这是解决问题的另一个核心部分。它告诉Spring，注入的EntityManager实例必须是与pimsPersistenceUnit这个持久化单元关联的那个。这样，当entityManager.createNativeQuery()被调用时，它就会在pims数据库上执行查询，而不是默认或主数据库。

3. 注意事项与最佳实践

命名规范： 为PersistenceUnitName、EntityManagerFactory和TransactionManager使用清晰且具有辨识度的名称，以便于管理和维护。

蓝心千询

蓝心千询是vivo推出的一个多功能AI智能助手

34 查看详情

包扫描： 确保@EnableJpaRepositories的basePackages和LocalContainerEntityManagerFactoryBean的setPackagesToScan正确地指向了各自数据源的Repository/DAO接口和实体类。错误的包扫描可能导致实体无法被识别或Repository无法被创建。

事务管理： 在使用多数据源时，务必通过@Transactional(value = “yourTransactionManagerRef”)明确指定事务管理器。否则，Spring可能会使用默认的事务管理器，导致事务操作在错误的数据库上执行。

属性配置： application.properties或application.yml中应包含所有数据源的详细配置，例如：

# Primary DataSource (e.g., datasource0)spring.datasource.url=jdbc:postgresql://localhost:5432/powwowspring.datasource.username=user_powwowspring.datasource.password=password_powwowspring.datasource.driver-class-name=org.postgresql.Driver# Secondary DataSource (e.g., datasource1)spring.datasource1.jdbc-url=jdbc:postgresql://localhost:5432/pimsspring.datasource1.username=user_pimsspring.datasource1.password=password_pimsspring.datasource1.driver-class-name=org.postgresql.Driver# JPA/Hibernate properties (can be shared or specific)spring.jpa.hibernate.ddl-auto=nonespring.jpa.database-platform=org.hibernate.dialect.PostgreSQLDialectspring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect

主数据源配置： 如果存在一个主数据源，其配置通常不需要显式指定@Primary或额外的PersistenceUnitName，但为了保持一致性和明确性，也可以为其配置一个PersistenceUnitName。

4. 总结

在Spring Boot应用中处理多JPA数据源，特别是涉及原生SQL查询时，正确配置EntityManager与特定持久化单元的关联至关重要。通过在LocalContainerEntityManagerFactoryBean中设置PersistenceUnitName，并在@PersistenceContext注解中引用该名称，可以确保EntityManager实例正确地指向所需的数据源，从而避免“表不存在”等常见问题，实现多数据源环境下JPA操作的精确控制和隔离。遵循本文提供的配置和使用模式，将有助于构建更健壮、可维护的多数据库Spring Boot应用。

以上就是Spring Boot多数据源JPA配置与原生查询实践的详细内容，更多请关注创想鸟其它相关文章！