詳解基于Mybatis-plus多租戶實(shí)現(xiàn)方案

更新時(shí)間：2020年04月10日 09:32:08 作者：逐夢(mèng)小生

這篇文章主要介紹了詳解基于Mybatis-plus多租戶實(shí)現(xiàn)方案，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

一、引言

小編先解釋一下什么叫多租戶，什么場(chǎng)景下使用多租戶。

多租戶是一種軟件架構(gòu)技術(shù)，在多用戶的環(huán)境下，共有同一套系統(tǒng)，并且要注意數(shù)據(jù)之間的隔離性。

舉個(gè)實(shí)際例子：小編曾經(jīng)開(kāi)發(fā)過(guò)一套支付寶程序，這套程序應(yīng)用在不同的小程序上，當(dāng)使用者訪問(wèn)不同，并且進(jìn)入相對(duì)應(yīng)的小程序頁(yè)面，小程序則會(huì)把用戶相關(guān)數(shù)據(jù)傳輸?shù)叫【庍@里。在傳輸?shù)臅r(shí)候需要帶上小程序標(biāo)識(shí)（租戶ID），以便小編將數(shù)據(jù)進(jìn)行隔離。

當(dāng)不同的租戶使用同一套程序，這里就需要考慮一個(gè)數(shù)據(jù)隔離的情況。

數(shù)據(jù)隔離有三種方案：

1、獨(dú)立數(shù)據(jù)庫(kù)：簡(jiǎn)單來(lái)說(shuō)就是一個(gè)租戶使用一個(gè)數(shù)據(jù)庫(kù)，這種數(shù)據(jù)隔離級(jí)別最高，安全性最好，但是提高成本。

2、共享數(shù)據(jù)庫(kù)、隔離數(shù)據(jù)架構(gòu)：多租戶使用同一個(gè)數(shù)據(jù)褲，但是每個(gè)租戶對(duì)應(yīng)一個(gè)Schema(數(shù)據(jù)庫(kù)user)。-

3、共享數(shù)據(jù)庫(kù)、共享數(shù)據(jù)架構(gòu)：使用同一個(gè)數(shù)據(jù)庫(kù)，同一個(gè)Schema，但是在表中增加了租戶ID的字段，這種共享數(shù)據(jù)程度最高，隔離級(jí)別最低。

二、具體實(shí)現(xiàn)

這里采用方案三，即共享數(shù)據(jù)庫(kù)，共享數(shù)據(jù)架構(gòu)，因?yàn)檫@種方案服務(wù)器成本最低，但是提高了開(kāi)發(fā)成本。

實(shí)現(xiàn)架構(gòu)邏輯：

Mybatis-plus實(shí)現(xiàn)多租戶方案

Mybatis-plus就提供了一種多租戶的解決方案，實(shí)現(xiàn)方式是基于分頁(yè)插件(攔截器)進(jìn)行實(shí)現(xiàn)的；

第一步：在應(yīng)用添加維護(hù)一張tenant（租戶表），在需要進(jìn)行隔離的數(shù)據(jù)表上新增租戶id；

第二步：實(shí)現(xiàn)TenantHandler接口并實(shí)現(xiàn)它的方法：

public interface TenantHandler {

  /**
   * 獲取租戶 ID 值表達(dá)式，支持多個(gè) ID 條件查詢
   * <p>
   * 支持自定義表達(dá)式，比如：tenant_id in (1,2) @since 2019-8-2
   *
   * @param where 參數(shù) true 表示為 where 條件 false 表示為 insert 或者 select 條件
   * @return 租戶 ID 值表達(dá)式
   */
  Expression getTenantId(boolean where);

  /**
   * 獲取租戶字段名
   *
   * @return 租戶字段名
   */
  String getTenantIdColumn();

  /**
   * 根據(jù)表名判斷是否進(jìn)行過(guò)濾
   *
   * @param tableName 表名
   * @return 是否進(jìn)行過(guò)濾, true:表示忽略，false:需要解析多租戶字段
   */
  boolean doTableFilter(String tableName);
}

PreTenantHandler 實(shí)現(xiàn) TenantHandler

