如何使用Spring JPA和Hikari CP连接SQL数据库

冷不防 2023-10-09 19:45 11阅读 0赞

> Spring Data JPA是 Spring Data Family中最常见和最成熟的框架。

**微信搜索关注《Java学研大本营》，加入读者群，分享更多精彩**

首先，让我们在深入讨论之前设定议程。在这篇文章中，我们将只讨论如何使用 Spring Data JPA 框架使用 Hikari CP 作为连接池层进行多数据库连接。所以读者应该对 Spring Boot 、 Spring Data JPA 和连接池有基本的了解。

众所周知，Spring Data JPA 是 Spring Data Family 中最常见和最成熟的框架，它将在我们的应用程序 DAO 层中发挥作用。

![bcaddb413b7c6c7f717ed06ca93bd055.png][]

我们需要做的就是在我们的 pom 中添加依赖项，并在应用程序属性文件中配置我们的数据库连接详细信息。所有其他事情都将由 Spring Boot 的自动配置魔法来处理，这意味着无需编写任何单个 Java 代码来配置数据源。

![3fb4bd7ae965a1b8e6f0142db67ccc4a.png][]

在高层次上，Spring 自动配置将使用我们在属性文件中提供的连接详细信息为数据源、实体管理器和事务创建 bean。

![c9350d17aebdf66bd9065850f69ca336.png][]

**数据源**：形成连接对象，包含数据库连接详细信息

**EntityManager** ：它与数据源具有一对一的关系，管理 JPA 实体及其持久化操作。

**事务管理器**：它与实体管理器具有一对一的关系。它处理事务。

之所以讨论这个 JPA 内部，是为了让您知道 JPA 需要这三个 bean 来连接数据库并执行操作。

因此，对于每个数据库连接，您都需要创建这些 bean。考虑一下，如果您的应用程序想要连接 2 个不同的数据库，那么您需要为每个数据库创建这些 bean。这意味着我们在配置阶段创建了多个相同类型的 bean。因此，我们需要用“@Primary”注释其中一个 bean。

![e9ac095a4f4b20a69ae71a8b1b881875.png][]

所以在这里，我将展示一个 Spring JPA 多数据库配置的示例，在我的示例中，将使用 2 个数据库。只是为了解释起见，假设一个数据库是 Oracle（主），另一个是 My SQL。

### 主要数据源配置： ###

这里要注意的一件事是，您必须将 JPA 存储库和实体包链接到 entityManager。

“@EnableJpaRepositories”有一个属性“basePackages”。您必须提及此数据库的存储库文件包名称作为此属性的值。如果您有多个要扫描的包，请用逗号分隔。

“LocalContainerEntityManagerFactoryBean”有一个属性“packageToScan”。您必须在此属性中提及相应的 JPA 实体文件包名称。如果要扫描多个包，则将其传递到字符串数组中。

@Configuration
    @EnableConfigurationProperties({PrimaryDataSourceProperties.class})
    @EnableTransactionManagement
    @EnableJpaRepositories(
            entityManagerFactoryRef="entityManagerFactory",
            basePackages={"com.primary.repo"}
    )
    public class PrimaryDataSource {
    
        @Autowired
        PrimaryDataSourceProperties dataSourceProp;
    
        @Primary
        @Bean(name="dataSource")
        public DataSource primaryDataSource(){
            HikariConfig hikariConfig = new HikariConfig();
            hikariConfig.setUserName(dataSourceProp.getUsername());
            hikariConfig.setPassword(dataSourceProp.getPassword());
            hikariConfig.setJdbcUrl(dataSourceProp.getUrl());
            hikariConfig.setDriverClassName(dataSourceProp.getDriverClassName());
            hikariConfig.setMaximumPoolSize(dataSourceProp.getMaxPoolSize());
            hikariConfig.setMinimumIdle(dataSourceProp.getMinimumIdle());
            hikariConfig.setConnectionTimeout(dataSourceProp.getConnectionTimeOut());
            hikariConfig.setIdleTimeout(dataSourceProp.getIdleTimeOut());
            hikariConfig.setPoolName(dataSourceProp.getPoolName());
            return new HikariDataSource(hikariConfig);
        }
    
        @Primary
        @Bean(name="entityManagerFactory")
        public LocalContainerEntityManagerFactoryBean entityManagerFactory(EntityManagerFactoryBuilder builder,
                                                                           @Qualifier("dataSource") DataSource datasource){
            LocalContainerEntityManagerFactoryBean em = new LocalContainerEntityManagerFactoryBean();
            em.setDataSource(datasource);
            em.setPackageToScan(new String[]{"com.primary.entity"});
            HibernateJpaVendorAdaptor vendorAdaptor = new HibernateJpaVendorAdaptor();
            em.setJpaVendorAdaptor(vendorAdaptor);
            HashMap<String, Object> properties = new HashMap<>();
            properties.put("hibernate.dialect", "org.hibernate.dialect.OracleDialect");
            em.setJpaPropertyMap(properties);
            return em;
        }
    
        @Primary
        @Bean(name="transactionManager")
        public PlatformTransactionManager transactionManager(@Qualifier("entityManagerFactory") EntityManagerFactory entityManagerFactory){
            return new JpaTransactionManager(entityManagerFactory);
        }
    
    }

