MybatisPlus 多租户架构(Multi-tenancy)实现详解

在进行多租户架构(Multi-tenancy)实现之前,先了解一下相关的定义吧:

什么是多租户

多租户技术或称多重租赁技术,简称SaaS,是一种软件架构技术,是实现如何在多用户环境下(此处的多用户一般是面向企业用户)共用相同的系统或程序组件,并且可确保各用户间数据的隔离性。

简单讲:在一台服务器上运行单个应用实例,它为多个租户(客户)提供服务。从定义中我们可以理解:多租户是一种架构,目的是为了让多用户环境下使用同一套程序,且保证用户间数据隔离。那么重点就很浅显易懂了,多租户的重点就是同一套程序下实现多用户数据的隔离。

数据隔离方案

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

独立数据库

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

  • 优点:为不同的租户提供独立的数据库,有助于简化数据模型的扩展设计,满足不同租户的独特需求;如果出现故障,恢复数据比较简单。
  • 缺点:增多了数据库的安装数量,随之带来维护成本和购置成本的增加。

共享数据库,独立 Schema

多个或所有租户共享Database,但是每个租户一个Schema(也可叫做一个user)。底层库比如是:DB2、ORACLE等,一个数据库下可以有多个SCHEMA。

  • 优点:为安全性要求较高的租户提供了一定程度的逻辑数据隔离,并不是完全隔离;每个数据库可支持更多的租户数量。
  • 缺点:如果出现故障,数据恢复比较困难,因为恢复数据库将牵涉到其他租户的数据;

共享数据库,共享 Schema,共享数据表

即租户共享同一个Database、同一个Schema,但在表中增加TenantID多租户的数据字段。这是共享程度最高、隔离级别最低的模式。

简单来讲,即每插入一条数据时都需要有一个客户的标识。这样才能在同一张表中区分出不同客户的数据,这也是我们系统目前用到的(provider_id)

  1. 优点:三种方案比较,第三种方案的维护和购置成本最低,允许每个数据库支持的租户数量最多。
  2. 缺点:隔离级别最低,安全性最低,需要在设计开发时加大对安全的开发量; 数据备份和恢复最困难,需要逐表逐条备份和还原。

<!--- more --->

利用MybatisPlus实现

这里我们选用了第三种方案(共享数据库,共享 Schema,共享数据表)来实现,也就意味着,每个数据表都需要有一个租户标识(provider_id)

现在有数据库表(user)如下:

字段名 字段类型 描述
id BIGINT(20) 主键
provider_id BIGINT(20) 服务商ID
name VARCHAR(30) 姓名

provider_id视为租户ID,用来隔离租户与租户之间的数据,如果要查询当前服务商的用户,SQL大致如下:

SELECT * FROM user t WHERE t.name LIKE '%Tom%' AND t.provider_id = 1;

试想一下,除了一些系统共用的表以外,其他租户相关的表,我们都需要不厌其烦的加上AND t.provider_id = ?查询条件,稍不注意就会导致数据越界,数据安全问题让人担忧。

好在有了MybatisPlus这个神器,可以极为方便的实现多租户SQL解析器,官方文档如下:
http://mp.baomidou.com/guide/tenant.html

这里终于进入了正题,开始搭建一个极为简单的开发环境吧!

新建SpringBoot环境

POM文件如下,主要集成了MybatisPlus以及H2数据库(方便测试)

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.wuwenze</groupId>
  <artifactId>mybatis-plus-multi-tenancy</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>mybatis-plus-multi-tenancy</name>
  <description>Demo project for Spring Boot</description>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.0.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>com.google.guava</groupId>
      <artifactId>guava</artifactId>
      <version>19.0</version>
    </dependency>

    <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-boot-starter</artifactId>
      <version>3.0.5</version>
    </dependency>
    <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus</artifactId>
      <version>3.0.5</version>
    </dependency>
    <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-generator</artifactId>
      <version>3.0.5</version>
    </dependency>

    <dependency>
      <groupId>com.h2database</groupId>
      <artifactId>h2</artifactId>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
</project>

数据源配置(application.yml)

spring:
 datasource:
  driver-class-name: org.h2.Driver
  schema: classpath:db/schema.sql
  data: classpath:db/data.sql
  url: jdbc:h2:mem:test
  username: root
  password: test

