MyBatis-Plus 高級功能 —— 多租戶功能實現

一、引言

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

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

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

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

數據隔離有三種方案：

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

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

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

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

所以MP就提供了一種多租戶的解決方案，實現方式是基於分頁插件進行實現的，具體實現代碼如下：

@Configuration
public class MyBatisPlusConfig {
 
 
    /**
     * 分頁插件
     *
     * @return
     */
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
 
        // 創建SQL解析器集合
        List<ISqlParser> sqlParserList = new ArrayList<>();
 
        // 創建租戶SQL解析器
        TenantSqlParser tenantSqlParser = new TenantSqlParser();
 
        // 設置租戶處理器
        tenantSqlParser.setTenantHandler(new TenantHandler() {
            @Override
            public Expression getTenantId() {
                // 設置當前租戶ID，實際情況你可以從cookie、或者緩存中拿都行
                return new StringValue("jiannan");
            }
 
            @Override
            public String getTenantIdColumn() {
                // 對應數據庫租戶ID的列名
                return "tenant_id";
            }
 
            @Override
            public boolean doTableFilter(String tableName) {
                // 是否需要需要過濾某一張表
              /*  List<String> tableNameList = Arrays.asList("sys_user");
                if (tableNameList.contains(tableName)){
                    return true;
                }*/
                return false;
            }
        });
 
        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);
}

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 = 'jiannan' AND is_delete = '0' AND age = ? 
DEBUG==> Parameters: 18(Integer)
DEBUG<==      Total: 0

三、特定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;
    }
});

方式二：通過租戶注解的形式，目前只能作用於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);
 
}

​# 開啟 SQL 解析緩存注解生效，如果你的MP版本在3.1.1及以上則不需要配置
mybatis-plus:
  global-config:
    sql-parser-cache: true