当前位置:

首页 > 编程开发 > Spring Boot多数据源JPA配置与查询实战

Spring Boot多数据源JPA配置与查询实战

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

本文目录

    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. 注意事项与最佳实践

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

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

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

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

      # Primary DataSource (e.g., datasource0)
      spring.datasource.url=jdbc:postgresql://localhost:5432/powwow
      spring.datasource.username=user_powwow
      spring.datasource.password=password_powwow
      spring.datasource.driver-class-name=org.postgresql.Driver
      
      # Secondary DataSource (e.g., datasource1)
      spring.datasource1.jdbc-url=jdbc:postgresql://localhost:5432/pims
      spring.datasource1.username=user_pims
      spring.datasource1.password=password_pims
      spring.datasource1.driver-class-name=org.postgresql.Driver
      
      # JPA/Hibernate properties (can be shared or specific)
      spring.jpa.hibernate.ddl-auto=none
      spring.jpa.database-platform=org.hibernate.dialect.PostgreSQLDialect
      spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
    5. 主数据源配置: 如果存在一个主数据源,其配置通常不需要显式指定@Primary或额外的PersistenceUnitName,但为了保持一致性和明确性,也可以为其配置一个PersistenceUnitName。

    4. 总结

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

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    QQ影音怎么加速播放视频课程
    QQ影音怎么加速播放视频课程

    播放时右键选播放速度,或点控制条倍速,1.25 到 1.5 倍看课最舒服;公式代码类内容别超过 1.25 倍。

    企业微信创建企业提示失败怎么办 实名与填写检查
    企业微信创建企业提示失败怎么办 实名与填写检查

    先看提示属于哪类:名称占用就加后缀,实名不一致就重填本人信息,证件不清晰就重拍。统一社会信用代码逐位核对,连续三次失败别改材料重投,直接联系客服人工核。

    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?
    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?

    说明源码提交对字符串、生成器和数组的识别边界,以及扫描命令与发行包核验限制。

    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?
    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?

    0.170.0 的语音更新限于终端通话协商能力的明确新增,同名工具服务器跨环境支持仍标注实验性质;连接部分则修复大请求回退、认证竞态和云端重连等具体问题。这份正式版公告不足以证明所有账户、所有客户端都已具备完整语音功能。

    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?
    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?

    了解Hy4 flash、FP8与base的适用任务,阅读官方安装及图文代码,并核对资源和MaaS许可条件。

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化
    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化。说明已核实的更新范围、类型兼容性和本地版本确认方法。

    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?
    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?

    OpenAI Java SDK 4.108.0 面向 Live MCP 工具接入与 Managed Agents 预算状态处理,说明新增模型、事件含义、正式发布范围和适用限制。

    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?
    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?

    Free Claude Code 6.19.37 在自动搜索时保留客户端工具及选择条件,代理执行搜索后仍返回普通调用。说明适用场景、历史信息保留、请求约束与第三方项目的版本边界。

    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?
    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?

    Google GenAI Go SDK 1.78.0 将 Gemini Developer API 默认改为 v1,可用 HTTPOptions.APIVersion 或环境变量保留 v1beta,Vertex AI 默认值不变。

    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?
    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?

    解释实验性实时支持、环境检查与生产评估中需要验证的条件。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。