Saas系统需要支持多租户,经分析调研,最终采用数据库多实例的方式实现多租户。
根据各微服务的业务及规模,存在以下条件:
1. 公共服务不需要区分租户;
2. 需要多租户的微服务,上下文一定会指定租户信息。
基于这些要求,提供了公共的拦截器,根据租户信息获取此租户对应的数据源并动态切换。
pom依赖:
<!-- mybatisPlus -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>dynamic-datasource-spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
</dependency>
拦截器代码
package com.future.yc.mybatis.handler;
import cn.hutool.core.util.StrUtil;
import com.baomidou.dynamic.datasource.DynamicRoutingDataSource;
import com.baomidou.dynamic.datasource.creator.DefaultDataSourceCreator;
import com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DataSourceProperty;
import com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DynamicDataSourceProperties;
import com.baomidou.dynamic.datasource.toolkit.DynamicDataSourceContextHolder;
import com.future.yc.common.context.AppContext;
import com.future.yc.mybatis.service.IDbService;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.sql.DataSource;
/**
* 动态数据源拦截器
*/
public class DynamicDataSourceHandler extends HandlerInterceptorAdapter {
@Autowired
private DynamicRoutingDataSource dataSource;
@Autowired
private DefaultDataSourceCreator dataSourceCreator;
@Autowired
private DynamicDataSourceProperties defaultProperty;
@Autowired
private IDbService dbService;
@Value("${future.common.dynamic.enabled:false}")
private boolean dynamicEnabled;
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
resetDataSource();
return true;
}
/**
* 多租户处理,数据源切换
*/
public void resetDataSource() {
// 是否启用多数据源
if(!dynamicEnabled) {
return;
}
// 读取初始实例名
String defaultSchema = getPrimarySchema();
// 待切换的数据源名称: 初始实例名_租户ID
String newSchema = getNewSchema(defaultSchema);
// 数据源中是否已存在
if(!dataSource.getCurrentDataSources().keySet().contains(newSchema)) {
// 设置新数据源
DataSourceProperty property = copyProperty(defaultSchema, newSchema);
// 创建数据库实例
dbService.createDataBase(newSchema);
// 创建数据源
DataSource currDs = dataSourceCreator.createDataSource(property);
dataSource.addDataSource(newSchema, currDs);
}
// 设置当前数据源
DynamicDataSourceContextHolder.push(newSchema);
}
/**
* 获取新实例名
* @param defaultSchema
* @return 初始实例名_租户ID
*/
private String getNewSchema(String defaultSchema) {
// 从上下文中获取租户ID
String tenantId = AppContext.getContext().getTenantId();
// 当默认实例名或租户ID为空时,切换到默认数据源
if(StrUtil.isBlank(defaultSchema) || StrUtil.isBlank(tenantId)) {
return defaultProperty.getPrimary();
}
// 拼接groupCode
String newSchema = defaultSchema + "_" + tenantId;
// 转小写
return newSchema.toLowerCase();
}
/**
* 获取默认实例名
* @return
*/
private String getPrimarySchema() {
// 取默认数据源
DataSourceProperty srcProperty = defaultProperty.getDatasource().get(defaultProperty.getPrimary());
String url = srcProperty.getUrl();
// 截取最后一个/到?之间的内容即为schema
int startIndex = StrUtil.lastIndexOfIgnoreCase(url, "/");
int endIndex = StrUtil.indexOfIgnoreCase(url, "?");
if(startIndex <= 0 || endIndex <= startIndex) {
return null;
}
// 没有?时截取到最后
return StrUtil.sub(url, startIndex + 1, endIndex);
}
/**
* 复制新的数据源
* @param defaultSchema 默认连接的实例名
* @param newSchema 新创建的实例名
* @return
*/
private DataSourceProperty copyProperty(String defaultSchema, String newSchema) {
// 取默认数据源
DataSourceProperty srcProperty = defaultProperty.getDatasource().get(defaultProperty.getPrimary());
// 设置新数据源
DataSourceProperty property = new DataSourceProperty();
BeanUtils.copyProperties(srcProperty, property);
property.setPoolName(newSchema);
property.setUrl(StrUtil.replace(property.getUrl(), defaultSchema, newSchema));
return property;
}
}
里面有动态创建数据库实例,对应的Mapper:
<mapper namespace="com.future.yc.mybatis.dao.DbDao">
<select id="createDataBase">
create schema if not exists `${schema}` default character set utf8 collate utf8_general_ci
</select>
</mapper>
配置文件参考MP网站文档:配置文件参考
关键配置:
spring:
datasource:
dynamic:
primary: master
datasource:
master:
username: root
password: xxxxxx
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://xx.xx.xx.xx:3306/dynamic?characterEncoding=utf8&useSSL=false
druid: # 以下是独立参数,每个库可以重新设置
initial-size:
validation-query: select 1 FROM DUAL #比如oracle就需要重新设置这个
public-key: #(非全局参数)设置即表示启用加密,底层会自动帮你配置相关的连接参数和filter,推荐使用本项目自带的加密方法。
引入的微服务,通过配置可以实现是否启用多数据源(默认不启用):
future.common.dynamic.enabled=true
最后,注册拦截器即可:
/**
* MyBatis服务拦截器
*/
@Configuration
@Order(2)
public class MyBatisWebConfigurer implements WebMvcConfigurer {
@Bean
public DynamicDataSourceHandler dynamicDataSourceHandler() {
return new DynamicDataSourceHandler();
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 设置拦截的路径、不拦截的路径、优先级等等 -- 在上下文拦截器之后执行
registry.addInterceptor(dynamicDataSourceHandler()).order(20).addPathPatterns("/**");
}
}