多租戶技術(shù)的基本概念：
??多租戶技術(shù)（英語(yǔ)：multi-tenancy technology）或稱(chēng)多重租賃技術(shù)，是一種軟件架構(gòu)技術(shù)，它是在探討與實(shí)現(xiàn)如何于多用戶的環(huán)境下共用相同的系統(tǒng)或程序組件，并且仍可確保各用戶間數(shù)據(jù)的隔離性隆夯。
??在云計(jì)算的加持之下，多租戶技術(shù)被廣為運(yùn)用于開(kāi)發(fā)云各式服務(wù)榛搔，不論是IaaS，PaaS還是SaaS，都可以看到多租戶技術(shù)的影子暑刃。
??前面介紹過(guò)GitEgg框架與數(shù)據(jù)庫(kù)交互使用了Mybatis增強(qiáng)工具M(jìn)ybatis-Plus，Mybatis-Plus提供了TenantLineInnerInterceptor租戶處理器來(lái)實(shí)現(xiàn)多租戶功能膜眠，其原理就是Mybatis-Plus實(shí)現(xiàn)了自定義Mybatis攔截器（Interceptor）岩臣，在需要執(zhí)行的sql后面自動(dòng)添加租戶的查詢條件，實(shí)際和分頁(yè)插件宵膨，數(shù)據(jù)權(quán)限攔截器是同樣的實(shí)現(xiàn)方式架谎。
簡(jiǎn)而言之多租戶技術(shù)就是可以讓一套系統(tǒng)通過(guò)配置給不同的客戶提供服務(wù)，每個(gè)客戶看到的數(shù)據(jù)都是屬于自己的辟躏，就好像每個(gè)客戶都擁有自己一套獨(dú)立完善的系統(tǒng)谷扣。
下面是在GitEgg系統(tǒng)的應(yīng)用配置：
1、在gitegg-platform-mybatis工程下新建多租戶組件配置文件TenantProperties.java和TenantConfig.java鸿脓，TenantProperties.java用于系統(tǒng)讀取配置文件抑钟，這里會(huì)在Nacos配置中心設(shè)置多組戶的具體配置信息，TenantConfig.java是插件需要讀取的配置有三個(gè)配置項(xiàng)：
TenantId租戶ID野哭、TenantIdColumn多租戶的字段名、ignoreTable不需要多租戶隔離的表幻件。
TenantProperties.java:
package com.gitegg.platform.mybatis.props;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import java.util.List;
/**
* 白名單配置
*/
@Data
@Configuration
@ConfigurationProperties(prefix = "tenant")
public class TenantProperties {
/**
* 是否開(kāi)啟租戶模式
*/
private Boolean enable;
/**
* 多租戶字段名稱(chēng)
*/
private String column;
/**
* 需要排除的多租戶的表
*/
private List<String> exclusionTable;
}
TenantConfig.java：
package com.gitegg.platform.mybatis.config;
import com.baomidou.mybatisplus.extension.plugins.handler.TenantLineHandler;
import com.baomidou.mybatisplus.extension.plugins.inner.TenantLineInnerInterceptor;
import com.gitegg.platform.boot.util.GitEggAuthUtils;
import com.gitegg.platform.mybatis.props.TenantProperties;
import lombok.RequiredArgsConstructor;
import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.expression.NullValue;
import net.sf.jsqlparser.expression.StringValue;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* 多租戶配置中心
*
* @author GitEgg
*/
@Configuration
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@AutoConfigureBefore(MybatisPlusConfig.class)
public class TenantConfig {
private final TenantProperties tenantProperties;
/**
* 新多租戶插件配置,一緩和二緩遵循mybatis的規(guī)則,
* 需要設(shè)置 MybatisConfiguration#useDeprecatedExecutor = false
* 避免緩存萬(wàn)一出現(xiàn)問(wèn)題
*
* @return TenantLineInnerInterceptor
*/
@Bean
public TenantLineInnerInterceptor tenantLineInnerInterceptor() {
return new TenantLineInnerInterceptor(new TenantLineHandler() {
/**
* 獲取租戶ID
* @return Expression
*/
@Override
public Expression getTenantId() {
String tenant = GitEggAuthUtils.getTenantId();
if (tenant != null) {
return new StringValue(GitEggAuthUtils.getTenantId());
}
return new NullValue();
}
/**
* 獲取多租戶的字段名
* @return String
*/
@Override
public String getTenantIdColumn() {
return tenantProperties.getColumn();
}
/**
* 過(guò)濾不需要根據(jù)租戶隔離的表
* 這是 default 方法,默認(rèn)返回 false 表示所有表都需要拼多租戶條件
* @param tableName 表名
*/
@Override
public boolean ignoreTable(String tableName) {
return tenantProperties.getExclusionTable().stream().anyMatch(
(t) -> t.equalsIgnoreCase(tableName)
);
}
});
}
}
2拨黔、可在工程下新建application.yml，配置將來(lái)需要在Nacos上配置的信息：
tenant:
# 是否開(kāi)啟租戶模式
enable: true
# 需要排除的多租戶的表
exclusionTable:
- "t_sys_district"
- "oauth_client_details"
# 租戶字段名稱(chēng)
column: tenant_id
3绰沥、修改MybatisPlusConfig.java篱蝇，把多租戶過(guò)濾器加載進(jìn)來(lái)使其生效：
package com.gitegg.platform.mybatis.config;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.BlockAttackInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.TenantLineInnerInterceptor;
import com.gitegg.platform.mybatis.props.TenantProperties;
import lombok.RequiredArgsConstructor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@RequiredArgsConstructor(onConstructor_ = @Autowired)
@MapperScan("com.gitegg.**.mapper.**")
public class MybatisPlusConfig {
private final TenantLineInnerInterceptor tenantLineInnerInterceptor;
private final TenantProperties tenantProperties;
/**
* 新的分頁(yè)插件,一緩和二緩遵循mybatis的規(guī)則,需要設(shè)置 MybatisConfiguration#useDeprecatedExecutor = false
* 避免緩存出現(xiàn)問(wèn)題(該屬性會(huì)在舊插件移除后一同移除)
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//多租戶插件
if (tenantProperties.getEnable()) {
interceptor.addInnerInterceptor(tenantLineInnerInterceptor);
}
//分頁(yè)插件
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
//防止全表更新與刪除插件: BlockAttackInnerInterceptor
BlockAttackInnerInterceptor blockAttackInnerInterceptor = new BlockAttackInnerInterceptor();
interceptor.addInnerInterceptor(blockAttackInnerInterceptor);
return interceptor;
}
/**
* 樂(lè)觀鎖插件 當(dāng)要更新一條記錄的時(shí)候贺待，希望這條記錄沒(méi)有被別人更新
* https://mybatis.plus/guide/interceptor-optimistic-locker.html#optimisticlockerinnerinterceptor
*/
@Bean
public OptimisticLockerInnerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInnerInterceptor();
}
}
4、在GitEggAuthUtils方法中新增獲取租戶信息的公共方法零截，租戶信息在Gateway進(jìn)行轉(zhuǎn)發(fā)時(shí)進(jìn)行設(shè)置麸塞，后面會(huì)說(shuō)明如何講租戶信息設(shè)置到Header中:
package com.gitegg.platform.boot.util;
import cn.hutool.json.JSONUtil;
import com.gitegg.platform.base.constant.AuthConstant;
import com.gitegg.platform.base.domain.GitEggUser;
import org.springframework.util.StringUtils;
import javax.servlet.http.HttpServletRequest;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
public class GitEggAuthUtils {
/**
* 獲取用戶信息
*
* @return GitEggUser
*/
public static GitEggUser getCurrentUser() {
HttpServletRequest request = GitEggWebUtils.getRequest();
if (request == null) {
return null;
}
try {
String user = request.getHeader(AuthConstant.HEADER_USER);
if (StringUtils.isEmpty(user))
{
return null;
}
String userStr = URLDecoder.decode(user,"UTF-8");
GitEggUser gitEggUser = JSONUtil.toBean(userStr, GitEggUser.class);
return gitEggUser;
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
return null;
}
}
/**
* 獲取租戶Id
*
* @return tenantId
*/
public static String getTenantId() {
HttpServletRequest request = GitEggWebUtils.getRequest();
if (request == null) {
return null;
}
try {
String tenantId = request.getHeader(AuthConstant.TENANT_ID);
String user = request.getHeader(AuthConstant.HEADER_USER);
//如果請(qǐng)求頭中的tenantId為空，那么嘗試是否能夠從登陸用戶中去獲取租戶id
if (StringUtils.isEmpty(tenantId) && !StringUtils.isEmpty(user))
{
String userStr = URLDecoder.decode(user,"UTF-8");
GitEggUser gitEggUser = JSONUtil.toBean(userStr, GitEggUser.class);
if (null != gitEggUser)
{
tenantId = gitEggUser.getTenantId();
}
}
return tenantId;
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
return null;
}
}
}
5涧衙、GitEgg-Cloud工程中g(shù)itegg-gateway子工程的AuthGlobalFilter增加設(shè)置TenantId的過(guò)濾方法
String tenantId = exchange.getRequest().getHeaders().getFirst(AuthConstant.TENANT_ID);
String token = exchange.getRequest().getHeaders().getFirst(AuthConstant.JWT_TOKEN_HEADER);
if (StrUtil.isEmpty(tenantId) && StrUtil.isEmpty(token)) {
return chain.filter(exchange);
}
Map<String, String> addHeaders = new HashMap<>();
// 如果系統(tǒng)配置已開(kāi)啟租戶模式哪工，設(shè)置tenantId
if (enable && StrUtil.isEmpty(tenantId)) {
addHeaders.put(AuthConstant.TENANT_ID, tenantId);
}
6、以上為后臺(tái)的多租戶功能集成步驟弧哎，在實(shí)際項(xiàng)目開(kāi)發(fā)過(guò)程中雁比，我們需要考慮到前端頁(yè)面在租戶信息上的配置，實(shí)現(xiàn)思路撤嫩，不用的租戶擁有不同的域名偎捎，前端頁(yè)面根據(jù)當(dāng)前域名獲取到對(duì)應(yīng)的租戶信息，并在公共請(qǐng)求方法設(shè)置TenantId參數(shù)序攘，保證每次請(qǐng)求能夠攜帶租戶信息茴她。
// request interceptor
request.interceptors.request.use(config => {
const token = storage.get(ACCESS_TOKEN)
// 如果 token 存在
// 讓每個(gè)請(qǐng)求攜帶自定義 token 請(qǐng)根據(jù)實(shí)際情況自行修改
if (token) {
config.headers['Authorization'] = token
}
config.headers['TenantId'] = process.env.VUE_APP_TENANT_ID
return config
}, errorHandler)
