SaaS 多租户">SaaS 多租户

SaaS 多租户

1. 多租户是什么？

多租户，简单来说是指一个业务系统，可以为多个组织服务，并且组织之间的数据是隔离的。
例如说，在服务上部署了一个系统，可以支持多个不同的公司使用。这里的一个公司就是一个租户，每个用户必然属于某个租户。因此，用户也只能看见自己租户下面的内容，其它租户的内容对他是不可见的。

2. 多租户的开关

系统有两个配置项，设置为 true 时开启多租户，设置为 false 时关闭多租户。
注意，两者需要保持一致，否则会报错！

配置项	说明	配置文件
ykkj.server.tenant	后端开关
VUE_APP_TENANT_ENABLE	前端开关

疑问：为什么要设置两个配置项？
前端登录界面需要使用到多租户的配置项，从后端加载配置项的话，体验会比较差。

3. 多租户的业务功能

多租户主要有两个业务功能：

业务功能	说明	界面	代码
租户管理	配置系统租户，创建对应的租户管理员		后端前端
租户套餐	配置租户套餐，自定每个租户的菜单、操作、按钮的权限		后端前端

下面，我们来新增一个租户。
① 点击 [租户套餐] 菜单，点击 [新增] 按钮，填写租户的信息。

② 点击 [确认] 按钮，完成租户的创建，它会自动创建对应的租户管理员、角色等信息。

③ 退出系统，登录刚创建的租户。

至此，我们已经完成了租户的创建。

4. 多租户的技术组件

技术组件 ykkj-spring-boot-starter-biz-tenant，实现透明化的多租户能力，针对 Web、Security、DB、Redis、AOP、Job、MQ、Async 等多个层面进行封装。

4.1 租户上下文

TenantContextHolder是租户上下文，通过 ThreadLocal 实现租户编号的共享与传递。
通过调用 TenantContextHolder 的 #getTenantId() 静态方法，获得当前的租户编号。绝绝绝大多数情况下，并不需要。

4.2 Web 层【重要】

实现可见 web包。
默认情况下，前端的每个请求 Header 必须带上 tenant-id，值为租户编号，即 system_tenant 表的主键编号。

如果不带该请求头，会报“租户的请求未传递，请进行排查”错误提示。
😜 通过 ykkj.tenant.ignore-urls 配置项，可以设置哪些 URL 无需带该请求头。例如说：

4.3 Security 层

实现可见 framework/tenant/core/security包。
主要是校验登录的用户，校验是否有权限访问该租户，避免越权问题。

4.4 DB 层【重要】

实现可见 framework/tenant/core/db包。
数据库的多租户隔离，有三种方案。
方案一：独立数据库
一个租户一个数据库，这种方案的用户数据隔离级别最高，安全性最好，但成本也高。

优点：为不同的租户提供独立的数据库，有助于简化数据模型的扩展设计，满足不同租户的独特需求；如果出现故障，恢复数据比较简单。
缺点：增大了数据库的安装数量，随之带来维护成本和购置成本的增加。

方案二：共享数据库，隔离数据架构
多个或所有租户共享数据库，但一个租户一个表。

优点：为安全性要求较高的租户提供了一定程度的逻辑数据隔离，并不是完全隔离；每个数据库可以支持更多的租户数量。
缺点：如果出现故障，数据恢复比较困难，因为恢复数据库将牵扯到其他租户的数据；如果需要跨租户统计数据，存在一定困难。

方案三：共享数据库，隔离数据架构
共享数据库，共享数据架构。租户共享同一个数据库、同一个表，但在表中通过 tenant_id 字段区分租户的数据。这是共享程度最高、隔离级别最低的模式。

优点：维护和购置成本最低，允许每个数据库支持的租户数量最多。
缺点：隔离级别最低，安全性最低，需要在设计开发时加大对安全的开发量；数据备份和恢复最困难，需要逐表逐条备份和还原。

如果希望以最少的服务器为最多的租户提供服务，并且租户接受以牺牲隔离级别换取降低成本，这种方案最适合。

项目目前采用 “方案三：共享数据库，隔离数据架构”，主要考虑 MyBatis Plus 自带的多租户功能采用该方案。每次对数据库操作时，它会自动拼接 WHERE tenant_id = ? 条件来进行租户的过滤，并且基本支持所有的 SQL 场景。
疑问：未来会支持方案一或者方案二吗？
当然会，后续会结合结合三种方案，实现更优的方案四：

针对绝大多数的数据库量较小的租户，采用方案三，通过 Sharding Sphere 分库分表支持。
针对少数的数据量交大的租户，采用方案一或者方案二，根据数据规模来决定。

下面，我们来讲讲具体方式：
① 需要开启多租户的表，必须添加 tenant_id 字段。例如说 system_users、system_role 等表。

