基於Mybatis-plus多租戶實現方案

一、引言

小編先解釋一下什么叫多租戶，什么場景下使用多租戶。

多租戶是一種軟件架構技術，在多用戶的環境下，共有同一套系統，並且要注意數據之間的隔離性。

舉個實際例子：小編曾經開發過一套支付寶程序，這套程序應用在不同的小程序上，當使用者訪問不同，並且進入相對應的小程序頁面，小程序則會把用戶相關數據傳輸到小編這里。在傳輸的時候需要帶上小程序標識（租戶ID），以便小編將數據進行隔離。

當不同的租戶使用同一套程序，這里就需要考慮一個數據隔離的情況。

數據隔離有三種方案：

1、獨立數據庫：簡單來說就是一個租戶使用一個數據庫，這種數據隔離級別最高，安全性最好，但是提高成本。

2、共享數據庫、隔離數據架構：多租戶使用同一個數據褲，但是每個租戶對應一個Schema(數據庫user)。-

3、共享數據庫、共享數據架構：使用同一個數據庫，同一個Schema，但是在表中增加了租戶ID的字段，這種共享數據程度最高，隔離級別最低。

二、具體實現

這里采用方案三，即共享數據庫，共享數據架構，因為這種方案服務器成本最低，但是提高了開發成本。

實現架構邏輯：

Mybatis-plus實現多租戶方案

Mybatis-plus就提供了一種多租戶的解決方案，實現方式是基於分頁插件(攔截器)進行實現的；

第一步：在應用添加維護一張tenant（租戶表），在需要進行隔離的數據表上新增租戶id；

第二步：實現TenantHandler接口並實現它的方法：

public interface TenantHandler { /** * 獲取租戶 ID 值表達式，支持多個 ID 條件查詢 * <p> * 支持自定義表達式，比如：tenant_id in (1,2) @since 2019-8-2 * * @param where 參數 true 表示為 where 條件 false 表示為 insert 或者 select 條件 * @return 租戶 ID 值表達式 */ Expression getTenantId(boolean where); /** * 獲取租戶字段名 * * @return 租戶字段名 */ String getTenantIdColumn(); /** * 根據表名判斷是否進行過濾 * * @param tableName 表名 * @return 是否進行過濾, true:表示忽略，false:需要解析多租戶字段 */ boolean doTableFilter(String tableName); }
PreTenantHandler 實現 TenantHandler

@Slf4j
@Component
public class PreTenantHandler implements TenantHandler { @Autowired private PreTenantConfigProperties configProperties; /** * 租戶Id * * @return */ @Override public Expression getTenantId(boolean where) { //可以通過過濾器從請求中獲取對應租戶id Long tenantId = PreTenantContextHolder.getCurrentTenantId(); log.debug("當前租戶為{}", tenantId); if (tenantId == null) { return new NullValue(); } return new LongValue(tenantId); } /** * 租戶字段名 * * @return */ @Override public String getTenantIdColumn() { return configProperties.getTenantIdColumn(); } /** * 根據表名判斷是否進行過濾 * 忽略掉一些表：如租戶表（sys_tenant）本身不需要執行這樣的處理 * * @param tableName * @return */ @Override public boolean doTableFilter(String tableName) { return configProperties.getIgnoreTenantTables().stream().anyMatch((e) -> e.equalsIgnoreCase(tableName)); } }
第三步：配置mybatisPlus的分頁插件配置

@EnableTransactionManagement
@Configuration
@MapperScan({"com.xd.pre.**.mapper"}) public class MyBatisPlusConfig { @Autowired private PreTenantHandler preTenantHandler; /** * 分頁插件 */ @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都會自動加上租戶ID的標識，測試如下：

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

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過濾 如果在程序中，有部分SQL不需要加上租戶ID的表示，需要過濾特定的sql，可以通過如下兩種方式：

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

paginationInterceptor.setSqlParserFilter(new ISqlParserFilter() { @Override public boolean doFilter(MetaObject metaObject) { MappedStatement ms = SqlParserHelper.getMappedStatement(metaObject); // 對應Mapper、dao中的方法 if("com.example.demo.mapper.UserMapper.selectList".equals(ms.getId())){ return true; } return false; } });
方式二：通過租戶注解 @SqlParser(filter = true) 的形式，目前只能作用於Mapper的方法上：

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