。

多租户是一种软件架构技术#xff0c;它允许一个应用程序实例为多个租户提供服务。

每个租户都有自己的数据和配置#xff0c;但应用程序实例是共享的。

而在我们的Spring

Boot

在如今的软件开发中多租户(Multi-Tenancy)应用已经变得越来越常见。

多租户是一种软件架构技术它允许一个应用程序实例为多个租户提供服务。

每个租户都有自己的数据和配置但应用程序实例是共享的。

而在我们的Spring

Boot

动态数据源实现多租户分库的原理主要是通过切换不同的数据库连接来实现。

对于每个租户应用程序会使用一个独立的数据库连接这样每个租户就拥有了自己的数据隔离空间。

具体来说当我们创建一个新的租户时我们同时也为这个租户创建一个新的数据库连接。

这些数据库连接被存储在一个数据源工厂中我们可以根据租户的ID或者其他唯一标识符来获取对应的数据库连接。

当一个租户需要访问其数据时我们从数据源工厂中获取该租户对应的数据库连接然后使用这个连接来执行数据库操作。

三、引入依赖

xmlnshttp://maven.apache.org/POM/4.0.0

xmlns:xsihttp://www.w3.org/2001/XMLSchema-instancexsi:schemaLocationhttp://maven.apache.org/POM/4.0.0

https://maven.apache.org/xsd/maven-4.0.0.xsdmodelVersion4.0.0/modelVersionparentgroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-parent/artifactIdversion2.1.3.RELEASE/versionrelativePath/

!--

--/parentgroupIdcom.bc/groupIdartifactIddemo/artifactIdversion0.0.1-SNAPSHOT/versionnamedemo/namedescriptionDemo

project

Boot/descriptionpropertiesjava.version1.8/java.version/propertiesdependenciesdependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-web/artifactId/dependencydependencygroupIdorg.hibernate/groupIdartifactIdhibernate-validator/artifactIdversion6.0.1.Final/version/dependencydependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-test/artifactIdscopetest/scope/dependencydependencygroupIdorg.projectlombok/groupIdartifactIdlombok/artifactIdversion1.18.0/versionscopeprovided/scope/dependencydependencygroupIdcn.hutool/groupIdartifactIdhutool-all/artifactIdversion5.8.25/version/dependencydependencygroupIdcom.baomidou/groupIdartifactIdmybatis-plus-boot-starter/artifactIdversion3.5.3.1/version/dependencydependencygroupIdmysql/groupIdartifactIdmysql-connector-java/artifactIdversion8.0.33/version/dependency/dependenciesbuildpluginsplugingroupIdorg.springframework.boot/groupIdartifactIdspring-boot-maven-plugin/artifactId/plugin/plugins/build/project

四、配置yml

jdbc:mysql://127.0.0.1:3306/demo?useUnicodetruecharacterEncodingutf8serverTimezoneUTCusername:

rootpassword:

com.zaxxer.hikari.HikariDataSource

classpath:mapper/*.xmlmybatis-plus:configuration:log-impl:

org.apache.ibatis.logging.stdout.StdOutImpl

五、数据准备

在demo库中新建一张名为“tenant_datasource”的表用于存储多租户的数据源配置信息

CREATE

然后执行下述SQL往“tenant_datasource”表中插入一些测试数据

insert

values(tenant1,jdbc:mysql://localhost:3306/tenant1_db,root,123456);

insert

values(tenant2,jdbc:mysql://localhost:3306/tenant2_db,root,123456);

在tenant1_db库中新建一张名为“user”的表用于存储多租户1的用户信息

CREATE

然后执行下述SQL往tenant1_db库在的“user”表中插入一些测试数据

insert

在tenant2_db库中新建一张名为“user”的表用于存储多租户2的用户信息

CREATE

然后执行下述SQL往tenant2_db库在的“user”表中插入一些测试数据

insert

com.baomidou.mybatisplus.annotation.IdType;

import

com.baomidou.mybatisplus.annotation.TableField;

import

com.baomidou.mybatisplus.annotation.TableId;

import

com.baomidou.mybatisplus.annotation.TableName;

import

com.baomidou.mybatisplus.annotation.IdType;

import

com.baomidou.mybatisplus.annotation.TableField;

import

com.baomidou.mybatisplus.annotation.TableId;

import

com.baomidou.mybatisplus.annotation.TableName;

import

org.springframework.boot.jdbc.DataSourceBuilder;import

public

DataSourceBuilder.create().url(this.url).username(this.username).password(this.password).build();}

七、编写默认数据源配置类

org.springframework.boot.context.properties.ConfigurationProperties;

import

org.springframework.stereotype.Component;Data

Component

com.baomidou.mybatisplus.core.mapper.BaseMapper;

import

org.springframework.stereotype.Repository;Repository

public

com.baomidou.mybatisplus.core.mapper.BaseMapper;

import

com.example.demo.entity.TenantDataSource;

import

org.springframework.stereotype.Repository;Repository

public

在启动类配置扫描路径MapperScan(com.example.demo.mapper)

import

org.mybatis.spring.annotation.MapperScan;

import

org.springframework.boot.SpringApplication;

import

org.springframework.boot.autoconfigure.SpringBootApplication;MapperScan(com.example.demo.mapper)

public

{SpringApplication.run(DemoApplication.class,

args);}

com.example.demo.mapper.UserMapper;

import

org.springframework.beans.factory.annotation.Autowired;

import

org.springframework.stereotype.Service;Service

public

userMapper.selectById(id);return

user;}

org.springframework.beans.factory.annotation.Autowired;

import

org.springframework.boot.jdbc.DataSourceBuilder;

import

org.springframework.stereotype.Component;import

javax.annotation.PostConstruct;

import

dynamicDataSourceProperties;private

final

DataSourceBuilder.create().url(dynamicDataSourceProperties.getUrl()).username(dynamicDataSourceProperties.getUsername()).password(dynamicDataSourceProperties.getPassword()).build();dataSources.put(default,

void

dataSources.get(tenantId);}public

MapString,

lombok.extern.slf4j.Slf4j;Slf4j

public

使用ThreadLocal来存储当前线程的数据源名称(租户标识)保证多线程情况下各自的数据源互不影响private

static

{tenantId.set(id);log.info(已切换到数据源:{},

id);}public

{tenantId.remove();log.info(已切换回默认数据源);}

十二、创建动态数据源

创建一个动态数据源类继承AbstractRoutingDataSource用于动态切换数据源

import

org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;Slf4j

Data

如果希望所有数据源在启动配置时就加载好这里通过设置数据源Key值来切换数据源**

Object

org.springframework.beans.factory.annotation.Autowired;

import

org.springframework.context.annotation.Bean;

import

org.springframework.context.annotation.Configuration;

import

org.springframework.jdbc.datasource.DataSourceTransactionManager;import

java.util.HashMap;

创建数据源配置类用于配置动态数据源*/Configuration

