MyBatis-Plus 進階功能：多租戶功能實作

前言

什麼叫多租戶，什麼場景下使用多租戶？

多租戶是一種軟體架構技術，在多使用者的環境下，共有同一套系統，并且要注意資料之間的隔離性。

舉個實際例子：小編曾經開發過一套H5程式，這套程式應用在不同醫院的APP上，當醫院患者下載下傳醫院APP，并且進入相對應的H5頁面，APP則會把使用者相關資料傳輸到小編這裡。在傳輸的時候需要帶上醫院辨別（租戶ID），以便小編将資料進行隔離。

當不同的租戶使用同一套程式，這裡就需要考慮一個資料隔離的情況。一鍵擷取mybatis相關資料

資料隔離有三種方案：

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

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

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

二、具體實作

這裡采用方案三，即共享資料庫，共享資料架構，因為這種方案伺服器成本最低，但是提高了開發成本。

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

/**
 * @Description: MybatisPlus配置類
 */
@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;
            }
        });      

/**
 * <p>
 * 使用者 Mapper 接口
 * </p>
 */
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