logging:
 level:
  com.wuwenze.mybatisplusmultitenancy: debug

对应的H2数据库初始化schema文件

#schema.sql
DROP TABLE IF EXISTS user;
CREATE TABLE user
(
  id BIGINT(20) NOT NULL COMMENT '主键',
  provider_id BIGINT(20) NOT NULL COMMENT '服务商ID',
  name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
  PRIMARY KEY (id)
);

#data.sql
INSERT INTO user (id, provider_id, name) VALUES (1, 1, 'Tony老师');
INSERT INTO user (id, provider_id, name) VALUES (2, 1, 'William老师');
INSERT INTO user (id, provider_id, name) VALUES (3, 2, '路人甲');
INSERT INTO user (id, provider_id, name) VALUES (4, 2, '路人乙');
INSERT INTO user (id, provider_id, name) VALUES (5, 2, '路人丙');
INSERT INTO user (id, provider_id, name) VALUES (6, 2, '路人丁');

MybatisPlus Config

基础环境搭建完成,现在开始配置MybatisPlus多租户相关的实现。

1) 核心配置:TenantSqlParser

@Configuration
@MapperScan("com.wuwenze.mybatisplusmultitenancy.mapper")
public class MybatisPlusConfig {

  private static final String SYSTEM_TENANT_ID = "provider_id";
  private static final List<String> IGNORE_TENANT_TABLES = Lists.newArrayList("provider");

  @Autowired
  private ApiContext apiContext;

  @Bean
  public PaginationInterceptor paginationInterceptor() {
    PaginationInterceptor paginationInterceptor = new PaginationInterceptor();

    // SQL解析处理拦截:增加租户处理回调。
    TenantSqlParser tenantSqlParser = new TenantSqlParser()
        .setTenantHandler(new TenantHandler() {

          @Override
          public Expression getTenantId() {
            // 从当前系统上下文中取出当前请求的服务商ID,通过解析器注入到SQL中。
            Long currentProviderId = apiContext.getCurrentProviderId();
            if (null == currentProviderId) {
              throw new RuntimeException("#1129 getCurrentProviderId error.");
            }
            return new LongValue(currentProviderId);
          }

          @Override
          public String getTenantIdColumn() {
            return SYSTEM_TENANT_ID;
          }

          @Override
          public boolean doTableFilter(String tableName) {
            // 忽略掉一些表:如租户表(provider)本身不需要执行这样的处理。
            return IGNORE_TENANT_TABLES.stream().anyMatch((e) -> e.equalsIgnoreCase(tableName));
          }
        });
    paginationInterceptor.setSqlParserList(Lists.newArrayList(tenantSqlParser));
    return paginationInterceptor;
  }

  @Bean(name = "performanceInterceptor")
  public PerformanceInterceptor performanceInterceptor() {
    return new PerformanceInterceptor();
  }
}

2) ApiContext

@Component
public class ApiContext {
  private static final String KEY_CURRENT_PROVIDER_ID = "KEY_CURRENT_PROVIDER_ID";
  private static final Map<String, Object> mContext = Maps.newConcurrentMap();

  public void setCurrentProviderId(Long providerId) {
    mContext.put(KEY_CURRENT_PROVIDER_ID, providerId);
  }

  public Long getCurrentProviderId() {
    return (Long) mContext.get(KEY_CURRENT_PROVIDER_ID);
  }
}

3) Entity、Mapper

@Data
@ToString
@Accessors(chain = true)
public class User {
  private Long id;
  private Long providerId;
  private String name;
}

public interface UserMapper extends BaseMapper<User> {

}

单元测试

com.wuwenze.mybatisplusmultitenancy.MybatisPlusMultiTenancyApplicationTests

@Slf4j
@RunWith(SpringRunner.class)
@FixMethodOrder(MethodSorters.JVM)
@SpringBootTest(classes = MybatisPlusMultiTenancyApplication.class)
public class MybatisPlusMultiTenancyApplicationTests {

  @Autowired
  private ApiContext apiContext;

  @Autowired
  private UserMapper userMapper;

  @Before
  public void before() {
    // 在上下文中设置当前服务商的ID
    apiContext.setCurrentProviderId(1L);
  }

