springboot+MybatisPlus+HikariCP实现多数据源动态切换

在实际工作中，我们的系统可能是多个数据源，通过集成MyBatis-Plus和HikariCP实现多数据源动态切换是一个常见的需求。以下是一个详细的实现步骤，你可以根据自己的需要进行调整。

1. 添加依赖

首先，在pom.xml文件中添加所需的依赖：

s-Plus和HikariCP实现多数据源动态切换是一个常见的需求。以下是一个详细的实现步骤，你可以根据自己的需要进行调整。

1. 添加依赖
首先，在pom.xml文件中添加所需的依赖：

<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.7.5</version>
		<relativePath />
</parent>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-aop</artifactId>
		</dependency>
		<!-- MyBatis-Plus -->
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-boot-starter</artifactId>
			<version>3.5.5</version>
		</dependency>
		<!-- 数据库驱动 -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<scope>runtime</scope>
		</dependency>
	</dependencies>

HikariCP数据源不需要额外导包，springboot自动引入

2. 配置数据源属性

在application.yml文件中配置多个数据源属性：

3. 配置数据源

创建一个配置类来配置多个数据源：

package com.work.config;
import java.util.HashMap;
import java.util.Map;
import javax.sql.DataSource;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Qualifier;
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.jdbc.datasource.DataSourceTransactionManager;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean;
import com.work.enums.DatabaseTypeEnum;
import com.zaxxer.hikari.HikariDataSource;

/**
 * springboot整合mybatis-plus 实现多数据源动态切换
 * 配置数据源和事务管理器 
 * @author summer
 */
@Configuration
@MapperScan(basePackages = "com.work.mapper", sqlSessionFactoryRef = "sqlSessionFactory")
public class DataSourceConfig {
	/**
	 * 主库数据源
	 * @return
	 */
    @Bean(name = "masterDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.master")
    public DataSource masterDataSource() {
        return DataSourceBuilder.create().type(HikariDataSource.class).build();
    }
    
    /**
     * 从库数据源
     * @return
     */
    @Bean(name = "slaveDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.slave")
    public DataSource slaveDataSource() {
        return DataSourceBuilder.create().type(HikariDataSource.class).build();
    }
    
    /**
     * 动态切换数据源
     * @param masterDataSource
     * @param slaveDataSource
     * @return
     */
    @Primary
    @Bean(name = "dynamicDataSource")
    public DataSource dynamicDataSource(@Qualifier("masterDataSource") DataSource masterDataSource,
                                               @Qualifier("slaveDataSource") DataSource slaveDataSource) {
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put(DatabaseTypeEnum.MASTER.getDatabaseType(), masterDataSource);
        targetDataSources.put(DatabaseTypeEnum.SLAVE.getDatabaseType(), slaveDataSource);

        DynamicRoutingDataSource dataSource = new DynamicRoutingDataSource();
        //设置默认的数据源，当没有指定数据源时，将使用主库为默认数据源
        dataSource.setDefaultTargetDataSource(masterDataSource);
        //将配置好的多数据源设置到DynamicRoutingDataSource中
        dataSource.setTargetDataSources(targetDataSources);
        return dataSource;
    }
    
	/**
	 * 配置sqlSession
	 * @param dataSource
	 * @return
	 * @throws Exception
	 */
    @Bean
    public SqlSessionFactory sqlSessionFactory(@Qualifier("dynamicDataSource") DataSource dataSource) throws Exception {
    	 // 导入mybatissqlsession配置
        MybatisSqlSessionFactoryBean sessionFactory = new MybatisSqlSessionFactoryBean();
        // 指明数据源
        sessionFactory.setDataSource(dataSource);
        //多数据源必须在定义数据源时添加以下2句，否则分页插件无效
        Interceptor[] interceptors = new Interceptor[] { mybatisPlusInterceptor() };
        sessionFactory.setPlugins(interceptors);
        // 返回SqlSessionFactory实例，用于创建SqlSession，使用SqlSession调用sql时不需要指定数据源，因为就在此处指定了
        return sessionFactory.getObject();
    }
    
