springboot项目实现多数据源配置使用dynamic-datasource-spring-boot-starter的操作步骤

要在Spring Boot项目中使用 dynamic-datasource-spring-boot-starter 实现多数据源配置，可以按照以下步骤进行操作：

简介

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

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

特性

支持数据源分组，适用于多种场景纯粹多库读写分离一主多从混合模式。

支持数据库敏感配置信息加密 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的分布式事务方案。

提供本地多数据源事务方案（不能和原生spring事务混用）

约定

本框架只做切换数据源这件核心的事情，并不限制你的具体操作，切换了数据源可以做任何CRUD。

配置文件所有以下划线 _ 分割的数据源首部即为组的名称，相同组名称的数据源会放在一个组下。

切换数据源可以是组名，也可以是具体数据源名称。组名则切换时采用负载均衡算法切换。

默认的数据源名称为 master ，你可以通过 spring.datasource.dynamic.primary 修改。

方法上的注解优先于类上注解。

DS支持继承抽象类上的DS，暂不支持继承接口上的DS。

1.添加依赖：

在项目的 pom.xml 文件中添加 dynamic-datasource-spring-boot-starter 依赖：

java 复制代码

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

2.配置数据源：

在项目的配置文件（application.properties 或 application.yml）中配置多个数据源，例如：

java 复制代码

dynamic:
  datasource:
    names: primary, secondary
    primary:
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://localhost:3306/db1?useSSL=false&serverTimezone=UTC
      username: root
      password: password1
    secondary:
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://localhost:3306/db2?useSSL=false&serverTimezone=UTC
      username: root
      password: password2

其它配置示例

java 复制代码

# 多主多从                      纯粹多库（记得设置primary）                   混合配置
spring:                               spring:                               spring:
  datasource:                           datasource:                           datasource:
    dynamic:                              dynamic:                              dynamic:
      datasource:                           datasource:                           datasource:
        master_1:                             mysql:                                master:
        master_2:                             oracle:                               slave_1:
        slave_1:                              sqlserver:                            slave_2:
        slave_2:                              postgresql:                           oracle_1:
        slave_3:                              h2:                                   oracle_2:

以下会配置一个默认库master，一个组slave（组名）下有两个子库slave_1(组名为slave组下的数据源名称slave_1) 和 slave_2(组名为slave组下的数据源名称slave_2)

java 复制代码

spring:
  datasource:
    dynamic:
      primary: master #设置默认的数据源或者数据源组,默认值即为master
      strict: false #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源
      datasource:
        master:
          url: jdbc:mysql://xx.xx.xx.xx:3306/dynamic
          username: root
          password: 123456
          driver-class-name: com.mysql.jdbc.Driver # 3.2.0开始支持SPI可省略此配置
        slave_1:
          url: jdbc:mysql://xx.xx.xx.xx:3307/dynamic
          username: root
          password: 123456
          driver-class-name: com.mysql.jdbc.Driver
        slave_2:
          url: ENC(xxxxx) # 内置加密,使用请查看详细文档
          username: ENC(xxxxx)
          password: ENC(xxxxx)
          driver-class-name: com.mysql.jdbc.Driver
          
       #......省略

LoadBalanceDataSource 进行数据源的轮询切换或负载均衡切换。示例代码如下：

java 复制代码

@Configuration
public class DataSourceConfig 
{
    @Autowired
    private DataSourceProperties dataSourceProperties;
    @Bean
    @ConfigurationProperties(prefix = "dynamic.datasource")
    public DataSource dataSource() 
    {
        return DataSourceBuilder.create().build();
    }
    @Bean
    @Primary
    public DataSourceProvider dataSourceProvider()
    {
        DataSourceProperties.DataSourceType defaultDataSourceType = dataSourceProperties.getType();
        Map<String, DataSource> dataSources = new HashMap<>();
        dataSources.put("primary", dataSourceProperties.getPrimary());
        dataSources.put("secondary", dataSourceProperties.getSecondary());
        DynamicDataSourceProvider dynamicDataSourceProvider = new DynamicDataSourceProvider();
        dynamicDataSourceProvider.setDefaultDataSourceType(defaultDataSourceType);
        dynamicDataSourceProvider.setDataSources(dataSources);
        return dynamicDataSourceProvider;
    }
    @Bean
    public DynamicDataSource dynamicDataSource(DataSourceProvider dataSourceProvider)
    {
        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        dynamicDataSource.setDataSourceProvider(dataSourceProvider);
        return dynamicDataSource;
    }
    @Bean
    public DataSourceTransactionManager transactionManager(DynamicDataSource dynamicDataSource)
    {
        return new DataSourceTransactionManager(dynamicDataSource);
    }
    @Bean
    public SqlSessionFactory sqlSessionFactory(DynamicDataSource dynamicDataSource) throws Exception 
    {
        SqlSessionFactoryBean sessionFactoryBean = new SqlSessionFactoryBean();
        sessionFactoryBean.setDataSource(dynamicDataSource);
        return sessionFactoryBean.getObject();
    }
}

4.使用数据源：

在需要使用不同数据源的地方，可以使用 @DS 注解指定要使用的数据源，

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

java 复制代码

@Service
public class UserService 
{
    @Autowired
    private UserMapper userMapper;
    @DS("primary")
    public User getPrimaryUserById(Long id) 
    {
        return userMapper.selectById(id);
    }
    @DS("secondary")
    public User getSecondaryUserById(Long id)
    {
        return userMapper.selectById(id);
    }
}