Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 464 Commits
.github/workflows		.github/workflows
.mvn/wrapper		.mvn/wrapper
dynamic-datasource-creator		dynamic-datasource-creator
dynamic-datasource-spring-boot-common		dynamic-datasource-spring-boot-common
dynamic-datasource-spring-boot-starter		dynamic-datasource-spring-boot-starter
dynamic-datasource-spring-boot3-starter		dynamic-datasource-spring-boot3-starter
dynamic-datasource-spring-boot4-starter		dynamic-datasource-spring-boot4-starter
dynamic-datasource-spring		dynamic-datasource-spring
native-image		native-image
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
ISSUE_TEMPLATE		ISSUE_TEMPLATE
LICENSE		LICENSE
PULL_REQUEST_TEMPLATE		PULL_REQUEST_TEMPLATE
README.md		README.md
license.txt		license.txt
mvnw		mvnw
mvnw.cmd		mvnw.cmd
pom.xml		pom.xml

Repository files navigation

一个基于springboot的快速集成多数据源的启动器

简介

dynamic-datasource-spring-boot-starter 是一个基于springboot的快速集成多数据源的启动器。

其支持Jdk 1.7+, SpringBoot 1.5.x 2.x.x 3.x.x。

文档 | Documentation

详细文档https://www.kancloud.cn/tracy5546/dynamic-datasource/2264611

贡献 | Contributing

我们欢迎社区的贡献，请查看CONTRIBUTING.md 。

特性

支持数据源分组 ，适用于多种场景纯粹多库读写分离一主多从混合模式。
支持数据库敏感配置信息加密(可自定义) ENC()。
支持每个数据库独立初始化表结构schema和数据库database。
支持无数据源启动，支持懒加载数据源（需要的时候再创建连接）。
支持自定义注解 ，需继承DS(3.2.0+)。
提供并简化对Druid，HikariCp，BeeCp,Dbcp2的快速集成。
提供对Mybatis-Plus，Quartz，ShardingJdbc，P6sy，Jndi等组件的集成方案。
提供自定义数据源来源 方案（如全从数据库加载）。
提供项目启动后动态增加移除数据源 方案。
提供Mybatis环境下的纯读写分离 方案。
提供使用spel动态参数 解析数据源方案。内置spel，session，header，支持自定义。
支持多层数据源嵌套切换 。（ServiceA >>> ServiceB >>> ServiceC）。
提供基于seata的分布式事务方案 。
提供本地多数据源事务方案。

约定

本框架只做切换数据源 这件核心的事情，并不限制你的具体操作，切换了数据源可以做任何CRUD。
配置文件所有以下划线_ 分割的数据源首部即为组的名称，相同组名称的数据源会放在一个组下。
切换数据源可以是组名，也可以是具体数据源名称。组名则切换时采用负载均衡算法切换。
默认的数据源名称为master ，你可以通过spring.datasource.dynamic.primary 修改。
代码块里主动切换>方法上的注解优>类上注解（就近原则）。
DS支持继承抽象类上的DS，支持继承接口上的DS。

使用方法

引入dynamic-datasource-spring-boot-starter或者dynamic-datasource-spring-boot3-starter。

spring-boot 1.5.x 2.x.x

<dependency>    <groupId>com.baomidou</groupId>    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>    <version>${version}</version></dependency>

spring-boot3及以上

<dependency>    <groupId>com.baomidou</groupId>    <artifactId>dynamic-datasource-spring-boot3-starter</artifactId>    <version>${version}</version></dependency>

配置数据源。

spring:datasource:dynamic:enabled:true#启用动态数据源，默认trueprimary:master#设置默认的数据源或者数据源组,默认值即为masterstrict:false#严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源grace-destroy:false#是否优雅关闭数据源，默认为false，设置为true时，关闭数据源时如果数据源中还存在活跃连接，至多等待10s后强制关闭datasource:master:url:jdbc:mysql://xx.xx.xx.xx:3306/dynamicusername:rootpassword:123456driver-class-name:com.mysql.jdbc.Driver# 3.2.0开始支持SPI可省略此配置slave_1:url:jdbc:mysql://xx.xx.xx.xx:3307/dynamicusername:rootpassword:123456driver-class-name:com.mysql.jdbc.Driverslave_2:url:ENC(xxxxx)# 内置加密,使用请查看详细文档username:ENC(xxxxx)password:ENC(xxxxx)driver-class-name:com.mysql.jdbc.Driver#......省略#以上会配置一个默认库master，一个组slave下有两个子库slave_1,slave_2

多主多从：

spring:datasource:dynamic:datasource:master_1:master_2:slave_1:slave_2:slave_3:

纯粹多库：

spring:datasource:dynamic:datasource:mysql:oracle:sqlserver:postgresql:h2:

混合配置：

spring:datasource:dynamic:datasource:master:slave_1:slave_2:oracle_1:oracle_2:

使用@DS 切换数据源。

@DS 可以注解在方法上或类上，同时存在就近原则方法上注解优先于类上注解。

注解	结果
没有@DS	默认数据源
@DS("dsName")	dsName可以为组名也可以为具体某个库的名称

@Service@DS("slave")publicclassUserServiceImplimplementsUserService {@AutowiredprivateJdbcTemplatejdbcTemplate;publicListselectAll() {returnjdbcTemplate.queryForList("select * from user");    }@Override@DS("slave_1")publicListselectByCondition() {returnjdbcTemplate.queryForList("select * from user where age >10");    }}