  @Test
  public void insert() {
    User user = new User().setName("新来的Tom老师");
    Assert.assertTrue(userMapper.insert(user) > 0);

    user = userMapper.selectById(user.getId());
    log.info("#insert user={}", user);

    // 检查插入的数据是否自动填充了租户ID
    Assert.assertEquals(apiContext.getCurrentProviderId(), user.getProviderId());
  }

  @Test
  public void selectList() {
    userMapper.selectList(null).forEach((e) -> {
      log.info("#selectList, e={}", e);
      // 验证查询的数据是否超出范围
      Assert.assertEquals(apiContext.getCurrentProviderId(), e.getProviderId());
    });
  }
}

运行结果

2018-11-29 21:07:14.262 INFO 18688 --- [      main] .MybatisPlusMultiTenancyApplicationTests : Started MybatisPlusMultiTenancyApplicationTests in 2.629 seconds (JVM running for 3.904)
2018-11-29 21:07:14.554 DEBUG 18688 --- [      main] c.w.m.mapper.UserMapper.insert      : ==> Preparing: INSERT INTO user (id, name, provider_id) VALUES (?, ?, 1)
2018-11-29 21:07:14.577 DEBUG 18688 --- [      main] c.w.m.mapper.UserMapper.insert      : ==> Parameters: 1068129257418178562(Long), 新来的Tom老师(String)
2018-11-29 21:07:14.577 DEBUG 18688 --- [      main] c.w.m.mapper.UserMapper.insert      : <==  Updates: 1
 Time:0 ms - ID:com.wuwenze.mybatisplusmultitenancy.mapper.UserMapper.insert
Execute SQL:INSERT INTO user (id, name, provider_id) VALUES (?, ?, 1) {1: 1068129257418178562, 2: STRINGDECODE('\u65b0\u6765\u7684Tom\u8001\u5e08')}

2018-11-29 21:07:14.585 DEBUG 18688 --- [      main] c.w.m.mapper.UserMapper.selectById    : ==> Preparing: SELECT id, provider_id, name FROM user WHERE user.provider_id = 1 AND id = ?
2018-11-29 21:07:14.595 DEBUG 18688 --- [      main] c.w.m.mapper.UserMapper.selectById    : ==> Parameters: 1068129257418178562(Long)
2018-11-29 21:07:14.614 DEBUG 18688 --- [      main] c.w.m.mapper.UserMapper.selectById    : <==   Total: 1
2018-11-29 21:07:14.615 INFO 18688 --- [      main] .MybatisPlusMultiTenancyApplicationTests : #insert user=User(id=1068129257418178562, providerId=1, name=新来的Tom老师)
 Time:19 ms - ID:com.wuwenze.mybatisplusmultitenancy.mapper.UserMapper.selectById
Execute SQL:SELECT id, provider_id, name FROM user WHERE user.provider_id = 1 AND id = ? {1: 1068129257418178562}

2018-11-29 21:07:14.626 DEBUG 18688 --- [      main] c.w.m.mapper.UserMapper.selectList    : ==> Preparing: SELECT id, provider_id, name FROM user WHERE user.provider_id = 1
 Time:0 ms - ID:com.wuwenze.mybatisplusmultitenancy.mapper.UserMapper.selectList
Execute SQL:SELECT id, provider_id, name FROM user WHERE user.provider_id = 1

2018-11-29 21:07:14.629 DEBUG 18688 --- [      main] c.w.m.mapper.UserMapper.selectList    : ==> Parameters:
2018-11-29 21:07:14.630 DEBUG 18688 --- [      main] c.w.m.mapper.UserMapper.selectList    : <==   Total: 3
2018-11-29 21:07:14.632 INFO 18688 --- [      main] .MybatisPlusMultiTenancyApplicationTests : #selectList, e=User(id=1, providerId=1, name=Tony老师)
2018-11-29 21:07:14.632 INFO 18688 --- [      main] .MybatisPlusMultiTenancyApplicationTests : #selectList, e=User(id=2, providerId=1, name=William老师)
2018-11-29 21:07:14.632 INFO 18688 --- [      main] .MybatisPlusMultiTenancyApplicationTests : #selectList, e=User(id=1068129257418178562, providerId=1, name=新来的Tom老师)

从打印的日志不难看出,这个方案相当完美,仅需简单的配置,让开发者完全忽略了(provider_id)字段的存在,同时又最大程度的保证了数据的安全性,可谓是一举两得!

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

