5分钟学会Spring项目改造多租户

单租户模式

传统项目根本不提租户的事

我们开发完一个项目

就是给一个固定的用户单位使用

但随着Saas、云技术的不断发展

不可能为每个单位部署一套程序

而往往采用租户隔离、应用共享的方式

这就是多租户

多租户和单租户的差异

最大的差别

在于如何实现“数据隔离”

比如我们有个用户表

查询全部用户

当然是写

public List<User> findAll();

但如果我们的程序服务于多个租户

那这样就会把不同单位的数据互相暴露

因此我们需要引入租户改造

改造的方式

租户 有个专有名词 tenant_id

改造方法也很简单

通常采用两种

1. 数据库创建多个schema，每个下面建一套表

2. 数据库共用一套表，每个表加一个 tenant_id 区分所属租户

相对而言

方案二代价更低

但涉及到代码改造

今天教大家

如何能够更简洁的对传统代码进行调整

快速变为多租户模式

步骤一：建立全局租户上下文

通过统一的上下文

将租户标识记录下来

public class TenantContext {
    private static final ThreadLocal<String> CONTEXT = new ThreadLocal<>();
    public static void setTenantId(String id) { CONTEXT.set(id); }
    public static String getTenantId() { return CONTEXT.get(); }
    public static void clear() { CONTEXT.remove(); }
}

步骤二：全局拦截记录租户ID

这里建议采用隐式传递

通过header进行传参

@Configuration
public class TenantFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) {
        HttpServletRequest req = (HttpServletRequest) request;
        String tenantId = req.getHeader("X-Tenant-ID");
        TenantContext.setTenantId(tenantId);
        try {
            chain.doFilter(request, response);
        } finally {
            TenantContext.clear();
        }
    }
}

如此通过header传参

就能区分访问者所属的租户

步骤三：数据表过滤

首先需要对所有数据库表进行改造

需要数据隔离的表和实体类，都加上租户字段

例如：

@Entity
public class SysUser {
    @Id
    private String id;
    private String name;
    
    @Column(name = "tenant_id", nullable = false)
    private String tenantId;
}

此时我们可以增加注解

@FilterDef(
    name = "tenantFilter", 
    parameters = @ParamDef(name = "tenantId", type = "string")
)
@Filter(
    name = "tenantFilter", 
    condition = "tenant_id = :tenantId"
)
public class SysUser {
    /// 
}

这样就会自动根据租户ID过滤数据了

但这样会导致所有实体类

都需要增加注解

改动较多

我们可以定义实体父类

然后通过AOP自动增加营养

如下：

@FilterDef(name = "tenantFilter", parameters = @ParamDef(name = "tenantId", type = "string"))
public abstract class TenantEntity {
    // 基类无需实现具体逻辑
}

public class SysUser extends TenantEntity{
    //
}

然后通过AOP

将Filter应用

// 在 AOP 切面中统一处理
@Around("@annotation(org.springframework.transaction.annotation.Transactional)")
public Object applyFilter(ProceedingJoinPoint pjp) throws Throwable {
    Session session = entityManager.unwrap(Session.class);
    session.enableFilter("tenantFilter").setParameter("tenantId", TenantContext.getTenantId());
    try {
        return pjp.proceed();
    } finally {
        session.disableFilter("tenantFilter");
    }
}

如此一来

就不需要每个地方都加上一样的代码了

多租户对项目的改良

通过多租户

实现数据隔离

同时也要保证安全性

适用于各类SaaS应用

从而降低成本，共享资源，减少重复部署

难度不高

五分钟就能实现

一起来试试吧