多租户代码框架

This commit is contained in:
zhonghua1
2025-12-16 23:34:07 +08:00
parent 5453026309
commit 406f7d692b
36 changed files with 956 additions and 39 deletions

View File

@@ -2,35 +2,82 @@ package com.rj.config;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.handler.TenantLineHandler;
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.rj.tenant.TenantContextHolder;
import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.expression.StringValue;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import java.util.HashSet;
import java.util.Set;
/**
* MyBatis Plus 配置类
*
* @author 李中华
* @since 2025-08-08
*
* <p>包含:</p>
* <ul>
* <li>多租户拦截器根据当前线程中的租户ID自动为SQL拼接 tenant_id 条件;</li>
* <li>分页插件;</li>
* <li>乐观锁插件。</li>
* </ul>
*/
@Configuration
@EnableTransactionManagement
public class MybatisPlusConfig {
/**
* 分页插件配置
* MyBatis-Plus 主拦截器配置
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
public MybatisPlusInterceptor mybatisPlusInterceptor(TenantLineHandler tenantLineHandler) {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
// 分页插件
// 1. 多租户插件(需优先添加)
interceptor.addInnerInterceptor(new TenantLineInnerInterceptor(tenantLineHandler));
// 2. 分页插件
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
// 乐观锁插件
// 3. 乐观锁插件
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return interceptor;
}
}
/**
* 多租户处理器定义如何获取租户ID、租户字段名以及忽略的表
*/
@Bean
public TenantLineHandler tenantLineHandler() {
// 需要忽略多租户的表(不自动拼接 tenant_id
Set<String> ignoreTables = new HashSet<>();
ignoreTables.add("tenant"); // 租户表本身
ignoreTables.add("industry_tags"); // 行业标签(示例:如认为是公共字典)
return new TenantLineHandler() {
@Override
public Expression getTenantId() {
String tenantId = TenantContextHolder.getTenantId();
// 没有租户ID时返回 null 由 MyBatis-Plus 决定处理策略,通常为不过滤或抛错(视版本而定)
return tenantId == null ? null : new StringValue(tenantId);
}
@Override
public String getTenantIdColumn() {
return "tenant_id";
}
@Override
public boolean ignoreTable(String tableName) {
// 忽略名单内的表不做租户隔离
return ignoreTables.contains(tableName);
}
};
}
}

View File

@@ -0,0 +1,41 @@
package com.rj.config;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import com.rj.tenant.TenantContextHolder;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
/**
* MyBatis-Plus 公共字段自动填充处理器
*
* <p>
* 仅负责在插入时为带有 tenantId 字段的实体自动填充当前租户ID<br/>
* 更新时不修改 tenantId确保租户ID一旦写入不可被业务层随意修改。
* </p>
*/
@Component
public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {
private static final String TENANT_FIELD = "tenantId";
@Override
public void insertFill(MetaObject metaObject) {
// 仅在实体中存在 tenantId 字段且当前值为空时进行填充
if (metaObject.hasSetter(TENANT_FIELD)) {
Object currentValue = getFieldValByName(TENANT_FIELD, metaObject);
if (currentValue == null) {
String tenantId = TenantContextHolder.getTenantId();
if (tenantId != null) {
this.strictInsertFill(metaObject, TENANT_FIELD, String.class, tenantId);
}
}
}
}
@Override
public void updateFill(MetaObject metaObject) {
// 不自动更新 tenantId保持租户ID稳定
}
}

View File

@@ -0,0 +1,110 @@
package com.rj.config;
import com.rj.tenant.TenantContextHolder;
import com.rj.entity.sys.User;
import com.rj.service.sys.IUserService;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.OncePerRequestFilter;
import java.io.IOException;
/**
* 多租户过滤器:
* <p>
* - 从 HTTP Header 中读取租户IDX-Tenant-Id<br/>
* - 将租户ID写入 {@link TenantContextHolder}<br/>
* - 在请求结束时清理线程变量,避免线程复用造成的串租户问题
* </p>
*/
@Component
@Order(Ordered.HIGHEST_PRECEDENCE + 10)
public class TenantFilter extends OncePerRequestFilter {
private static final Logger log = LoggerFactory.getLogger(TenantFilter.class);
/**
* Header 名称常量,便于前后端约定与维护
*/
public static final String TENANT_HEADER = "X-Tenant-Id";
/**
* 认证 Header 名,约定为 Bearer Token
*/
public static final String AUTH_HEADER = "Authorization";
private final IUserService userService;
public TenantFilter(IUserService userService) {
this.userService = userService;
}
@Override
protected void doFilterInternal(HttpServletRequest request,
HttpServletResponse response,
FilterChain filterChain) throws ServletException, IOException {
String headerTenantId = request.getHeader(TENANT_HEADER);
String finalTenantId = null;
// 1. 从 Authorization 头中解析 token并查出用户的租户ID
String authHeader = request.getHeader(AUTH_HEADER);
String tokenTenantId = null;
if (authHeader != null && !authHeader.isEmpty()) {
String token = extractToken(authHeader);
if (token != null && !token.isEmpty()) {
User user = userService.getUserByToken(token);
if (user != null) {
tokenTenantId = user.getTenantId();
}
}
}
try {
// 2. 计算本次请求实际使用的租户ID并校验一致性
if (tokenTenantId != null && headerTenantId != null && !headerTenantId.isEmpty()
&& !tokenTenantId.equals(headerTenantId)) {
// Header 与 Token 中的租户不一致,记录告警日志(也可以按需直接拒绝请求)
log.warn("Tenant mismatch between token and header. tokenTenantId={}, headerTenantId={}", tokenTenantId, headerTenantId);
}
if (tokenTenantId != null) {
finalTenantId = tokenTenantId;
} else if (headerTenantId != null && !headerTenantId.isEmpty()) {
finalTenantId = headerTenantId;
}
// 设置租户上下文(允许为 null如公共接口或未登录情况
TenantContextHolder.setTenantId(finalTenantId);
filterChain.doFilter(request, response);
} finally {
// 无论请求是否成功,都要清理线程变量
TenantContextHolder.clear();
}
}
/**
* 从 Authorization 头中提取实际的 token 值。
* 支持形如 "Bearer xxx" 或直接传 token 的方式。
*/
private String extractToken(String authHeader) {
if (authHeader == null) {
return null;
}
authHeader = authHeader.trim();
if (authHeader.toLowerCase().startsWith("bearer ")) {
return authHeader.substring(7).trim();
}
return authHeader;
}
}