Saas系统多租户方案---springboot+dynamic-datasource动态数据源的保姆级教程

置顶一个努力成长的咸鱼

于 2024-07-21 14:25:20 发布

阅读量297

点赞数 7

文章标签： spring boot sass 后端数据库

本文链接：https://blog.csdn.net/l674582579/article/details/133277568

版权

5.重写spirngboot的run方法加载主库配置的所有数据源

6.动态数据源的使用 @DS("#header.companyCode")

一、方案的基本原理说明

1.方案说明

同一个应用+每个租户使用一个独立的库（共享DB, 使用独立Schema)
主库存储租户数据库和租户信息等,分库作为各租户库存储各租户资料数据,应用直接链接主库通过主库读取各租户的数据库链接信息采用JDBC的方式加载所有的数据源。通过租户的唯一标识(如企业编码)读取租户相应的库。具体实现通过Dynamic-Datasource实现

2.Dynamic-Datasource实现原理

数据源自动配置：Dynamic-Datasource支持基于配置文件或注解的方式自动配置数据源，简化了数据源的初始化过程。
动态数据源切换：Dynamic-Datasource提供了动态切换数据源的功能，可以在运行时根据业务需求选择不同的数据源。
数据源路由：Dynamic-Datasource支持自定义数据源路由规则，可以根据请求参数、注解等信息路由到不同的数据源。
数据源连接池管理：Dynamic-Datasource内置了连接池管理功能，可以有效地管理和维护数据源连接，提高了系统的稳定性和性能。
灵活的数据源配置：Dynamic-Datasource支持自定义数据源配置，如连接池大小、连接超时时间等，满足了不同业务场景的需求。

二、方案应用

1.准备工作

创建主数据库及分数据库，主数据库创建企业信息及数据库链接信息表

2. 引入依赖

在pom.xml文件中加入以下依赖：

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

3.配置文件配置数据源

spring:
  application:
    name: saas
  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8848
      discovery:
        server-addr: 127.0.0.1:8848
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://192.168.110.3:3306/saas
    username: xxx
    password: xxx
    type: com.zaxxer.hikari.HikariDataSource
    dynamic:
      enabled: true

4.springboot项目注入配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyDynamicDataSourceConfig {

    // 定义动态数据源处理器链的Bean
    @Bean
    public DsProcessor dsProcessor() {
        // 创建处理器链的起始点：头部信息处理器
        DsProcessor headerProcessor = new DsHeaderProcessor();
        // 创建会话处理器
        DsProcessor sessionProcessor = new DsSessionProcessor();
        // 创建SpEL表达式处理器
        DsProcessor spelProcessor = new DsSpelExpressionProcessor();
        // 设置处理器链的顺序：头部信息处理器 -> 会话处理器 -> SpEL表达式处理器
        headerProcessor.setNextProcessor(sessionProcessor);
        sessionProcessor.setNextProcessor(spelProcessor);
        // 返回处理器链的起始点
        return headerProcessor;
    }
}

//说明：
matches(String key) 方法检查键是否以 #header 开头，以确定是否由该处理器处理。
doDetermineDatasource(MethodInvocation invocation, String key) 方法根据请求中指定的头部信息键获取对应的头部值作为数据源。

import org.aopalliance.intercept.MethodInvocation;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

public class DsHeaderProcessor extends DsProcessor {

    private static final String HEADER_PREFIX = "#header";

    // 判断是否匹配指定的键
    @Override
    public boolean matches(String key) {
        return key.startsWith(HEADER_PREFIX);
    }
    // 根据请求和键确定数据源
    @Override
    public String doDetermineDatasource(MethodInvocation invocation, String key) {
        // 获取当前请求对象
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        // 提取真实的头部信息键（去除前缀 "#header"）
        String headerName = key.substring(8);
        // 根据头部信息键获取对应的头部值
        return request.getHeader(headerName);
    }
}

5.重写spirngboot的run方法加载主库配置的所有数据源

@Component
@Slf4j
public class CompanyDataSourceInit implements ApplicationRunner {
    @Autowired
    CompanyService companyService;
    private DataSource dataSource;
    private DefaultDataSourceCreator dataSourceCreator;

    @Autowired
    public CompanyDataSourceInit(DataSource dataSource, DefaultDataSourceCreator dataSourceCreator) {
        this.dataSource = dataSource;
        this.dataSourceCreator = dataSourceCreator;
    }
    /**
     * 重写run 加载企业配置的数据库
     *
     * @param args
     */
    @Override
    public void run(ApplicationArguments args) {
        List<CompanyEntity> entities = companyService.findCompanyEntitiesByState();
        log.info("动态数据库配置开始!最终数据源总数量:{}", entities.size());
        // 当前动态数据源
        DynamicRoutingDataSource ds = (DynamicRoutingDataSource) dataSource;
        entities.forEach((item) -> {
            // 数据源参数配置
            DataSourceProperty dataSourceProperty = new DataSourceProperty();
            String dbClassType = "com.mysql.jdbc.Driver";
            String dbUrl = String.format("jdbc:mysql://%s:%s/%s?characterEncoding=utf8&useSSL=false", item.getDbIp(), item.getDbPort(), item.getDbName());
            dataSourceProperty.setPoolName(item.getCompanyCode());
            dataSourceProperty.setUsername(item.getDbUser());
            dataSourceProperty.setPassword(item.getDbPassword());
            dataSourceProperty.setUrl(dbUrl);
            dataSourceProperty.setDriverClassName(dbClassType);
            // 数据源全部懒加载,避免一次性声明过多连接
            dataSourceProperty.setLazy(true);
            // 生成数据源
            DataSource dataSource = dataSourceCreator.createDataSource(dataSourceProperty);
                // 添加到动态数据源中
                ds.addDataSource(item.getCompanyCode(), dataSource);
                log.info("当前加载的数据源:{},加载完成!", item.getCompanyCode());
            });
            log.info("动态数据库配置结束!总共加载{}个数据源!", ds.getDataSources().size());
        }
    }
}

6.动态数据源的使用 @DS("#header.companyCode")

//说明：租户登录时将确认数据库的唯一标识存入请求头中
使用@DS("#header.companyCode")来指定数据库  可放controller,service,mapper层及方法上

@DS("#header.companyCode")   //通过读取请求头里面租户的唯一标识来实现指定数据库
@Slf4j
public class SaasServiceImpl implements SaasService {

}