多租户逻辑分离预发数据与正式数据

多租户逻辑分离预发数据与正式数据

1. 依赖

<dependency>
    <groupId>com.github.rxyor</groupId>
    <artifactId>carp-mybatis-plus-tenant-starter</artifactId>
    <version>1.0.14.6</version>
</dependency>

2. 说明

该功能依赖于Mybatis-Plus、SpringBoot, 如果你的项目非SpringBoot或依附其他orm框架可以不用往下看了。    
同一套应用不同环境部署，数据隔离最好使用不同的数据库。由于我们预发环境和正式环境很多应用使用的是同一套数据库，并不是所有的表都是和用户ID、店铺CODE做关联的（比如测试用户关联的数据，正式环境的用户无法看到），但是比如附近的家选门店（与用户ID等没有关联）如这样的逻辑，预发环境加一条测试家选店，正式环境就可以看到。在不分库的前提下，我们可以用多租户的思想来解决这样的问题。
多租户其实就是我们一套应用，为多个客户（租户）部署。假如作为服务商，这些数据都是部署在我们的平台，假如成千上百的客户购买我们的服务，我们不可能每个客户单独部署一套数据库环境，我们可以在数据库表的加一个tenant_id字段标识，来区分是不同的租户，这样就可以实现不同租户的数据的逻辑隔离。
Mybatis-Plus其实就是利用拦截器，解析SQL，根据配置的表名、租户ID列名、租户ID等参数在要执行的SQL加上了一个查询条件(eg: where tenant_id=1),原理非常简单。

3. 使用

1）引入1中的依赖

多租户插件依赖PaginationInterceptor， 依赖已经自动配置，请勿在注入PaginationInterceptor

2）配置

I) springboot配置

carp:
  mybatis-plus:
    tenant:
      enable: true
      #数据库租户ID列名
      tenant-id-column: env_id
      #使用多租户的表名
      tables:
        - store
      tenant-ids:
        - 1

II) 表结构

CREATE TABLE `store` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',
  `code` varchar(20) NOT NULL COMMENT '店铺编号',
  `name` varchar(50) NOT NULL COMMENT '名称',
  `address` varchar(500) NOT NULL COMMENT '具体地址信息',
  `contact_phone` varchar(15) NOT NULL COMMENT '手机号',
  `create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `update_time` datetime DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  `env_id` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '环境ID',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uniq_store` (`code`) COMMENT '编号索引'
) ENGINE=InnoDB AUTO_INCREMENT=8 DEFAULT CHARSET=utf8mb4 COMMENT='维修店铺';

III) 测试数据

IV) 测试用例

case1:

@Test
public void testList() {
    List<StoreDO> list = storeDAO.list();
    System.out.println(list);
}

result1:

我们看到执行结果只有一条数据，并且SQL被自动加上了_**WHERE store.env_id = 1 **_
**
case2:

@Test
public void testSave() {
    StoreDO storeDO = new StoreDO();
    storeDO.setCode("FF00003");
    storeDO.setName("家选养车预发测试店");
    storeDO.setAddress("杭州市余杭区五常大道");
    storeDO.setContactPhone("15988128888");
    storeDAO.save(storeDO);
}

result2:


我们save方法中对env_id并没有显式赋值，拦截器自动赋的值。