springboot 2.4.4集成 hikari连接池多数据源实例

2023-12-04 08:36

本文主要是介绍springboot 2.4.4集成 hikari连接池多数据源实例,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • 前言
  • 一、配置步骤
    • 1.1 pom配置
    • 1.2 application.properties配置
    • 1.3 DataSourceContextHolder类
    • 1.4 DynamicDataSource
    • 1.5 DataSourceconfig类配置
    • 1.6 配置TargetDataSource注解
    • 1.7 切面方法
    • 1.8 dao的写法
  • 二、测试验证
    • 2.1 启动springboot项目
    • 2.2 检查数据库连接
    • 2.3 debug看其他数据库属性是否生效
    • 2.4 看请求结果
  • 总结


前言

本文章展示如何使用hikari建立多数据源,发现网上的资料不全或者不对,这里展示如何
配置hikari多数据源附带连接池。


一、配置步骤

1.1 pom配置

        <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-jdbc</artifactId></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><scope>runtime</scope></dependency>

这里仅需要这两个包即可,后面的springboot版本默认使用的hikari连接池不需要额外引入包。
在这里插入图片描述

1.2 application.properties配置

spring.datasource.test1.hikari.name=test1
spring.datasource.test1.hikari.driverClassName=com.mysql.cj.jdbc.Driver
spring.datasource.test1.hikari.jdbcurl=jdbc:mysql://localhost:3306/test1?allowMultiQueries=true&serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8&autoReconnect=true&useSSL=false
spring.datasource.test1.hikari.username=root
spring.datasource.test1.hikari.password=123456#客户端向池子请求连接的超时时间,超出则抛出一个SQLException。
#最小值:250毫秒。
#默认值:30000毫秒 单位ms
spring.datasource.test1.hikari.connection-timeout=30000
#控制池允许达到的最大大小,包括两者空闲和正在使用的连接
spring.datasource.test1.hikari.maximum-pool-size=2
#控制HikariCP试图维护的空闲连接的最小数量
spring.datasource.test1.hikari.minimum-idle=2
#控制连接在池中允许空闲的最长时间。单位ms
spring.datasource.test1.hikari.idle-timeout=600000
#控制连接池中连接的最长生命周期。使用中的连接永远不会被弃用,只有当它被关闭时才会被移除。针对每个连接,应用轻微的负面衰减,以避免连接池的大规模灭绝。
#我们强烈建议设置此值,应该比数据库或基础设施强制实施的连接时间限制短几秒钟。如果将其设置为0,则表示没有最大生命周期(无限生命周期),当然还要考虑idleTimeout设置。
#最小允许值为30000ms(30秒)。
#默认值为180000030分钟)
spring.datasource.test1.hikari.max-lifetime=1800000
#控制HikariCP尝试保持连接的频率 适用于空闲连接 5分钟检测一次
spring.datasource.test1.hikari.keep-aliveTime =300000
# 检测连接存活
spring.datasource.test1.hikari.connection-test-query=SELECT 1 FROM DUAL
spring.datasource.test1.hikari.pool-name =test1poolspring.datasource.test2.hikari.name=test2
spring.datasource.test2.hikari.driverClassName=com.mysql.cj.jdbc.Driver
spring.datasource.test2.hikari.jdbcurl=jdbc:mysql://localhost:3306/test2?allowMultiQueries=true&serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8&autoReconnect=true&useSSL=false
spring.datasource.test2.hikari.username=root
spring.datasource.test2.hikari.password=123456#客户端向池子请求连接的超时时间,超出则抛出一个SQLException。
#最小值:250毫秒。
#默认值:30000毫秒 单位ms
spring.datasource.test2.hikari.connection-timeout=30000
#控制池允许达到的最大大小,包括两者空闲和正在使用的连接
spring.datasource.test2.hikari.maximum-pool-size=2
#控制HikariCP试图维护的空闲连接的最小数量
spring.datasource.test2.hikari.minimum-idle=2
#控制连接在池中允许空闲的最长时间。单位ms
spring.datasource.test2.hikari.idle-timeout=600000
#控制连接池中连接的最长生命周期。使用中的连接永远不会被弃用,只有当它被关闭时才会被移除。针对每个连接,应用轻微的负面衰减,以避免连接池的大规模灭绝。
#我们强烈建议设置此值,应该比数据库或基础设施强制实施的连接时间限制短几秒钟。如果将其设置为0,则表示没有最大生命周期(无限生命周期),当然还要考虑idleTimeout设置。
#最小允许值为30000ms(30秒)。
#默认值为180000030分钟)
spring.datasource.test2.hikari.max-lifetime=1800000
#控制HikariCP尝试保持连接的频率 适用于空闲连接 5分钟检测一次
spring.datasource.test2.hikari.keep-aliveTime =300000
# 检测连接存活
spring.datasource.test2.hikari.connection-test-query=SELECT 1 FROM DUAL
spring.datasource.test2.hikari.pool-name =test2poolmybatis.mapperlocations=classpath:com/example/springdemo/demo/dao/*.xml

通用的配置如上面的,具体的含义如上面也做了解释,够一般互联网公司使用了,可以自己再微调参数,根据实际情况配置。

1.3 DataSourceContextHolder类

该类用来保存线程使用的数据源是哪一个。

package com.example.springdemo.demo.conifg.initDataSourceConfig;/*** @author* @version 1.0* @className com.framework.web.config.initDataSourceConfig* @description 动态数据源上下文管理:设置数据源,获取数据源,清除数据源*/
public class DataSourceContextHolder {// 存放当前线程使用的数据源类型private static final ThreadLocal<String> CONTEXT_HOLDER = new ThreadLocal<String>();/*** @param type 1 值* @titel 设置数据源* @description 设置数据源* @author*/public static void setDataSource(String type) {CONTEXT_HOLDER.set(type);}/*** @return java.lang.String* @titel 获取数据源* @description 获取数据源* @author*/public static String getDataSource() {return CONTEXT_HOLDER.get();}/*** @titel 清除数据源* @description 清除数据源* @author*/public static void clearDataSource() {CONTEXT_HOLDER.remove();}}

1.4 DynamicDataSource

获取当前数据源

package com.example.springdemo.demo.conifg.initDataSourceConfig;import com.example.springdemo.demo.conifg.annotation.TargetDataSource;
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;/*** @author* @version 1.0* @className com.framework.web.config.initDataSourceConfig* @description 动态数据源,每执行一次数据库,动态获取数据源*/
public class DynamicDataSource extends AbstractRoutingDataSource {/*** @return java.lang.Object 值* @titel 获取当前数据源* @description 获取当前数据源* @author*/@Overrideprotected Object determineCurrentLookupKey() {return DataSourceContextHolder.getDataSource();}
}

1.5 DataSourceconfig类配置

package com.example.springdemo.demo.conifg.initDataSourceConfig;import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
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.Primary;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.util.StringUtils;import javax.sql.DataSource;
import java.util.HashMap;
import java.util.Map;/*** @author* @version 1.0* @className com.framework.web.config.initDataSourceConfig* @description 数据源初始化类* @datetime 2019/10/11*/
@Configuration
//@EnableTransactionManagement
@MapperScan(value = "com.example.springdemo.demo.dao.**")
public class DataSourceConfig {//    扫描XML路径注入@Value("${mybatis.mapper-locations}")private String mapperLocations;@Bean(name = "test1Config")@ConfigurationProperties(prefix = "spring.datasource.test1.hikari")public HikariConfig test1Config(){return new HikariConfig();}/*** @return javax.sql.DataSource 返回数据源* @title 只读数据源* @description 只读数据源* @author* @datetime 2019/12/27 17:25*/@Bean(name = "test1Datasource")public HikariDataSource readDataSource(HikariConfig test1Config) {return new HikariDataSource(test1Config);}@Bean(name = "test2Config")@ConfigurationProperties(prefix = "spring.datasource.test2.hikari")public HikariConfig test2Config(){return new HikariConfig();}/*** @return javax.sql.DataSource 返回数据源* @title 只写数据源* @description 只写数据源* @author* @datetime 2019/12/27 17:25*/@Bean(name = "test2Datasource")public HikariDataSource setWriteDataSource(HikariConfig test2Config) {return new HikariDataSource(test2Config);}/*** @param dataSource 1 数据源* @return org.mybatis.spring.SqlSessionFactoryBean sql* @title 根据对应的数据源配置Mapper所有xml路径* @description 根据对应的数据源配置Mapper所有xml路径* @author* @datetime 2019/12/27 17:18*/private SqlSessionFactoryBean getSqlSessionFactoryBean(DataSource dataSource) throws Exception {SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();sqlSessionFactoryBean.setDataSource(dataSource);PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();// 配置mapper文件位置sqlSessionFactoryBean.setMapperLocations(resolver.getResources(mapperLocations));return sqlSessionFactoryBean;}/*** @param dynamicDataSource 1 数据源* @return org.apache.ibatis.session.SqlSessionFactory* @titel 根据对应的数据源配置Mapper所有xml路径* @description 根据对应的数据源配置Mapper所有xml路径* @author* @datetime 2019/10/11*/@Beanpublic SqlSessionFactory sqlSessionFactory(DynamicDataSource dynamicDataSource) throws Exception {SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();factoryBean.setDataSource(dynamicDataSource);// 设置mapper.xml的位置路径// 配置mapper文件位置PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();factoryBean.setMapperLocations(resolver.getResources(mapperLocations));return factoryBean.getObject();}/*** @param dynamicDataSource 1 动态数据源* @return org.springframework.transaction.PlatformTransactionManager 返回事务配置* @titel 事务配置* @description 事务配置* @author* @datetime 2019/10/11*/@Beanpublic PlatformTransactionManager transactionManager(DynamicDataSource dynamicDataSource) {return new DataSourceTransactionManager(dynamicDataSource);}/*** @param writeDataSource 2 只写数据源* @return javax.sql.DataSource 返回设置数据源对象* @titel 初始化SQL会话模板* @description 初始化SQL会话模板* @author*/@Beanpublic DynamicDataSource dynamicDataSource(@Qualifier("test1Datasource") DataSource writeDataSource,@Qualifier("test2Datasource") DataSource patentDataDataSource) throws Exception {DynamicDataSource dynamicDataSource = new DynamicDataSource();Map<Object, Object> targetSqlSessionFactorys = new HashMap<Object, Object>();targetSqlSessionFactorys.put("test1Datasource", writeDataSource);targetSqlSessionFactorys.put("test2Datasource", patentDataDataSource);dynamicDataSource.setTargetDataSources(targetSqlSessionFactorys);//设置默认数据源dynamicDataSource.setDefaultTargetDataSource(writeDataSource);return dynamicDataSource;}
}

这里需要注意的是使用带配置的DataSource创建方式,也是官方推荐的新建数据源配置方式,可以提前检测出数据库连接池是否能正常建立。

1.6 配置TargetDataSource注解

该注解用于作用在mapper的方法上,通过aop切面的方式去切换数据源

package com.example.springdemo.demo.conifg.annotation;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;/*** @Author* @ClassName com.framework.common.annotation* @Description 数据源注解类* @Version 1.0*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface TargetDataSource {//默认连接为只读String dataSource() default "";
}

1.7 切面方法

package com.example.springdemo.demo.conifg.initDataSourceConfig;import com.example.springdemo.demo.conifg.annotation.TargetDataSource;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;/*** @author* @version 1.0* @className com.framework.web.config.initDataSourceConfig* @description service事物拦截类,用于动态切换数据源* @datetime 2019/10/11*/
@Aspect
//@Order(-1)//必须加上这个不然会DynamicDataSource比DataSourceAspect先执行
@Component
public class DataSourceAspect {///@Before是在所拦截方法执行之前执行一段逻辑。// @After 是在所拦截方法执行之后执行一段逻辑。// @Around是可以同时在所拦截方法的前后执行一段逻辑。+// 作为@Pointcut的参数,用以定义连接点/*** @titel 配置切面目录* @description 配置切面目录* @author*/@Pointcut("execution(* com.example.springdemo.demo.dao.*.*(..))")public void pointcut() {}/*** @param ds 1 数据源注解* @titel 执行方法前更换数据源* @description 执行方法前更换数据源* @author*/@Before("pointcut() && @annotation(ds)")public void beforeDataSource(TargetDataSource ds) {String value = ds.dataSource();DataSourceContextHolder.setDataSource(value);}/*** @param ds 1 数据源注解* @titel 执行方法后清除数据源设置* @description 执行方法后清除数据源设置* @author*/@After("pointcut() && @annotation(ds)")public void afterDataSource(TargetDataSource ds) {DataSourceContextHolder.clearDataSource();}
}

1.8 dao的写法

如果需要切换数据库的方法,如下加上注解即可切换数据源,否则就是使用默认的数据源,我这里默认数据源为test1source

package com.example.springdemo.demo.dao;import com.example.springdemo.demo.conifg.annotation.TargetDataSource;
import com.example.springdemo.demo.model.User;
import com.example.springdemo.demo.model.User1;
import org.springframework.stereotype.Repository;import java.util.List;@Repository
public interface UserDao2 {@TargetDataSource(dataSource="test2Datasource")User getUser();
}

二、测试验证

启动项目前先看看数据库连接有多少
在这里插入图片描述

2.1 启动springboot项目

日志出现以下的日志时候,说明连接池已经建立了。

2023-12-03 16:28:47.354  INFO 7452 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2023-12-03 16:28:47.354  INFO 7452 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 1347 ms
2023-12-03 16:28:47.471  INFO 7452 --- [           main] com.zaxxer.hikari.HikariDataSource       : test1pool - Starting...
2023-12-03 16:28:47.627  INFO 7452 --- [           main] com.zaxxer.hikari.HikariDataSource       : test1pool - Start completed.
2023-12-03 16:28:47.652  INFO 7452 --- [           main] com.zaxxer.hikari.HikariDataSource       : test2pool - Starting...
2023-12-03 16:28:47.656  INFO 7452 --- [           main] com.zaxxer.hikari.HikariDataSource       : test2pool - Start completed.

2.2 检查数据库连接

在这里插入图片描述
minimum-idle 这里我两个测试库都是最小连接是2,启动项目后,数据库有4个连接,对得上数量。

2.3 debug看其他数据库属性是否生效

在这里插入图片描述
通过debug到dao这层的请求看代理类的属性,可以看到连接池的属性是否和你配置的一致,只有一致才是读到了配置。

2.4 看请求结果

test1测试结果如下
在这里插入图片描述
test2测试结果如下
在这里插入图片描述
结果是正确切换了数据库并且读取到了数据,测试完毕。

总结

1.这里就不展示如何配置dao了,网上的例子很多,也是该掌握后再看本篇文章。
2.使用切面的方式动态切换数据源,否则就是使用默认的数据源。
3.这里的hikari版本如下,版本变动不大,应该都能一样的使用。

