MybatisPlus的多租戶插件使用!


本文代碼樣例均已上傳至Gitee:https://gitee.com/tqbx/springboot-samples-learn/tree/master/spring-boot-mybatis-plus-primer

核心插件: TenantLineInnerInterceptor

核心處理器:TenantLineHandler

public interface TenantLineHandler {

    /**
     * 獲取租戶 ID 值表達式,只支持單個 ID 值
     * <p>
     *
     * @return 租戶 ID 值表達式
     */
    Expression getTenantId();

    /**
     * 獲取租戶字段名
     * <p>
     * 默認字段名叫: tenant_id
     *
     * @return 租戶字段名
     */
    default String getTenantIdColumn() {
        return "tenant_id";
    }

    /**
     * 根據表名判斷是否忽略拼接多租戶條件
     * <p>
     * 默認都要進行解析並拼接多租戶條件
     *
     * @param tableName 表名
     * @return 是否忽略, true:表示忽略,false:需要解析並拼接多租戶條件
     */
    default boolean ignoreTable(String tableName) {
        return false;
    }
}

說明:

多租戶 != 權限過濾,不要亂用,租戶之間是完全隔離的!!!
啟用多租戶后所有執行的method的sql都會進行處理.
自寫的sql請按規范書寫(sql涉及到多個表的每個表都要給別名,特別是 inner join 的要寫標准的 inner join)

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    // 如果用了分頁插件注意先 add TenantLineInnerInterceptor 再 add PaginationInnerInterceptor
    // 用了分頁插件必須設置 MybatisConfiguration#useDeprecatedExecutor = false
    //        interceptor.addInnerInterceptor(new PaginationInnerInterceptor());

    interceptor.addInnerInterceptor(new TenantLineInnerInterceptor(
        new TenantLineHandler() {
            // manager_id = 1088248166370832385

            // 獲取租戶 ID 值表達式,只支持單個 ID 值
            @Override
            public Expression getTenantId() {
                return new LongValue(1088248166370832385L);
            }
            // 這是 default 方法,默認返回 false 表示所有表都需要拼多租戶條件,
            // 這里設置 role表不需要該條件
            @Override
            public boolean ignoreTable(String tableName) {
                if ("role".equals(tableName)) {
                    return true;
                }
                return false;
            }

            @Override
            public String getTenantIdColumn() {
                return "manager_id";
            }
        }));
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
    return interceptor;
}

@Bean
public ConfigurationCustomizer configurationCustomizer() {
    return configuration -> configuration.setUseDeprecatedExecutor(false);
}

測試

@RunWith(SpringRunner.class)
@SpringBootTest
class TenantTest {

    @Resource
    UserMapper userMapper;

    @Test
    void select(){
        // manager_id = 1088248166370832385
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM