Spring Boot 构建多租户SaaS平台核心技术指南

1 概述

笔者从2014年开始接触SaaS（Software as a Service），即多租户（或多承租）软件应用平台；并一直从事相关领域的架构设计及研发工作。机缘巧合，在笔者本科毕业设计时完成了一个基于SaaS的高效财务管理平台的课题研究，从中收获颇多。最早接触SaaS时，国内相关资源匮乏，唯一有的参照资料是《互联网时代的软件革命：SaaS架构设计》（叶伟等著）一书。最后课题的实现是基于OSGI（Open Service Gateway Initiative）Java动态模块化系统规范来实现的。

时至今日，五年的时间过去了，软件开发的技术发生了巨大的改变，笔者所实现SaaS平台的技术栈也更新了好几波，真是印证了那就话：“山重水尽疑无路，柳暗花明又一村”。基于之前走过的许多弯路和踩过的坑，以及近段时间有许多网友问我如何使用Spring Boot实现多租户系统，决定写一篇文章聊一聊关于SaaS的硬核技术。

说起SaaS，它只是一种软件架构，并没有多少神秘的东西，也不是什么很难的系统，我个人的感觉，SaaS平台的难度在于商业上的运营，而非技术上的实现。就技术上来说，SaaS是这样一种架构模式：它让多个不同环境的用户使用同一套应用程序，且保证用户之间的数据相互隔离。现在想想看，这也有点共享经济的味道在里面。

笔者在这里就不再深入聊SaaS软件成熟度模型和数据隔离方案对比的事情了。今天要聊的是使用Spring Boot快速构建独立数据库/共享数据库独立Schema的多租户系统。我将提供一个SaaS系统最核心的技术实现，而其他的部分有兴趣的朋友可以在此基础上自行扩展。

2 尝试了解多租户的应用场景

假设我们需要开发一个应用程序，并且希望将同一个应用程序销售给N家客户使用。在常规情况下，我们需要为此创建N个Web服务器（Tomcat）,N个数据库（DB），并为N个客户部署相同的应用程序N次。现在，如果我们的应用程序进行了升级或者做了其他任何的改动，那么我们就需要更新N个应用程序同时还需要维护N台服务器。接下来，如果业务开始增长，客户由原来的N个变成了现在的N+M个，我们将面临N个应用程序和M个应用程序版本维护，设备维护以及成本控制的问题。运维几乎要哭死在机房了…

为了解决上述的问题，我们可以开发多租户应用程序，我们可以根据当前用户是谁，从而选择对应的数据库。例如，当请求来自A公司的用户时，应用程序就连接A公司的数据库，当请求来自B公司的用户时，自动将数据库切换到B公司数据库，以此类推。从理论上将没有什么问题，但我们如果考虑将现有的应用程序改造成SaaS模式，我们将遇到第一个问题：如果识别请求来自哪一个租户？如何自动切换数据源？

3 维护、识别和路由租户数据源

我们可以提供一个独立的库来存放租户信息，如数据库名称、链接地址、用户名、密码等，这可以统一的解决租户信息维护的问题。租户的识别和路由有很多种方法可以解决，下面列举几个常用的方式：

解决了上述问题后，我们再来看看如何获取客户端传入的租户信息，以及在我们的业务代码中如何使用租户信息（最关键的是DataSources的问题）。

我们都知道，在启动Spring Boot应用程序之前，就需要为其提供有关数据源的配置信息（有使用到数据库的情况下）,按照一开始的需求，有N个客户需要使用我们的应用程序，我们就需要提前配置好N个数据源（多数据源）,如果N<50,我认为我还能忍受，如果更多，这样显然是无法接受的。为了解决这一问题，我们需要借助Hibernate 5提供的动态数据源特性，让我们的应用程序具备动态配置客户端数据源的能力。简单来说，当用户请求系统资源时，我们将用户提供的租户信息（tenantId）存放在ThreadLoacal中，紧接着获取TheadLocal中的租户信息，并根据此信息查询单独的租户库，获取当前租户的数据配置信息，然后借助Hibernate动态配置数据源的能力，为当前请求设置数据源，最后之前用户的请求。这样我们就只需要在应用程序中维护一份数据源配置信息（租户数据库配置库），其余的数据源动态查询配置。接下来，我们将快速的演示这一功能。

4 项目构建

我们将使用Spring Boot 215版本来实现这一演示项目，首先你需要在Maven配置文件中加入如下的一些配置：

然后提供一个可用的配置文件，并加入如下的内容：

接下来，我们需要关闭Spring Boot自动配置数据源的功能，在项目主类上添加如下的设置：

最后，让我们看看整个项目的结构：

5 实现租户数据源查询模块