@Slf4j
@Component
public class PreTenantHandler implements TenantHandler {

  @Autowired
  private PreTenantConfigProperties configProperties;

  /**
   * 租戶Id
   *
   * @return
   */
  @Override
  public Expression getTenantId(boolean where) {
    //可以通過(guò)過(guò)濾器從請(qǐng)求中獲取對(duì)應(yīng)租戶id 
    Long tenantId = PreTenantContextHolder.getCurrentTenantId();
    log.debug("當(dāng)前租戶為{}", tenantId);
    if (tenantId == null) {
      return new NullValue();
    }
    return new LongValue(tenantId);
  }
  /**
   * 租戶字段名
   *
   * @return
   */
  @Override
  public String getTenantIdColumn() {
    return configProperties.getTenantIdColumn();
  }

  /**
   * 根據(jù)表名判斷是否進(jìn)行過(guò)濾
   * 忽略掉一些表：如租戶表（sys_tenant）本身不需要執(zhí)行這樣的處理
   *
   * @param tableName
   * @return
   */
  @Override
  public boolean doTableFilter(String tableName) {
    return configProperties.getIgnoreTenantTables().stream().anyMatch((e) -> e.equalsIgnoreCase(tableName));
  }
}

第三步：配置mybatisPlus的分頁(yè)插件配置

@EnableTransactionManagement
@Configuration
@MapperScan({"com.xd.pre.**.mapper"})
public class MyBatisPlusConfig {

  @Autowired
  private PreTenantHandler preTenantHandler;

  /**
   * 分頁(yè)插件
   */
  @Bean
  public PaginationInterceptor paginationInterceptor() {
    PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
    List<ISqlParser> sqlParserList = new ArrayList<>();
    // 攻擊 SQL 阻斷解析器、加入解析鏈
    sqlParserList.add(new BlockAttackSqlParser());
    // 多租戶攔截
    TenantSqlParser tenantSqlParser = new TenantSqlParser();
    tenantSqlParser.setTenantHandler(preTenantHandler);
    sqlParserList.add(tenantSqlParser);
    paginationInterceptor.setSqlParserList(sqlParserList);
    return paginationInterceptor;
  }
}

配置好之后，不管是查詢、新增、修改刪除方法，MP都會(huì)自動(dòng)加上租戶ID的標(biāo)識(shí)，測(cè)試如下：

  @Test
  public void select(){
    List<User> users = userMapper.selectList(Wrappers.<User>lambdaQuery().eq(User::getAge, 18));
    users.forEach(System.out::println);
  }

運(yùn)行sql實(shí)例：

DEBUG==> Preparing: SELECT id, login_name, name, password, 
      email, salt, sex, age, phone, user_type, status,
     organization_id, create_time, update_time, version,
     tenant_id FROM sys_user 
   WHERE sys_user.tenant_id = '001' AND is_delete = '0' AND age = ?

注：特定SQL過(guò)濾如果在程序中，有部分SQL不需要加上租戶ID的表示，需要過(guò)濾特定的sql，可以通過(guò)如下兩種方式：

方式一：在配置分頁(yè)插件中加上配置ISqlParserFilter解析器，如果配置SQL很多，比較麻煩，不建議；

paginationInterceptor.setSqlParserFilter(new ISqlParserFilter() {
      @Override
      public boolean doFilter(MetaObject metaObject) {
        MappedStatement ms = SqlParserHelper.getMappedStatement(metaObject);
        // 對(duì)應(yīng)Mapper、dao中的方法
        if("com.example.demo.mapper.UserMapper.selectList".equals(ms.getId())){
          return true;
        }
        return false;
      }
    });

方式二：通過(guò)租戶注解 @SqlParser(filter = true) 的形式，目前只能作用于Mapper的方法上：

public interface UserMapper extends BaseMapper<User> {
 
  /**
   * 自定Wrapper修改
   *
   * @param userWrapper 條件構(gòu)造器
   * @param user    修改的對(duì)象參數(shù)
   * @return
   */
  @SqlParser(filter = true)
  int updateByMyWrapper(@Param(Constants.WRAPPER) Wrapper<User> userWrapper, @Param("user") User user);
 
}

注：