dynamic-datasource 快速入门(一)

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

简介

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

其支持 Jdk 1.7+, SpringBoot 1.4.x 1.5.x 2.0.x。当前最新版为2.2.3

演示例子 可参考项目下的samples目录。

从 2.0.0 开始它适用于多种场景,常见的场景如下。

  • 纯粹多库,各个库甚至可以是不同的数据库。
  • 读写分离,一主多从,多主多从。
  • 混合模式,既有主从也有单库。

约定

  1. 本框架只做 切换数据源 这件核心的事情,并不限制你的具体操作,切换了数据源可以做任何CRUD。
  2. 配置文件所有以下划线 _ 分割的数据源 首部 即为组的名称,相同组名称的数据源会放在一个组下。
  3. 切换数据源即可是组名,也可是具体数据源名称,切换时默认采用负载均衡机制切换。
  4. 默认的数据源名称为 master ,你可以通过spring.datasource.dynamic.primary修改。
  5. 方法上的注解优先于类上注解。

建议

强烈建议在 主从模式 下遵循普遍的规则,以便他人能更轻易理解你的代码。

数据库 建议 只执行 INSERT UPDATE DELETE 操作。

数据库 建议 只执行 SELECT 操作。

使用方法

  1. 引入dynamic-datasource-spring-boot-starter。

    1
    2
    3
    4
    5
    <dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>${version}</version>
    </dependency>
  2. 配置数据源。
    从 2.0.0 开始所有数据源的 配置同级 ,不再有默认的主从限制,你可以给你的数据源起任何合适的名字。

  • 一主多从方案:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    spring:
    datasource:
    dynamic:
    primary: master #设置默认的数据源或者数据源组,默认值即为master,如果你主从默认下主库的名称就是master可不定义此项。
    datasource:
    master:
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://47.100.20.186:3306/dynamic?characterEncoding=utf8&useSSL=false
    slave_1:
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://47.100.20.186:3307/dynamic?characterEncoding=utf8&useSSL=false
    slave_2:
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://47.100.20.186:3308/dynamic?characterEncoding=utf8&useSSL=false
    #......省略
    #以上会配置一个默认库master,一个组slave下有两个子库slave_1,slave_2
  • 多主多从方案:(谨慎使用,你清楚的知道多个主库间需要自己做同步)

    1
    2
    3
    4
    5
    6
    7
    8
    9
    spring:
    datasource:
    dynamic:
    datasource:
    master_1:
    master_2:
    slave_1:
    slave_2:
    slave_3:
  • 纯粹多库方案:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    spring:
    datasource:
    dynamic:
    primary: mysql #记得设置一个默认数据源
    datasource:
    mysql:
    oracle:
    sqlserver:
    h2:
  • 混合方案:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    spring:
    datasource:
    dynamic:
    datasource:
    master:
    slave_1:
    slave_2:
    oracle_1:
    oracle_2:
    sqlserver:
  1. 使用 @DS 切换数据源。
    @DS 可以注解在方法上和类上,同时存在方法注解优先于类上注解,强烈建议注解在service实现或mapper接口方法上。

注意从2.0.0开始 不再支持@DS空注解 ,你 必须 指明你所需要的数据库 组名 或者 具体某个数据库名称

注解 结果 范围
没有@DS 默认数据源 适用于2.0.0之前
@DS(“dsName”) dsName可以为组名也可以为具体某个库的名称 均适用

集成Druid

springBoot2.x默认使用HikariCP,但在国内Druid的使用者非常庞大,此项目特地对其进行了适配,完成多数据源下使用Druid进行监控。

注意:主从可以使用不同的数据库连接池,如master使用Druid监控,从库使用HikariCP。 如果不配置连接池type类型,默认是Druid优先于HikariCP。

  1. 项目引入druid-spring-boot-starter依赖。

    1
    2
    3
    4
    5
    <dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>${version}</version>
    </dependency>
  2. 排除 原生Druid的快速配置类。

    1
    2
    3
    4
    5
    6
    7
    8
    @SpringBootApplication(exclude = DruidDataSourceAutoConfigure.class)
    public class Application {

    public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
    }

    }

如果遇到DruidDataSourceAutoConfigure抛出no suitable driver表示注解排除没有生效尝试以下这种排除方法

1
2
3
spring:
autoconfigure:
exclude: com.alibaba.druid.spring.boot.autoconfigure.DruidDataSourceAutoConfigure

为什么要排除DruidDataSourceAutoConfigure ?

DruidDataSourceAutoConfigure会注入一个DataSourceWrapper,其会在原生的spring.datasource下找url,username,password等。而我们动态数据源的配置路径是变化的。

  1. 其他属性依旧如原生druid-spring-boot-starter的配置。
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    spring:
    datasource:
    druid:
    stat-view-servlet:
    loginUsername: admin
    loginPassword: 123456
    dynamic:
    druid: # 2.2.3开始提供全局druid参数,以下是默认值和druid原生保持一致
    initial-size: 0
    max-active: 8
    min-idle: 2
    max-wait: -1
    min-evictable-idle-time-millis: 30000
    max-evictable-idle-time-millis: 30000
    time-between-eviction-runs-millis: 0
    validation-query: select 1
    validation-query-timeout: -1
    test-on-borrow: false
    test-on-return: false
    test-while-idle: true
    pool-prepared-statements: true
    max-open-prepared-statements: 100
    filters: stat,wall
    share-prepared-statements: true
    datasource:
    master:
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://47.100.20.186:3306/dynamic?characterEncoding=utf8&useSSL=false
    druid: # 以下参数针对每个库可以重新设置druid参数
    initial-size:
    max-active:
    min-idle:
    max-wait:
    min-evictable-idle-time-millis:
    max-evictable-idle-time-millis:
    time-between-eviction-runs-millis:
    validation-query: select 1 FROM DUAL #比如oracle就需要重新设置这个
    validation-query-timeout:
    test-on-borrow:
    test-on-return:
    test-while-idle:
    pool-prepared-statements:
    max-open-prepared-statements:
    filters:
    share-prepared-statements:

如上即可配置访问用户和密码,访问 http://localhost:8080/druid/index.html 查看druid监控。

集成MybatisPlus

在以前的版本你直接调用的方法是mp提供的内置方法,因其不是我们自己的方法不能切换数据源,你会得到一个NP异常。

从2.1.0开始提供对mp3.x的集成。
从2.2.1开始提供对mp2.x的集成。

1
2
3
4
spring:
datasource:
dynamic:
mp-enabled: true #默认为false,不要随便开启MP,有微小的性能损失
1
2
3
4
5
6
7
8
9
10
11
// 开启后使用mp的内置方法即可注解在类上统一切换数据源,
// 如果想某个方法特殊处理,请自己用一个方法包裹然后注解在该方法上。
@DS("slave")
public interface UserMapper extends BaseMapper<User> {
}

@Service
@DS("slave")
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {

}

自定义

自定义数据源来源。
数据源来源的默认实现是YmlDynamicDataSourceProvider,其从yaml或properties中读取信息并解析出所有数据源信息。

1
2
3
4
5
6
7
8
9
10
public interface DynamicDataSourceProvider {

/**
* 加载所有数据源
*
* @return 所有数据源,key为数据源名称
*/
Map<String, DataSource> loadDataSources();

}