CREATE TABLE `system_role` (
  `id` bigint NOT NULL AUTO_INCREMENT COMMENT '角色ID',
  `name` varchar(30) CHARACTER NOT NULL COMMENT '角色名称',
  `tenant_id` bigint NOT NULL DEFAULT '0' COMMENT '租户编号',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=1 COMMENT='角色信息表';

并且该表对应的 DO 需要使用到 tenantId 属性时，建议继承 TenantBaseDO类。
② 无需开启多租户的表，需要添加表名到 yudao.tenant.ignore-tables 配置项目。例如说：

如果不配置的话，MyBatis Plus 会自动拼接 WHERE tenant_id = ? 条件，导致报 tenant_id 字段不存在的错误。

4.5 Redis 层

实现可见 framework/tenant/core/redis包。
友情提示：可暂时忽略 Redis 层的封装，项目中暂时未使用到，方案本身也不是很满意。
由于 Redis 不同于 DB 有 tenant_id 字段，无法通过类似 WHERE tenant_id = ? 的方式过滤，所以需要通过在 Redis Key 上增加后缀的方式，进行租户之间的隔离。具体的步骤是：

假设 Redis Key 是 user:%d，示例是 user:1；对应到多租户的 Redis Key 是 user:%d:%d
在 Redis DAO 中，需要使用 {@link #formatKey(Object…)}方法，进行 Redis Key 的格式化

注意，大多数情况下，并不用使用 framework/tenant/core/redis/TenantRedisKeyDefine.java实现。主要的使用场景，还是 Redis Key 可能存在冲突的情况。例如说，租户 1 和 2 都有一个手机号作为 Key，则他们会存在冲突的问题。

4.6 AOP【重要】

实现可见 framework/tenant/core/aop包。
① 声明 @TenantIgnore注解在方法上，标记指定方法不进行租户的自动过滤，避免自动拼接 WHERE tenant_id = ? 条件等等。
例如说：module/system/service/permission/RoleServiceImpl.java的 #initLocalCache()方法，加载所有租户的角色到内存进行缓存，如果不声明 @TenantIgnore 注解，会导致租户的自动过滤，只加载了某个租户的角色。

// RoleServiceImpl.java
public class RoleServiceImpl implements RoleService {

    @Resource
    @Lazy // 注入自己，所以延迟加载
    private RoleService self;

    @Override
    @PostConstruct
    @TenantIgnore // 忽略自动多租户，全局初始化缓存
    public void initLocalCache() {
        // ... 从数据库中，加载角色
    }

    @Scheduled(fixedDelay = SCHEDULER_PERIOD, initialDelay = SCHEDULER_PERIOD)
    public void schedulePeriodicRefresh() {
        self.initLocalCache(); // <x> 通过 self 引用到 Spring 代理对象
    }
}

有一点要格外注意，由于 @TenantIgnore 注解是基于 Spring AOP 实现，如果是方法内部的调用，避免使用 this 导致不生效，可以采用上述示例的处的 self 方式。
② 使用 framework/tenant/core/util/TenantUtils.java的 #execute(Long tenantId, Runnable runnable) 方法，模拟指定租户( tenantId )，执行某段业务逻辑( runnable )。
例如说：在 module/system/service/tenant/TenantServiceImpl.java的 #createTenant(…) 方法，在创建完租户时，需要模拟该租户，进行用户和角色的创建。如下图所示：

4.7 Job【重要】

实现可见 framework/tenant/core/job包。
声明 @TenantJob注解在 Job 类上，实现并行遍历每个租户，执行定时任务的逻辑。

4.8 MQ

实现可见 framework/tenant/core/mq包。
通过租户对 MQ 层面的封装，实现租户上下文，可以继续传递到 MQ 消费的逻辑中，避免丢失的问题。实现原理是：

发送消息时，MQ 会将租户上下文的租户编号，记录到 Message 消息头 tenant-id 上。
消费消息时，MQ 会将 Message 消息头 tenant-id，设置到租户上下文的租户编号。
4.9 Async
实现可见framework/quartz/config/YkkjAsyncAutoConfiguration.java类。
通过使用阿里开源的 TransmittableThreadLocal组件，实现 Spring Async 执行异步逻辑时，租户上下文可以继续传递，避免丢失的问题。

SaaS 多租户

SaaS 多租户

1. 多租户是什么？

2. 多租户的开关

3. 多租户的业务功能

4. 多租户的技术组件

4.1 租户上下文

4.2 Web 层【重要】

4.3 Security 层

4.4 DB 层【重要】

4.5 Redis 层

4.6 AOP【重要】

4.7 Job【重要】

4.8 MQ

4.9 Async