    <dependency><groupId>com.zaxxer</groupId><artifactId>HikariCP</artifactId><version>3.4.5</version><scope>compile</scope></dependency>

4.这里需要注意的是如果方法加上了@Transactional 一个方法里面使用了两个数据源,会导致切换数据源失败,因为
事务的控制也是通过数据源的控制实现的不能同时使用两个数据源,要使用多数据源并且支持事务,只能是使用分布式事务控制了,例如seata等。

这篇关于springboot 2.4.4集成 hikari连接池多数据源实例的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/452826

相关文章

SpringBoot中六种批量更新Mysql的方式效率对比分析

《SpringBoot中六种批量更新Mysql的方式效率对比分析》文章比较了MySQL大数据量批量更新的多种方法,指出REPLACEINTO和ONDUPLICATEKEY效率最高但存在数据风险,MyB... 目录效率比较测试结构数据库初始化测试数据批量修改方案第一种 for第二种 case when第三种

Java docx4j高效处理Word文档的实战指南

《Javadocx4j高效处理Word文档的实战指南》对于需要在Java应用程序中生成、修改或处理Word文档的开发者来说,docx4j是一个强大而专业的选择,下面我们就来看看docx4j的具体使用... 目录引言一、环境准备与基础配置1.1 Maven依赖配置1.2 初始化测试类二、增强版文档操作示例2.

一文详解如何使用Java获取PDF页面信息

《一文详解如何使用Java获取PDF页面信息》了解PDF页面属性是我们在处理文档、内容提取、打印设置或页面重组等任务时不可或缺的一环,下面我们就来看看如何使用Java语言获取这些信息吧... 目录引言一、安装和引入PDF处理库引入依赖二、获取 PDF 页数三、获取页面尺寸(宽高)四、获取页面旋转角度五、判断

Spring Boot中的路径变量示例详解

《SpringBoot中的路径变量示例详解》SpringBoot中PathVariable通过@PathVariable注解实现URL参数与方法参数绑定,支持多参数接收、类型转换、可选参数、默认值及... 目录一. 基本用法与参数映射1.路径定义2.参数绑定&nhttp://www.chinasem.cnbs

JAVA中安装多个JDK的方法

《JAVA中安装多个JDK的方法》文章介绍了在Windows系统上安装多个JDK版本的方法,包括下载、安装路径修改、环境变量配置(JAVA_HOME和Path),并说明如何通过调整JAVA_HOME在... 首先去oracle官网下载好两个版本不同的jdk(需要登录Oracle账号,没有可以免费注册)下载完

Spring StateMachine实现状态机使用示例详解

《SpringStateMachine实现状态机使用示例详解》本文介绍SpringStateMachine实现状态机的步骤,包括依赖导入、枚举定义、状态转移规则配置、上下文管理及服务调用示例,重点解... 目录什么是状态机使用示例什么是状态机状态机是计算机科学中的​​核心建模工具​​,用于描述对象在其生命

Spring Boot 结合 WxJava 实现文章上传微信公众号草稿箱与群发

《SpringBoot结合WxJava实现文章上传微信公众号草稿箱与群发》本文将详细介绍如何使用SpringBoot框架结合WxJava开发工具包,实现文章上传到微信公众号草稿箱以及群发功能,... 目录一、项目环境准备1.1 开发环境1.2 微信公众号准备二、Spring Boot 项目搭建2.1 创建

Java中Integer128陷阱

《Java中Integer128陷阱》本文主要介绍了Java中Integer与int的区别及装箱拆箱机制,重点指出-128至127范围内的Integer值会复用缓存对象,导致==比较结果为true,下... 目录一、Integer和int的联系1.1 Integer和int的区别1.2 Integer和in

SpringSecurity整合redission序列化问题小结(最新整理)

《SpringSecurity整合redission序列化问题小结(最新整理)》文章详解SpringSecurity整合Redisson时的序列化问题,指出需排除官方Jackson依赖,通过自定义反序... 目录1. 前言2. Redission配置2.1 RedissonProperties2.2 Red

IntelliJ IDEA2025创建SpringBoot项目的实现步骤

《IntelliJIDEA2025创建SpringBoot项目的实现步骤》本文主要介绍了IntelliJIDEA2025创建SpringBoot项目的实现步骤,文中通过示例代码介绍的非常详细,对大家... 目录一、创建 Spring Boot 项目1. 新建项目2. 基础配置3. 选择依赖4. 生成项目5.