我们将定义一个实体类存放租户数据源信息，它包含了租户名，数据库连接地址，用户名和密码等信息，其代码如下：

持久层我们将继承JpaRepository接口，快速实现对数据源的CURD操作，同时提供了一个通过租户名查找租户数据源的接口，其代码如下：

业务层提供通过租户名获取租户数据源信息的服务（其余的服务各位可自行添加）：

接下来是配置自定义的数据源，其源码如下：

在改配置类中，我们主要提供包扫描路径，实体管理工程，事务管理器和数据源配置参数的配置。

6 实现租户业务模块

在此小节中，租户业务模块我们仅提供一个用户登录的场景来演示SaaS的功能。其实体层、业务层和持久化层根普通的Spring Boot Web项目没有什么区别，你甚至感觉不到它是一个SaaS应用程序的代码。

首先，创建一个用户实体User，其源码如下：

业务层提供了一个根据用户名检索用户信息的服务，它将调用持久层的方法根据用户名对租户的用户表进行检索，如果找到满足条件的用户记录，则返回用户信息，如果没有找到，则返回null;持久层和业务层的源码分别如下：

7 配置拦截器

我们需要提供一个租户信息的拦截器，用以获取租户标识符，其源代码和配置拦截器的源代码如下：

8 维护租户标识信息

在这里，我们使用ThreadLocal来存放租户标识信息，为动态设置数据源提供数据支持，该类提供了设置租户标识、获取租户标识以及清除租户标识三个静态方法。其源码如下：

9 动态数据源切换

要实现动态数据源切换，我们需要借助两个类来完成，CurrentTenantIdentifierResolver和AbstractDataSourceBasedMultiTenantConnectionProviderImpl。从它们的命名上就可以看出，一个负责解析租户标识，一个负责提供租户标识对应的租户数据源信息。

首先，我们需要实现CurrentTenantIdentifierResolver接口中的resolveCurrentTenantIdentifier()和validateExistingCurrentSessions()方法，完成租户标识的解析功能。实现类的源码如下：

有了租户标识符解析类之后，我们需要扩展租户数据源提供类，实现从数据库动态查询租户数据源信息，其源码如下：

最后，我们还需要提供租户业务模块数据源配置，这是整个项目核心的地方，其代码如下：

10 应用测试

最后，我们通过一个简单的登录案例来测试本次课程中的SaaS应用程序，为此，需要提供一个Controller用于处理用户登录逻辑。在本案例中，没有严格的对用户密码进行加密，而是使用明文进行比对，也没有提供任何的权限认证框架，知识单纯的验证SaaS的基本特性是否具备。登录控制器代码如下：

在启动项目之前，我们需要为主数据源创建对应的数据库和数据表，用于存放租户数据源信息，同时还需要提供一个租户业务模块数据库和数据表，用来存放租户业务数据。一切准备就绪后，启动项目，在浏览器中输入：http://localhost:8080/loginhtml

在登录窗口中输入对应的租户名，用户名和密码，测试是否能够正常到达主页。可以多增加几个租户和用户，测试用户是否正常切换到对应的租户下。

总结

天府市民云安置房怎样办理租房网签备案？

天府市民云安置房办理租房备案方法如下：

1、上天府市民云搜索“住房租赁”或点击首页“住在成都”进入住房租赁服务，点击“网签备案”即可进入备案页面。

2、点击“我是房东我要备案”。房东备案可直接选择名下出租的房屋信息，租客备案需填写房屋产权信息进入到下一步。(签约备案时，可选择任意一种方式进行签约，但请勿同时操作。)

3、完善房屋租赁信息(包括备案原因、租金、承租人信息、实际居住人信息、合同时间等)，信息填写完毕后进行合同预览，确认信息无误后点击“签约”开始网上签约。

4、房东通过刷脸及电子签名确认后，租客打开天府市民云APP，进入网签备案，在“待签约”选项下，即可查看待签约合同，通过刷脸及电子签

5、签约成功后，系统将自动审核备案，“备案证明”就可以保存到手机中，打印使用。名完成签约。

天府市民云怎样查询房屋备案信息？

房屋备案，就是房地产管理部门为了规范房屋租赁进行的登记工作。由出租屋管理服务中心工作站内勤岗负责受理房屋租赁双方当事人的资料，并进行审查，并对税收员负责对房屋租赁双方当事人的资料进行复查。购买了房屋，担心被骗，总会想要去查询是否备案了，现在好了，可以在天府市民云App上直接查询。

1，打开手机内的天府市民云App。

2，点击页面中部的“房屋管理服务”。

3，点击“房屋备案信息”。

4，输入app认证手机收到的验证码，点击“立即验证”。