@ConfigurationProperties(prefix="primary.datasource")
    public class PrimaryDataSourceProperties{
        private String url;
        private String username;
        private String password;
        private String driverClassName;
        private int connectionTimeOut;
        private int idleTimeOut;
        private int maxPoolSize;
        private int minimumIdle;
        private String poolName;
    
        //Getters & Setters
    }

### 辅助数据源配置： ###

@Configuration
    @EnableConfigurationProperties({SecondaryDataSourceProperties.class})
    @EnableTransactionManagement
    @EnableJpaRepositories(
            entityManagerFactoryRef="secondaryEntityManagerFactory",
            basePackages={"com.secondary.repo"}
    )
    public class PrimaryDataSource {
    
        @Autowired
        PrimaryDataSourceProperties dataSourceProp;
    
        @Primary
        @Bean(name="secondaryDataSource")
        public DataSource primaryDataSource(){
            HikariConfig hikariConfig = new HikariConfig();
            hikariConfig.setUserName(dataSourceProp.getUsername());
            hikariConfig.setPassword(dataSourceProp.getPassword());
            hikariConfig.setJdbcUrl(dataSourceProp.getUrl());
            hikariConfig.setDriverClassName(dataSourceProp.getDriverClassName());
            hikariConfig.setMaximumPoolSize(dataSourceProp.getMaxPoolSize());
            hikariConfig.setMinimumIdle(dataSourceProp.getMinimumIdle());
            hikariConfig.setConnectionTimeout(dataSourceProp.getConnectionTimeOut());
            hikariConfig.setIdleTimeout(dataSourceProp.getIdleTimeOut());
            hikariConfig.setPoolName(dataSourceProp.getPoolName());
            return new HikariDataSource(hikariConfig);
        }
    
        @Primary
        @Bean(name="secondaryEntityManagerFactory")
        public LocalContainerEntityManagerFactoryBean entityManagerFactory(EntityManagerFactoryBuilder builder,
                                                                           @Qualifier("secondaryDataSource") DataSource datasource){
            LocalContainerEntityManagerFactoryBean em = new LocalContainerEntityManagerFactoryBean();
            em.setDataSource(datasource);
            em.setPackageToScan(new String[]{"com.secondary.entity"});
            HibernateJpaVendorAdaptor vendorAdaptor = new HibernateJpaVendorAdaptor();
            em.setJpaVendorAdaptor(vendorAdaptor);
            HashMap<String, Object> properties = new HashMap<>();
            properties.put("hibernate.dialect", "org.hibernate.dialect.MySQLDialect");
            em.setJpaPropertyMap(properties);
            return em;
        }
    
        @Primary
        @Bean(name="secondaryTransactionManager")
        public PlatformTransactionManager transactionManager(@Qualifier("secondaryEntityManagerFactory") EntityManagerFactory entityManagerFactory){
            return new JpaTransactionManager(entityManagerFactory);
        }
    
    }

@ConfigurationProperties(prefix="secondary.datasource")
    public class SecondaryDataSourceProperties{
        private String url;
        private String username;
        private String password;
        private String driverClassName;
        private int connectionTimeOut;
        private int idleTimeOut;
        private int maxPoolSize;
        private int minimumIdle;
        private String poolName;
    
        //Getters & Setters
    }