(0)

相关推荐

  • Mybatis-Plus 多表联查分页的实现代码

    上一节,简单讲述了 Mybatis-Plus 搭建与使用入门,这一节,简单讲一下如何使用 MP 实现多表分页. 分析 使用的工程,依旧是 spring-boot,关于分页,官网给出了一个单表的demo,其实多表分页实现原理相同,都是通过 mybatis 的拦截器 (拦截器做了什么?他会在你的 sql 执行之前,为你做一些事情,例如分页,我们使用了 MP 不用关心 limit,拦截器为我们拼接.我们也不用关心总条数,拦截器获取到我们 sql 后,拼接 select count(*) 为我们查询总条

  • Servlet+MyBatis项目转Spring Cloud微服务,多数据源配置修改建议

    一.项目需求 在开发过程中,由于技术的不断迭代,为了提高开发效率,需要对原有项目的架构做出相应的调整. 二.存在的问题 为了不影响项目进度,架构调整初期只是把项目做了简单的maven管理,引入springboot并未做spring cloud微服务处理.但随着项目的进一步开发,急需拆分现有业务,做微服务处理.因此架构上的短板日益突出.spring cloud config 无法完全应用,每次项目部署需要修改大量配置文件.严重影响开发效率,因此便萌生了对项目架构再次调整的决心. 三.调整建议 为了

  • MyBatis插入数据返回主键的介绍

    Service层: public int addUser(UserDomian user){ int i = userMapper.insert(user); } xml: <insert id="insert" parameterType="....UserDomain"> insert into t_user(user_name,password) values (#{userName},#{password}) </insert> 这样

  • Mybatis-Plus 搭建与使用入门(小结)

    Mybatis-Plus(简称MP)是一个 Mybatis 的增强工具,在 Mybatis 的基础上只做增强不做改变,为简化开发.提高效率而生. 中文文档 :http://baomidou.oschina.io/mybatis-plus-doc/#/ 本文介绍包括 1)如何搭建 2)代码生成(controller.service.mapper.xml) 3)单表的CRUD.条件查询.分页 基类已经为你做好了 一.如何搭建 1. 首先我们创建一个 springboot 工程 --> https:/

  • MyBatis-Plus通过插件将数据库表生成Entiry,Mapper.xml,Mapper.class的方式

    创建maven项目,修改pom.xml文件,如下: <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://mave

  • 基于Mybatis plus 自动代码生成器的实现代码

    1.使用的是maven项目,添加依赖 <!-- mybatis-plus begin --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus</artifactId> <version>2.2.0</version> </dependency> 还有数据库的连接 <dependency> <

  • Mybatis分页插件使用方法详解

    本文实例为大家分享了Mybatis分页插件使用的具体代码,供大家参考,具体内容如下 1.分页插件简介 pagehelper源码 都说这是史上最好用的分页插件,支持多种数据库以多种方式分页. 2.分页插件的使用 2.1导入maven依赖 <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> <version>最新

  • Mybatis批量更新三种方式的实现

    Mybatis实现批量更新操作 方式一: <update id="updateBatch" parameterType="java.util.List"> <foreach collection="list" item="item" index="index" open="" close="" separator=";">

  • spring boot整合mybatis+mybatis-plus的示例代码

    Spring boot对于我来说是一个刚接触的新东西,学习过程中,发现这东西还是很容易上手的,Spring boot没配置时会默认使用Spring data jpa,这东西可以说一个极简洁的工具,可是我还是比较喜欢用mybatis,工具是没有最好的,只有这合适自己的. 说到mybatis,最近有一个很好用的工具--------mybatis-Plus(官网),现在更新的版本是2.1.2,这里使用的也是这个版本.我比较喜欢的功能是代码生成器,条件构造器,这样就可以更容易的去开发了. mybatis

  • mybatis关系映射之一对多和多对一

    本实例使用用户和订单的例子做说明: 一个用户可以有多个订单, 一个订单只对应一个用户.(其中应用到注释) 1.代码的结构 2. 建表语句: CREATE DATABASE test; USE test; CREATE TABLE person( personId VARCHAR(36) PRIMARY KEY, personName VARCHAR(64), personAddress VARCHAR(128), personTel VARCHAR(11) ); CREATE TABLE ord

随机推荐

其他