底座开发指南
萌新必读
简介
功能列表
快速启动(后端项目)
快速启动(前端项目)
接口文档
热代码加载
迁移模式(适合新项目)
删除功能(以租户为例)
表结构变更(版本升级)
内网穿透
达梦数据库专属
后端手册
新建服务
代码生成【单表】(新增功能)
代码生成(树表)
功能权限·
数据权限
用户体系
三方登陆
OAuth 2.0(SSO 单点登录)
SaaS 多租户【字段隔离】
SaaS 多租户【数据库隔离】
WebSocket 实时通信
异常处理(错误码)
参数校验
分页实现
VO 对象转换、数据翻译
文件存储(上传下载)
Excel 导入导出
操作日志、访问日志、异常日志
MyBatis 数据库
MyBatis 联表&分页查询
多数据源(读写分离)
Redis 缓存
本地缓存
异步任务
分布式锁
幂等性(防重复提交)
请求限流(RateLimiter)
HTTP 接口签名(防篡改)
单元测试
验证码
工具类 Util
数据库文档
微服务手册
微服务调试(必读)
注册中心 Nacos
配置中心 Nacos
服务网关 Spring Cloud Gateway
服务调用 Feign
定时任务 XXL Job
消息队列(内存)
消息队列(Redis)
消息队列(RocketMQ)
消息队列(RabbitMQ)
消息队列(Kafka)
消息队列(Cloud)
分布式事务 Seata
服务保障 Sentinel
工作流手册
工作流演示
功能开启
工作流(达梦适配)
审批接入(流程表单)
审批接入(业务表单)
流程设计器(BPMN)
流程设计器(钉钉、飞书)
选择审批人、发起人自选
会签、或签、依次审批
流程发起、取消、重新发起
审批通过、不通过、驳回
审批加签、减签
审批转办、委派、抄送
执行监听器、任务监听器
流程表达式
流程审批通知
大屏手册
报表设计器
大屏设计器
支付手册
功能开启·
支付宝支付接入
微信公众号支付接入
微信小程序支付接入
支付宝、微信退款接入
会员手册
功能开启··
微信公众号登录
微信小程序登录
微信小程序订阅消息
微信小程序码
会员用户、标签、分组
会员等级、积分、签到
商城手册
商城演示
功能开启···
商城装修
在线客服
【商品】商品分类
【商品】商品属性
【商品】商品 SPU 与 SKU
【商品】商品评价
【交易】购物车
【交易】交易订单
【交易】售后退款
【交易】快递发货
【交易】门店自提
【交易】分销返佣
【营销】优惠劵
【营销】拼团活动
【营销】秒杀活动
【营销】砍价活动
【营销】满减送
【营销】限时折扣
【营销】内容管理
【统计】会员、商品、交易统计
ERP 手册
ERP 演示
【功能开启】
【产品】产品信息、分类、单位
【库存】产品库存、库存明细
【库存】其它入库、其它出库
【库存】库存调拨、库存盘点
【采购】采购订单、入库、退货
【销售】销售订单、出库、退货
【财务】采购付款、销售收款
CRM手册
CRM 演示
【功能开启】·
【线索】线索管理
【客户】客户管理、公海客户
【商机】商机管理、商机状态
【合同】合同管理、合同提醒
【回款】回款管理、回款计划
【产品】产品管理、产品分类
【通用】数据权限
【通用】跟进记录、待办事项
AI大模型手册
AI 大模型演示
功能开启-
AI 聊天对话
AI 绘画创作
AI 音乐创作
AI 写作助手
AI 思维导图
【模型接入】OpenAI
【模型接入】通义千问
【模型接入】LLAMA
【模型接入】文心一言
【模型接入】DeepSeek
【模型接入】智谱 GLM
【模型接入】讯飞星火
【模型接入】微软 OpenAI
【模型接入】谷歌 Gemini
【模型接入】Stable Diffusion
【模型接入】Midjourney
【模型接入】Suno
公众号手册
【功能开启】-
公众号接入
公众号粉丝
公众号标签
公众号消息
自动回复
公众号菜单
公众号素材
公众号图文
公众号统计
系统手册
短信配置
邮件配置
站内信配置
数据脱敏
敏感词
地区 & IP 库
运维手册
开发环境
Linux 部署
Docker 部署
Jenkins 部署
HTTPS 证书
服务监控
前端手册 Vue 3.x
开发规范
菜单路由
Icon 图标
字典数据
系统组件
通用方法
配置读取
CRUD 组件
国际化
IDE 调试
代码格式化
前端手册 Vue 2.x
开发规范·
菜单路由·
Icon 图标·
字典数据·
系统组件·
通用方法·
配置读取·
本文档使用「觅思文档专业版」发布
-
+
首页
SaaS 多租户【字段隔离】
本章节,将介绍多租户的基础知识、以及怎样使用多租户的功能。 相关的视频教程: 01、[如何实现多租户的 DB 封装?](http://https://wx.zsxq.com/dweb2/index/topic_detail/212242444181181 "如何实现多租户的 DB 封装?") 02、[如何实现多租户的 Redis 封装?](http://https://wx.zsxq.com/dweb2/index/topic_detail/812242414884252 "如何实现多租户的 Redis 封装?") 03、[如何实现多租户的 Web 与 Security 封装?](http://https://wx.zsxq.com/dweb2/index/topic_detail/415525144228588 "如何实现多租户的 Web 与 Security 封装?") 04、[如何实现多租户的 Job 封装?](http://https://wx.zsxq.com/dweb2/index/topic_detail/415525145444188 "如何实现多租户的 Job 封装?") 05、[如何实现多租户的 MQ 与 Async 封装?](http://https://wx.zsxq.com/dweb2/index/topic_detail/415522484142488 "如何实现多租户的 MQ 与 Async 封装?") 06、[如何实现多租户的 AOP 与 Util 封装?](http://https://wx.zsxq.com/dweb2/index/topic_detail/812244584145422 "如何实现多租户的 AOP 与 Util 封装?") 07、[如何实现多租户的管理?](http://https://wx.zsxq.com/dweb2/index/topic_detail/184411245214212 "如何实现多租户的管理?") 08、[如何实现多租户的套餐?](http://https://wx.zsxq.com/dweb2/index/topic_detail/184411248421152 "如何实现多租户的套餐?") ## 1. 多租户是什么? 多租户,简单来说是指一个业务系统,可以为多个组织服务,并且组织之间的数据是隔离的。 例如说,在服务上部署了一个 dtpc-cloud (opens new window)系统,可以支持多个不同的公司使用。这里的一个公司就是一个租户,每个用户必然属于某个租户。因此,用户也只能看见自己租户下面的内容,其它租户的内容对他是不可见的。 ## 2. 数据隔离方案 多租户的数据隔离方案,可以分成分成三种: - DATASOURCE 模式:独立数据库 - SCHEMA 模式:共享数据库,独立 Schema - COLUMN 模式:共享数据库,共享 Schema,共享数据表 ### 2.1 DATASOURCE 模式 一个租户一个数据库,这种方案的用户数据隔离级别最高,安全性最好,但成本也高。  - 优点:为不同的租户提供独立的数据库,有助于简化数据模型的扩展设计,满足不同租户的独特需求;如果出现故障,恢复数据比较简单。 - 缺点:增大了数据库的安装数量,随之带来维护成本和购置成本的增加。 ### 2.2 SCHEMA 模式 多个或所有租户共享数据库,但一个租户一个表。  - 优点:维护和购置成本最低,允许每个数据库支持的租户数量最多。 - 缺点:隔离级别最低,安全性最低,需要在设计开发时加大对安全的开发量;数据备份和恢复最困难,需要逐表逐条备份和还原。 ### 2.4 方案选择  - 一般情况下,可以考虑采用 COLUMN 模式,开发、运维简单,以最少的服务器为最多的租户提供服务。 - 租户规模比较大,或者一些租户对安全性要求较高,可以考虑采用 DATASOURCE 模式,当然它也相对复杂的多。 - 不推荐采用 SCHEMA 模式,因为它的优点并不明显,而且它的缺点也很明显,同时对复杂 SQL 支持一般。 考虑到让大家更好的理解 DATASOURCE 和 COLUMN 模式,拆成了两篇文章: - 《SaaS 多租户【字段隔离】》:讲解 COLUMN 模式 - 《SaaS 多租户【数据库隔离】》:讲解 DATASOURCE 模式 ## 3. 多租户的开关 系统有两个配置项,设置为 true 时开启多租户,设置为 false 时关闭多租户。 注意,两者需要保持一致,否则会报错!  ## 3. 多租户的业务功能 多租户主要有两个业务功能:  下面,我们来新增一个租户,它使用 COLUMN 模式。 ① 点击 [租户管理] 菜单,点击 [新增] 按钮,填写租户的信息。  ② 点击 [确认] 按钮,完成租户的创建,它会自动创建对应的租户管理员、角色等信息。  ③ 退出系统,登录刚创建的租户。  至此,我们已经完成了租户的创建。 ## 4. 多租户的技术组件 技术组件 dtpc-spring-boot-starter-biz-tenant ,实现透明化的多租户能力,针对 Web、Security、DB、Redis、AOP、Job、MQ、Async 等多个层面进行封装。 ### 4.1 租户上下文 TenantContextHolder是租户上下文,通过 ThreadLocal 实现租户编号的共享与传递。 通过调用 TenantContextHolder 的 #getTenantId() 静态方法,获得当前的租户编号。绝绝绝大多数情况下,并不需要。 ### 4.2 Web 层【重要】 默认情况下,前端的每个请求 Header 必须带上 tenant-id,值为租户编号,即 system_tenant 表的主键编号。  如果不带该请求头,会报“租户的请求未传递,请进行排查”错误提示。 ???? 通过 dtpc.tenant.ignore-urls 配置项,可以设置哪些 URL 无需带该请求头。例如说:  ### 4.3 Security 层 主要是校验登录的用户,校验是否有权限访问该租户,避免越权问题。 ### 4.4 DB 层【重要】 COLUMN 模式,基于 MyBatis Plus 自带的多租户 (opens new window)功能实现。 核心:每次对数据库操作时,它会自动拼接 WHERE tenant_id = ? 条件来进行租户的过滤,并且基本支持所有的 SQL 场景。 如下是具体方式: ① 需要开启多租户的表,必须添加 tenant_id 字段。例如说 system_users、system_role 等表。 <span style="font-family:楷体">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='角色信息表'; </span> 并且该表对应的 DO 需要使用到 tenantId 属性时,建议继承 TenantBaseDO类。 ② 无需开启多租户的表,需要添加表名到 dtpc.tenant.ignore-tables 配置项目。例如说:  如果不配置的话,MyBatis Plus 会自动拼接 WHERE tenant_id = ? 条件,导致报 tenant_id 字段不存在的错误。 友情提示:MyBatis Plus 的多租户方案,在我们在 MyBatis XML 手写 SQL 时,是不生效的,即不会拼接 `tenant_id` 字段!!! 解决方案:需要手动自己拼接,可见 ErpPurchaseStatisticsMapper.xml 案例,如下所示: tenant_id = ${@cn.iocoder.yudao.framework.tenant.core.context.TenantContextHolder@getRequiredTenantId()} 其中,后面 ${@...} 一串,是 MyBatis 调用静态方法的方式,即使用 TenantContextHolder 的 #getRequiredTenantId() 方法,获得当前的租户编号。 ### 4.5 Redis 层 使用方式一:基于 Spring Cache + Redis【推荐】 只需要一步,在方法上添加 Spring Cache 注解,例如说 @Cachable、@CachePut、@CacheEvict。 具体的实现原理,可见 TenantRedisCacheManager的源码。 注意!!!默认配置下,Spring Cache 都开启 Redis Key 的多租户隔离。如果不需要,可以将 Key 添加到 dtpc.tenant.ignore-caches 配置项中。如下图所示:  使用方式二:基于 RedisTemplate + TenantRedisKeyDefine 暂时没有合适的封装,需要在自己 format Redis Key 的时候,手动将 :t{tenantId} 后缀拼接上。 这也是为什么,我推荐你使用 Spring Cache + Redis 的原因! ### 4.6 AOP【重要】 ① 声明 @TenantIgnore 注解在方法上,标记指定方法不进行租户的自动过滤,避免自动拼接 WHERE tenant_id = ? 条件等等。 例如说:RoleServiceImpl 的 #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 导致不生效,可以采用上述示例的 <x> 处的 self 方式。 ② 使用 TenantUtils 的 #execute(Long tenantId, Runnable runnable) 方法,模拟指定租户( tenantId ),执行某段业务逻辑( runnable )。 例如说:在 TenantServiceImpl 的 #createTenant(...) 方法,在创建完租户时,需要模拟该租户,进行用户和角色的创建。如下图所示:  ### 4.7 Job【重要】 声明 @TenantJob注解在 Job 方法上,实现并行遍历每个租户,执行定时任务的逻辑。 ### 4.8 MQ 通过租户对 MQ 层面的封装,实现租户上下文,可以继续传递到 MQ 消费的逻辑中,避免丢失的问题。实现原理是: - 发送消息时,MQ 会将租户上下文的租户编号,记录到 Message 消息头 tenant-id 上。 - 消费消息时,MQ 会将 Message 消息头 tenant-id,设置到租户上下文的租户编号。 ### 4.9 Async 通过使用阿里开源的 TransmittableThreadLocal (opens new window)组件,实现 Spring Async 执行异步逻辑时,租户上下文可以继续传递,避免丢失的问题。 ### 4.10 RPC RPC 使用 Feign 调用时,会自动将租户上下文的租户编号,设置到 HTTP 请求头 tenant-id 上。 在 Provider 服务端,会自动将 HTTP 请求头 tenant-id,设置到租户上下文的租户编号。 ## 5. 租户独立域名 在我们使用 SaaS 云产品的时候,每个租户会拥有 独立的子域名,例如说:租户 A 对应 a.iocoder.cn,租户 B 对应 b.iocoder.cn。 目前管理后台已经提供类似的能力,更多大家可以基于它去拓展。实现方式: 在 system_tenant 表里,有个 website 字段为该租户的独立域名,你可以填写你希望分配给它的子域名。 在 Nginx 上做 泛域名解析 到你的前端项目,例如说 Nginx 的 server_name *.iocoder.cn 解析到 Vue3 管理后台。 这样用户在访问管理后台的登录界面,会自动根据当前访问域名的 host,向后端获得对应的 tenant-id 编号,后续请求都带上它!
何加华
2024年8月27日 08:41
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期