public

1、将数据源default设置为默认数据源DynamicDataSource

dynamicDataSource

DynamicDataSource();dynamicDataSource.setDefaultTargetDataSource(dataSourceManager.getDataSource(default));//

2、获取初始化时所有的数据源并设置目标数据源必须为targetDataSources设置初始值否则会报错MapObject,

Object

HashMap();targetDataSources.putAll(dataSourceManager.getAllDataSources());dynamicDataSource.setTargetDataSources(targetDataSources);return

transactionManager(DynamicDataSource

dynamicDataSource)

DataSourceTransactionManager(dynamicDataSource);}

十四、创建多租户数据源服务

com.example.demo.entity.TenantDataSource;

import

com.example.demo.mapper.TenantDataSourceMapper;

import

org.springframework.beans.factory.annotation.Autowired;

import

org.springframework.stereotype.Service;import

javax.annotation.PostConstruct;

import

dataSourceManager;Autowiredprivate

DynamicDataSource

dynamicDataSource;Autowiredprivate

tenantDataSourceMapper;PostConstructpublic

void

1、从默认的数据源中查询出所有的租户信息然后覆盖DynamicDataSource中的targetDataSources属性MapObject,

Object

tenantDataSourceMapper.selectList(null);for

(TenantDataSource

{dataSourceManager.addDataSource(tenantDataSource.getTenantId(),

tenantDataSource.createDataSource());}targetDataSources.putAll(dataSourceManager.getAllDataSources());dynamicDataSource.setTargetDataSources(targetDataSources);//

2、必须执行此操作才会重新初始化AbstractRoutingDataSource中的resolvedDataSources也只有这样动态切换数据源才会起效dynamicDataSource.afterPropertiesSet();}

十五、构建拦截器并将其注册到InterceptorRegistry中

import

com.example.demo.config.DataSourceManager;

import

com.example.demo.config.TenantContext;

import

org.springframework.beans.factory.annotation.Autowired;

import

org.springframework.context.annotation.Configuration;

import

org.springframework.web.servlet.HandlerInterceptor;import

javax.servlet.http.HttpServletRequest;

import

javax.servlet.http.HttpServletResponse;Configuration

public

dataSourceManager;Overridepublic

boolean

dataSourceManager.containDataSourceKey(tenantId)

{TenantContext.setTenantId(tenantId);return

true;}else{return

afterCompletion(HttpServletRequest

request,

com.example.demo.Interceptor.AuthInterceptor;

import

org.springframework.beans.factory.annotation.Autowired;

import

org.springframework.context.annotation.Configuration;

import

org.springframework.web.servlet.config.annotation.InterceptorRegistry;

import

org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;Configuration

public

addInterceptors(InterceptorRegistry

registry)

{registry.addInterceptor(authInterceptor);}

十六、创建Controller

com.example.demo.serivice.UserService;

import

org.springframework.beans.factory.annotation.Autowired;

import

org.springframework.web.bind.annotation.GetMapping;

import

org.springframework.web.bind.annotation.PathVariable;

import

org.springframework.web.bind.annotation.RestController;RestController

public

userService;GetMapping(/user/{userId})public

User

userService.getUserById(userId);}

十七、测试

启动应用程序通过访问localhost:10086/user/{userId}

来测试多租户分库功能

可以看到上述测试示例中已经实现了不同的租户查询独立的数据库信息。

十八、适用场景

多租户系统开发适用于多租户系统每个租户有独立的数据库通过动态数据源切换实现多租户数据隔离。

租户级数据隔离当多个租户共享同一应用但需要数据隔离时可以通过此模式实现。

灵活扩展适用于系统需求可能动态扩展租户每个租户有独立数据库的场景不需修改系统架构。

十九、优点

数据隔离性强每个租户有独立的数据库数据隔离保护租户数据安全。

性能优化每个租户有独立的数据库避免多租户共享同一数据库的性能瓶颈。

方便扩展可以轻松实现动态增加新租户每个租户有独立的数据库。

可维护性高MyBatisPlus提供了便捷的操作数据库的功能减少开发人员的工作量。

易用性强Spring

Boot集成MyBatisPlus简化了配置和集成流程提高开发效率。

二十、总结

Plus结合通过动态数据源实现多租户分库是一种高效、灵活、易维护的解决方案适用于多租户系统的开发。

可以有效地保护租户数据安全提高系统性能同时具有良好的可扩展性和可维护性。