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

4. 项目构建

我们将使用Spring Boot 2.1.5版本来实现这一演示项目，首先你需要在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的基本特性是否具备。登录控制器代码如下：

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

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

总结

Ubuntu 16.04下Docker部署SpringBoot、Mysql、Redis、Nginx和Vue

本文以开源项目SpringBlade和Saber为例。

1、创建自定义网络

目的是将用到的服务都放到同一个网络段，以方便互相通信。

docker network create --subnet 172.19.0.0/16 mynetwork

2、Docker安装MySQL、Redis、Nginx

（1）安装MySQL

docker pull mysql:5.7.30

cd ~

mkdir docker/mysql/{conf,logs,data} -p

cd docker/mysql

docker run --name mysql_blade --network=mynetwork --ip=172.19.0.6 -p 3307:3306 -v PWD/logs:/var/log/mysql -v PWD/data:/data:rw -v $PWD/conf/redis.conf:/etc/redis/redis.conf:ro --privileged=true --name redis-6389 -d redis redis-server /etc/redis/redis.conf

（3）安装Nginx

将Saber发布到Nginx中要用到

docker pull nginx

2、Docker打包SpringBlade

3、Docker打包并发布Saber

（1）编写nginx.conf

cd Saber

touch nginx.conf，写入以下内容：

//nginx.conf开始

user root;

worker_processes 1;

error_log /var/log/nginx/error.log warn;

pid /var/run/nginx.pid;

events {

worker_connections 1024;

}

http {

include /etc/nginx/mime.types;

default_type application/octet-stream;

}

//nginx.conf结束

（2）修改env.js文件

baseUrl要与下面的SpringBlade容器的地址和端口匹配：

（3）编写Dockerfile

编写dockerfile并将其放到与dist同一目录：

FROM nginx

VOLUME /tmp

ENV LANG en_US.UTF-8

ADD ./dist/ /usr/share/nginx/html/

COPY./nginx.conf /etc/nginx/

EXPOSE 1889

EXPOSE 443

（4）打包并发布

cd ~

mkdir docker/saber/conf -p

cd docker/saber

cp ~/Saber/nginx.conf conf

yarn run build

docker build -t saber:1.0 .（注意最后的.）

docker run -itd --name saber --network=mynetwork --ip=172.19.0.8 -p 1889:1889 -v $PWD/conf:/mnt/ saber:1.0

4、Docker打包并发布SpringBlade

（1）pom.xml配置

/

docker.repostory10.10.0.127:10080/docker.repostory

docker.registry.nameblade/docker.registry.name

docker.image.tag0.0.1/docker.image.tag

docker.maven.plugin.version1.4.10/docker.maven.plugin.version

build

finalNameSpringBlade/finalName

resources

resource

directorysrc/main/resources/directory

/resource

resource

directorysrc/main/java/directory

includes

include* / .xml/include

/includes

/resource

/resources

pluginManagement

plugins

plugin

groupIdorg.springframework.boot/groupId

artifactIdspring-boot-maven-plugin/artifactId

version {project.build.finalName}/finalName

/configuration

executions

execution

goals

goalrepackage/goal

/goals

/execution

/executions

/plugin

plugin

groupIdcom.spotify/groupId

artifactIddockerfile-maven-plugin/artifactId

version {project.basedir}/contextDirectory

useMavenSettingsForAuthtrue/useMavenSettingsForAuth

repository {docker.registry.name}/ {docker.image.tag}/tag

buildArgs

JAR_FILEtarget/ {java.version}/source

target${java.version}/target

encodingUTF-8/encoding

compilerArgs

arg-parameters/arg

/compilerArgs

/configuration

/plugin

/plugins

/build

（2）yml配置

redis及mysql都要与前面的创建容器时的配置相同：

（3）创建私有仓库（利用Harbor）

在harbor管理界面创建项目blade，下面上传镜像的时候要加入项目路径。

（4）打包

mvn clean install dockerfile:build -Dmaven.test.skip=true

（5）上传到私有仓库

两种方式：

mvn dockerfile:push

或者docker push 10.10.0.127:10080/blade/springblade:0.0.1

然后在Harbor管理后台就可以看到镜像了。

要pull下来的话：

docker pull 10.10.0.127:10080/blade/springblade:0.0.1

（6）发布

cd ~

mkdir docker/blade/app -p

cd docker/blade

docker run -itd --name blade --network=mynetwork --ip=172.19.0.7 -p 9001:9001 -v $PWD/app:/mnt/ 10.10.0.127:10080/blade/springblade:0.0.1

至此，就可以通过localhost:1889来访问Saber了。

另外，我通过uri来区分多租户。例如localhost:1889是管理租户，localhost:1889/test是名为test的租户。这样就避免了在登录界面填写租户id。

java低代码开发平台有哪些？

java低代码开发平台，能快速开发，节省人工成本，提高开发效率。

国内快速开发平台如目前流行的低代码快速开发平台（如有天翎 ?，普元，天纵，等厂家）myApps微服务架构，多租户模式，门户集成，单点登录，移动端（企业微信，钉钉，APP），功能模板都是可视化配置（如表单引擎，视图引擎，流程引擎，报表引擎，像操作word或Excel，扩展性强，提供源代码，支持国产数据库，操作系统（（瀚高，达梦，统信，中标麒麟等）如天翎java平台后端核心框架：Spring MVC+SpringBoot2.X，视图框架：Spring MVC，缓存框架：Ehcache+Redis，持久层框架：Hibernate+JDBC+File System Serilizable，安全框架：Spring security+antisamyt等

长风网租户id是什么

长风网租户id是每个用户独有的ID，属于个人隐私。网络通是一款线上办公软件。使用户可以在巡视过程中快速向中心报告城管问题，接受中心的任务指示并给予反馈，帮助用户快速完成日常工作，节省大量时间。通过该应用程序记录每个网格成员的日常活动轨迹，通过问题发现、信息接受、任务调度、任务处理、处理反馈、验证与解决六个环节形成一套完整的封闭式案例处理工作流。

名称栏目：租户id植入java代码 租户id如何设计
标题URL：http://scyingshan.cn/article/dddpdgs.html