5，弹出查询结果。需实名认证后才能查询房屋信息，若未查询到，可到房屋所属区域房管局问询。

腾讯云备案名称备注怎么填写？

依次填写自己的姓名和身份证号码，居住地址，单位地址，紧急联系人

备案授权码的作用？

备案授权码是由服务器生成的用于备案的授权凭证，实际指向该服务器的IP地址。

使用场景

用户李云在腾讯云注册了账号A和账号B。在A账号下购买了云服务器，用于搭建总公司和分公司的官网，B账号没有购买服务。但一个腾讯云账号只能备案一个主体(此处，总公司和分公司为两个主体)的网站。因此另外一个主体的备案就需要放在B账号中。B账号由于没有购买云服务器，就需要通过备案授权码来提交备案，备案授权码由A账号的云服务器生成。

创建备案授权码

登录已购买云服务器的A账号，进入网站备案控制台>备案授权码页面。

单击+生成授权码。

选择要进行关联的云服务，单击确定，进入生成流程。

备案授权码生成成功后，可在页面上查看具体授权码、进行更改云服务或删除操作。

使用备案授权码

登录无可用云服务器的B账号，进入网站备案控制台，在备案管理页面单击+开始备案，进入备案流程。

在验证备案类型步骤，备案云服务一项选择备案授权码，粘贴A账号生成的备案授权码。

验证成功后，即可使用B账号继续办理备案，备案IP地址为提供备案授权码的云服务器对应的IP地址。

成都天府市民云居住证怎么备案？

登录天府市民云搜索“住房租赁”或点击首页“住在成都”进入住房租赁服务，点击“网签备案”即可进入备案页面。

然后选择房东或者租客，根据提示完成操作，一般都是三步。

第一步：社区居住申报登记；第二步：打开天府市民云App，点击住在成都；

第三步：选择租赁网签备案。

多租户技术的实现重点，在于不同租户间应用程序环境的隔离（application context isolation）以及数据的隔离（data isolation)，以维持不同租户间应用程序不会相互干扰，同时数据的保密性也够强。

应用程序部份：通过进程或是支持多应用程序同时运行的装载环境（例如Web Server，像是Apache或IIS等）来做进程间的隔离，或是在同一个伺服程序（server）进程内以运行绪的方式隔离。

数据部份：通过不同的机制将不同租户的数据隔离，Force是采用中介数据（metadata）的技术来切割，微软 MSDN 的技术文件则是展示了使用结构描述的方式隔离。

多租户就是说多个租户共用一个实例，租户的数据既有隔离又有共享,从而解决数据存储的问题。从架构层面来分析，SaaS区别

于传统技术的重要差别就是Multi-Tenant模式。

SaaS多租户在数据存储上存在三种主要的方案，分别是

1独立数据库

这是第一种方案，即一个租户一个数据库，这种方案的用户数据隔离级别最高，安全性最好，但成本也高。

优点：

为不同的租户提供独立的数据库，有助于简化数据模型的扩展设计，满足不同租户的独特需求；

如果出现故障，恢复数据比较简单。

缺点：

增大了数据库的安装数量，随之带来维护成本和购置成本的增加。

这种方案与传统的一个客户、一套数据、一套部署类似，差别只在于软件统一部署在运营商那里。如果面对的是银行、医院等需要非常高数据隔离级别的租户，可以选择这种模式，提高租用的定价。如果定价较低，产品走低价路线，这种方案一般对运营商来说是无法承受的。

2共享数据库，隔离数据架构

这是第二种方案，即多个或所有租户共享Database，但一个Tenant一个Schema。

优点：

为安全性要求较高的租户提供了一定程度的逻辑数据隔离，并不是完全隔离；每个数据库可以支持更多的租户数量。

缺点：　　如果出现故障，数据恢复比较困难，因为恢复数据库将牵扯到其他租户的数据；　　如果需要跨租户统计数据，存在一定困难。

3共享数据库，共享数据架构

这是第三种方案，即租户共享同一个Database、同一个Schema，但在表中通过TenantID区分租户的数据。这是共享程度最高、隔离级别最低的模式。

优点：

三种方案比较，第三种方案的维护和购置成本最低，允许每个数据库支持的租户数量最多。

缺点：

隔离级别最低，安全性最低，需要在设计开发时加大对安全的开发量；　　数据备份和恢复最困难，需要逐表逐条备份和还原。　　如果希望以最少的服务器为最多的租户提供服务，并且租户接受以牺牲隔离级别换取降低成本，这种方案最适合。

根据相关资料查询显示：可以。网格员是将居民信息数据化，服务社区居民的群体，拥有着社区资料查询管理的权限。房东删除租客信息后，会在社区服务器内留档，保存删除记录，网格员在后台系统中就可以查到。