详解ABP框架的多租户

Posted 2020-08-01 魔法花园 － .NET版

（此文章同时发表在本人微信公众号“dotNET每日精华文章”，欢迎右边二维码来关注。)

题记：ABP框架对多租户场景提供了很好的支持，内建了多租户的处理机制，今天我们来深入解析一下这一特性。

最近在基于ABP框架（ASP.NET Boilerplate）开发了一个SaaS。所以接下来可能会时不时分享一下ABP方面的文章。今天来介绍一下ABP对多租户提供的支持特性。

ABP简介

ASP.NET Boilerplate是一个用最佳实践和流行技术开发现代WEB应用程序的新起点，它旨在成为一个通用的WEB应用程序框架和项目模板。ASP.NET Boilerplate 基于DDD的经典分层架构思想，实现了众多DDD的概念（但没有实现所有DDD的概念）。ABP不仅架构设计和代码写的好，文档也很全面详实（这是一个开发框架被技术选型的基础）。尤其国内的很多热心朋友还整理了中文的资料和文档，比如郭阳铭的系列文章（http://www.cnblogs.com/mienreal/p/4528470.html）和ABP框架中国小组的中文文档（https://github.com/ABPFrameWorkGroup/AbpDocument2Chinese）。

多租户

通常SaaS都是需要多租户支持的。维基百科对多租户的解释是：软件多租户是指一个软件架构的实例软件运行在一个服务器上，但存在多个租户。租户是一组共享一个公共的用户访问特定权限的软件实例。多租户架构,软件应用程序旨在提供每个租户专用的实例包括数据、配置、用户管理、租户个体功能和非功能属性。多租户与多实例架构，独立的软件实例代表不同的租户操作。

多租户一般涉及如下几种场景：

• 多部署-多数据库：即针对每个租户独立部署一套应用程序实例，每个实例对应一个数据库。这种不算是真正的多租户，不过对于在设计时没有考虑多租户的遗留系统采用这种部署方式不失为一种折中办法。
• 单部署-多数据库：只有唯一的一个应用程序实例，每个租户分别连接不同的数据库。
• 单部署-单数据库：应用程序实例和数据库都是一个。通过在需要隔离数据的数据表中加入一个类似TanantId或EnterpriseId来区分。
• 单部署-混搭数据库：应用程序实例一个，但是数据库根据情况，可以是单个或者多个。比如免费用户放到一个数据库中，高级用户分别有自己的数据库。
• 集群部署-单/多/混搭数据库：应用程序的逻辑实例还是一个（只是为了高可用和性能部署为一个集群），然后对应的数据库可以是单个、多个和混搭。

另外，除了针对租户的数据库以外，可能还需要一个全局的数据库（称之为主机数据库）来保存全局范围的配置数据。在单数据库情况下，主机数据可能就和租户数据放在一起（甚至同一个数据表中）。

ABP对多租户的支持

上面提到的所有多租户场景，在ABP都可以支持。只需要在启动配置中启用多租户即可。

Configuration.MultiTenancy.IsEnabled = true; 

当然，最常见的场景恐怕就是单部署-单数据库，所以ABP中内置了处理TenantId的机制（通过接口IMustHaveTenant或IMayHaveTenant来实现）。实体实现了IMustHaveTenant接口，会包含一个不能为空的TenantId属性，即意味着其中的数据库需要基于TenantId来进行隔离。实现了IMayHaveTenant接口，会包含一个能为空的TenantId属性，在TenantId为空的时候代表数据属于主机范围的，不为空的时候表示数据基于租户来隔离。

而ABP通过一个特殊封装的IAbpSession来给使用者提供当前TenantId的获取，如果是主机用户登录系统，那么TenantId就是为空的，否则就是登录用户所在租户的Id。

ABP在多租户下读取数据

ABP并非只是简单的给你的实体类添加一个TenantId属性，而是通过识别IMustHaveTenant或IMayHaveTenant接口，使用数据过滤机制（根据底层所用ORM不同有不同的实现方式）自动在你读取数据的时候，基于当前AbpSession中的TenantId来过滤数据。也就是说，你查询读取数据的时候，写“where item.TenantId == AbpSession.TenantId” 这样的代码是毫无必要的。

需要注意的是，如果实体实现的是IMustHaveTenant接口，且AbpSession.TenantId为null的时候（即主机用户），获取到的数据是所有租户的，除非你自己显式进行过滤。而在IMayHaveTenant情况下，AbpSession.TenantId为null获取到的是主机用户的数据。

ABP在多租户下写入数据

在多租户的情形下，写入数据也通过拦截机制（比如重写DbContext的SaveChanges方法），可以自动为你的实体设置TenantId属性，不管你用的是IMustHaveTenant还是IMayHaveTenant。虽然官方文档是推荐在创建实体的时候，总是显示设置TenantId的，尤其在使用IMayHaveTenant的时候（这也是abp使用者唯一需要关系这个属性的地方）。但是，就我个人的看法而言，利用框架的原因就是为了让编码简单，所以我还是倾向于建议大家不用显式设置TenantId。

ABP切换租户

最后，ABP也提供一系列机制让你在代码中切换tenant（包括租户与主机间的切换）。关于多租户的官方文档（http://www.aspnetboilerplate.com/Pages/Documents/Multi-Tenancy）最后的内容也详细讲到了切换租户的一些最佳实践。