    /**
     * 配置事务管理器
     * @param dataSource
     * @return
     */
    @Bean
    public DataSourceTransactionManager transactionManager(@Qualifier("dynamicDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
    
    /**
	 * mybatis-Plus 分页配置
	 * 注意：如果是单数据源，此时分页插件能正常使用，而如果是多数据源，那么还需在配置SqlSessionFactory的地方再添加配置，否则分页时查询总数total还是0
	 * @return
	 */
	@Bean
	public MybatisPlusInterceptor mybatisPlusInterceptor() {
		MybatisPlusInterceptor mybatisPlusInterceptor=new MybatisPlusInterceptor();
		PaginationInnerInterceptor paginationInnerInterceptor=new PaginationInnerInterceptor();
		paginationInnerInterceptor.setDbType(DbType.MYSQL);
		paginationInnerInterceptor.setOverflow(true);
		mybatisPlusInterceptor.addInnerInterceptor(paginationInnerInterceptor);
		return mybatisPlusInterceptor;
	}
}

4.定义数据库类型枚举

package com.work.enums;
/**
 * 数据库类型枚举
 * @author summer
 *
 */
public enum DatabaseTypeEnum {
	MASTER("master", "主库"),
    SLAVE("slave", "从库"),
    ;
    private final String databaseType;
    private final String msg;
    DatabaseTypeEnum(String databaseType, String msg) {
        this.databaseType = databaseType;
        this.msg = msg;
    }
	public String getDatabaseType() {
		return databaseType;
	}
	public String getMsg() {
		return msg;
	}
}

5.动态切换数据源

使用AOP或者注解的方式实现数据源的动态切换

package com.work.aspect;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;
import com.work.config.DynamicRoutingDataSource;
import com.work.enums.DatabaseTypeEnum;

/**
 * AOP 实现动态数据源切换
 * @author summer
 *
 */
@Aspect
@Component
public class DataSourceAspect {

    @Before("@annotation(com.work.target.ReadOnly)")
    public void useSlaveDataSource() {
    	DynamicRoutingDataSource.setDataSource(DatabaseTypeEnum.SLAVE.getDatabaseType());
    }

    @Before("@annotation(com.work.target.WriteOnly)")
    public void useMasterDataSource() {
    	DynamicRoutingDataSource.setDataSource(DatabaseTypeEnum.MASTER.getDatabaseType());
    }

    //需要每次清空ThreadLocal的内容，防止内存泄漏
    @After("@annotation(com.work.target.ReadOnly) || @annotation(com.work.target.WriteOnly)")
    public void clearDataSource() {
    	DynamicRoutingDataSource.clearDataSource();
    }
}

创建自定义注解：

package com.work.target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * 读数据标识注解
 * @author summer
 *
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ReadOnly {
	
}

package com.work.target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * 写数据标识注解
 * @author summer
 *
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface WriteOnly {
	
}

实现DynamicRoutingDataSource类来管理数据源切换：

package com.work.config;
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
/**
 * 动态主从数据源
 * 使用 ThreadLocal来持有当前线程的数据源类型
 * @author summer
 *
 */
public class DynamicRoutingDataSource extends AbstractRoutingDataSource{
	private static final ThreadLocal<String> CONTEXT_HOLDER = new ThreadLocal<>();

    public static void setDataSource(String dataSource) {
        CONTEXT_HOLDER.set(dataSource);
    }

    public static void clearDataSource() {
        CONTEXT_HOLDER.remove();
    }

    @Override
    protected Object determineCurrentLookupKey() {
        return CONTEXT_HOLDER.get();
    }
}

6.编写测试类

实体类：

package com.work.model.db;
import java.util.Date;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;

import lombok.Data;
@Data
@TableName(value = "check_code_info")
public class CheckCodeInfo {
	/**
	 * 主键ID  自增长
	 */
	@TableId(type = IdType.AUTO)
	private Integer id;
	private String token;
    private String checkCode;
    /**
     * 使用状态1:未使用2:已使用
     */
    private Integer status;
    /**
     * 创建时间
     */
//    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date createTime;
    
    /**
     * 更新时间
     */
//    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date updateTime;
    /**
     * 过期时间
     */
//    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date expiTime;
}

mapper类：

package com.work.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.work.model.db.CheckCodeInfo;

public interface CheckCodeInfoMapper extends BaseMapper<CheckCodeInfo>{
    
}

Service类：

package com.work.service;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.work.model.db.CheckCodeInfo;

public interface CheckCodeInfoService {
	/**
	 * 读数据
	 * @param 
	 * @return
	 */
	IPage<CheckCodeInfo> getCheckCodeInfoList(int currentPage, int pageSize);
	
	/**
	 * 添加数据
	 */
	boolean addCheckCodeInfo();
}

Service实现类：

首先，在pom.xml文件中添加所需的依赖：

package com.work.service.impl;
import java.util.Date;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.work.mapper.CheckCodeInfoMapper;
import com.work.model.db.CheckCodeInfo;
import com.work.service.CheckCodeInfoService;
import com.work.target.ReadOnly;
import com.work.target.WriteOnly;

import cn.hutool.core.util.RandomUtil;

@Service
public class CheckCodeInfoServiceImpl implements CheckCodeInfoService {
	@Autowired
	private CheckCodeInfoMapper checkCodeInfoMapper;
	/**
	 * 测试分页查询
	 * 读数据注解
	 */
	@ReadOnly
	@Override
	public IPage<CheckCodeInfo> getCheckCodeInfoList(int currentPage, int pageSize) {
//		LambdaQueryWrapper<CheckCodeInfo> lambdaQueryWrapper=new LambdaQueryWrapper<CheckCodeInfo>();
		//分页参数  mybatis-plus自带的分页，传入当前页码和每页条数
		Page<CheckCodeInfo> page=new Page<CheckCodeInfo>(currentPage,pageSize);
		//调用Mapper的分页查询方法，传入Page对象和查询条件（这里为null表示无条件查询）
		IPage<CheckCodeInfo> pageResult=checkCodeInfoMapper.selectPage(page, null);
		// 从 从库查询数据
		return pageResult;
	}
	
	/**
	 * 测试写数据
	 * 写数据注解
	 */
	@WriteOnly
	@Override
	public boolean addCheckCodeInfo() {
		CheckCodeInfo checkCodeInfo = new CheckCodeInfo();
		checkCodeInfo.setToken(RandomUtil.randomString(30));
		checkCodeInfo.setCheckCode(RandomUtil.randomNumbers(3));
		checkCodeInfo.setCreateTime(new Date());
		checkCodeInfo.setUpdateTime(new Date());
		int num = checkCodeInfoMapper.insert(checkCodeInfo);
		// 写入主库
		return num > 0 ? true : false;
	}
}

测试Controller类：

package com.work.controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.work.common.result.CommonResult;
import com.work.model.db.CheckCodeInfo;
import com.work.service.CheckCodeInfoService;

/**
 * 动态切换多数据源，测试Controller类
 * @author summer
 *
 */
@RestController
@RequestMapping("/checkCode")
public class DataSourceTestController {
	@Autowired
    private CheckCodeInfoService checkCodeInfoService;
    
    /**
     * 测试数据源动态切换，从 从库读取数据
     * @return
     */
    @GetMapping("/getCheckCodeInfoList")
    public CommonResult<IPage<CheckCodeInfo>> getCheckCodeInfoList(@RequestParam(defaultValue = "1") int currentPage,
            @RequestParam(defaultValue = "10") int pageSize) {
    	return CommonResult.success(checkCodeInfoService.getCheckCodeInfoList(currentPage,pageSize));
    }
    
    /**
     * 测试数据源动态切换，从 从库读取数据
     * @return
     */
    @PostMapping("/addCheckCodeInfo")
    public CommonResult<Boolean> addCheckCodeInfo() {
    	return CommonResult.success(checkCodeInfoService.addCheckCodeInfo());
    }
}

postMan测试：

主库：

测试从库查询：

从库：

7.控制台结果，也能看到确实使用了HikariCP的数据库连接池，这样就大公告成了

name	描述	构造器默认值	默认配置validate之后的值	validate重置
autoCommit	自动提交从池中返回的连接	TRUE	TRUE	–
connectionTimeout	等待来自池的连接的最大毫秒数	SECONDS.toMillis(30) = 30000	30000	如果小于250毫秒，则被重置回30秒
idleTimeout	连接允许在池中闲置的最长时间	MINUTES.toMillis(10) = 600000	600000	如果idleTimeout+1秒>maxLifetime 且 maxLifetime>0，则会被重置为0（代表永远不会退出）；如果idleTimeout!=0且小于10秒，则会被重置为10秒
maxLifetime	池中连接最长生命周期	MINUTES.toMillis(30) = 1800000	1800000	如果不等于0且小于30秒则会被重置回30分钟
connectionTestQuery	如果您的驱动程序支持JDBC4，我们强烈建议您不要设置此属性	null	null	–
minimumIdle	池中维护的最小空闲连接数	-1	10	minIdle<0或者minIdle>maxPoolSize,则被重置为maxPoolSize
maximumPoolSize	池中最大连接数，包括闲置和使用中的连接	-1	10	如果maxPoolSize小于1，则会被重置。当minIdle<=0被重置为DEFAULT_POOL_SIZE则为10;如果minIdle>0则重置为minIdle的值
metricRegistry	该属性允许您指定一个 Codahale / Dropwizard MetricRegistry 的实例，供池使用以记录各种指标	null	null	–
healthCheckRegistry	该属性允许您指定池使用的Codahale / Dropwizard HealthCheckRegistry的实例来报告当前健康信息	null	null	–
poolName	连接池的用户定义名称，主要出现在日志记录和JMX管理控制台中以识别池和池配置	null	HikariPool-1	–
initializationFailTimeout	如果池无法成功初始化连接，则此属性控制池是否将 fail fast	1	1	–
isolateInternalQueries	是否在其自己的事务中隔离内部池查询，例如连接活动测试	FALSE	FALSE	–
allowPoolSuspension	控制池是否可以通过JMX暂停和恢复	FALSE	FALSE	–
readOnly	从池中获取的连接是否默认处于只读模式	FALSE	FALSE	–
registerMbeans	是否注册JMX管理Bean（MBeans）	FALSE	FALSE	–
catalog	为支持 catalog 概念的数据库设置默认 catalog	driver default	null	–
connectionInitSql	该属性设置一个SQL语句，在将每个新连接创建后，将其添加到池中之前执行该语句。	null	null	–
driverClassName	HikariCP将尝试通过仅基于jdbcUrl的DriverManager解析驱动程序，但对于一些较旧的驱动程序，还必须指定driverClassName	null	null	–
transactionIsolation	控制从池返回的连接的默认事务隔离级别	null	null	–
validationTimeout	连接将被测试活动的最大时间量	SECONDS.toMillis(5) = 5000	5000	如果小于250毫秒，则会被重置回5秒
leakDetectionThreshold	记录消息之前连接可能离开池的时间量，表示可能的连接泄漏	0	0	如果大于0且不是单元测试，则进一步判断：(leakDetectionThreshold < SECONDS.toMillis(2) or (leakDetectionThreshold > maxLifetime && maxLifetime > 0)，会被重置为0 . 即如果要生效则必须>0，而且不能小于2秒，而且当maxLifetime > 0时不能大于maxLifetime
dataSource	这个属性允许你直接设置数据源的实例被池包装，而不是让HikariCP通过反射来构造它	null	null	–
schema	该属性为支持模式概念的数据库设置默认模式	driver default	null	–
threadFactory	此属性允许您设置将用于创建池使用的所有线程的java.util.concurrent.ThreadFactory的实例。	null	null	–
scheduledExecutor	此属性允许您设置将用于各种内部计划任务的java.util.concurrent.ScheduledExecutorService实例	null	null	–

posted @ 2025-02-07 11:57 CharyGao 阅读(331) 评论(0) 收藏举报

刷新页面返回顶部

硅基文明

代码改变不了世界，但是改变世界需要代码。

springboot+MybatisPlus+HikariCP实现多数据源动态切换

1. 添加依赖

2. 配置数据源属性

3. 配置数据源

4.定义数据库类型枚举

5.动态切换数据源

使用AOP或者注解的方式实现数据源的动态切换

创建自定义注解：

实现DynamicRoutingDataSource类来管理数据源切换：

6.编写测试类

实体类：

mapper类：

Service类：

Service实现类：

测试Controller类：

postMan测试：

主库：

测试从库查询：

从库：

7.控制台结果，也能看到确实使用了HikariCP的数据库连接池，这样就大公告成了

Spring Boot 2.x基础教程：默认数据源Hikari的配置详解

基本概念

默认数据源：HikariCP

代码示例

参考资料

数据源配置

嵌入式数据库支持

连接生产数据源

连接JNDI数据源

使用JdbcTemplate操作数据库

准备数据库

编写领域对象

编写数据访问对象

编写单元测试用例

Hikari 数据源参数配置说明

数据源配置

嵌入式数据库支持

连接生产数据源

连接JNDI数据源

使用JdbcTemplate操作数据库

准备数据库

编写领域对象

编写数据访问对象

编写单元测试用例

一、简介

1、概述

2、地址

二、配置参数

1、Hikari原生参数

2、Springboot中参数

三、springboot中使用

四、自定义数据源

1、各模块

2、完整代码

3、多数据源

五、多数据源dynamic中使用

1、简介

2、引入依赖

3、参数配置

六、XMind整理