primary.datasource.username=test
    primary.datasource.password=test
    primary.datasource.url=jdbc:oracle:thin:@test:8899/test
    primary.datasource.connectionTimeOut=60000
    primary.datasource.idleTimeOut=900000
    primary.datasource.maxPoolSize=10
    primary.datasource.minimumIdle=10
    
    secondary.datasource.username=test
    secondary.datasource.password=test
    secondary.datasource.url=jdbc:mysql:thin:@test:8899/test
    secondary.datasource.connectionTimeOut=60000
    secondary.datasource.idleTimeOut=900000
    secondary.datasource.maxPoolSize=10
    secondary.datasource.minimumIdle=10

### 推荐书单 ###

#### 《项目驱动零起点学Java》 ####

![6e626c5acd9900d64c81ad9c8ca069b8.png][]

《项目驱动零起点学Java》共分 13 章，围绕 6 个项目和 258 个代码示例，分别介绍了走进Java 的世界、变量与数据类型、运算符、流程控制、方法、数组、面向对象、异常、常用类、集合、I/O流、多线程、网络编程相关内容。《项目驱动零起点学Java》总结了马士兵老师从事Java培训十余年来经受了市场检验的教研成果，通过6 个项目以及每章的示例和习题，可以帮助读者快速掌握Java 编程的语法以及算法实现。扫描每章提供的二维码可观看相应章节内容的视频讲解。

《项目驱动零起点学Java》贯穿6个完整项目，经过作者多年教学经验提炼而得，项目从小到大、从短到长，可以让读者在练习项目的过程中，快速掌握一系列知识点。

马士兵，马士兵教育创始人，毕业于清华大学，著名IT讲师，所讲课程广受欢迎，学生遍布全球大厂，擅长用简单的语言讲授复杂的问题，擅长项目驱动知识的综合学习。马士兵教育获得在线教育“名课堂”奖、“最受欢迎机构”奖。

赵珊珊，从事多年一线开发，曾为国税、地税税务系统工作。拥有7年一线教学经验，多年线上、线下教育的积累沉淀，培养学员数万名，讲解细致，脉络清晰。

**购买链接：https://u.jd.com/XwJWF2r**

> > > > ### 精彩回顾 ###
> > 
> > [想要代码干净又整洁？这里有十大原则][Link 1]
> > 
> > [通过自学成为开发者的 9 种方法][9]
> > 
> > [怎么做一个有产品意识的软件工程师？][Link 2]

> > 微信搜索关注《Java学研大本营》
> > 
> > 访问【IT今日热榜】，发现每日技术热点

[bcaddb413b7c6c7f717ed06ca93bd055.png]: https://img-blog.csdnimg.cn/img_convert/bcaddb413b7c6c7f717ed06ca93bd055.png
[3fb4bd7ae965a1b8e6f0142db67ccc4a.png]: https://img-blog.csdnimg.cn/img_convert/3fb4bd7ae965a1b8e6f0142db67ccc4a.png
[c9350d17aebdf66bd9065850f69ca336.png]: https://img-blog.csdnimg.cn/img_convert/c9350d17aebdf66bd9065850f69ca336.png
[e9ac095a4f4b20a69ae71a8b1b881875.png]: https://img-blog.csdnimg.cn/img_convert/e9ac095a4f4b20a69ae71a8b1b881875.png
[6e626c5acd9900d64c81ad9c8ca069b8.png]: https://img-blog.csdnimg.cn/img_convert/6e626c5acd9900d64c81ad9c8ca069b8.png
[Link 1]: https://mp.weixin.qq.com/s?__biz=MzkzMDM3MjI3Nw==&mid=2247484467&idx=1&sn=a03c98cecf89bf808a36ea3a342c411a&chksm=c27a0be9f50d82ff7c33fc58d06ba1c3c40e4002f3ad2536cc6d23b0754cef741c0740ed1e5f&scene=21#wechat_redirect
[9]: https://mp.weixin.qq.com/s?__biz=MzkzMDM3MjI3Nw==&mid=2247484737&idx=1&sn=65ecbefa3f5bc306763142d86b0caae1&chksm=c27a0a9bf50d838dbdc37210590e27edd029d9f563c377829367fa5bcd1374c44ed01196d339&scene=21#wechat_redirect
[Link 2]: https://mp.weixin.qq.com/s?__biz=MzkzMDM3MjI3Nw==&mid=2247484703&idx=1&sn=b13abaffc02ff89c2c914ca3d1c289d6&chksm=c27a0ac5f50d83d368f7a7015b51c7eb4e463e8551c6c1dc7e4f0982cfb25f2407c9af8f6017&scene=21#wechat_redirect