mybatis-plus多租户处理器使用及避坑

一、介绍

MybaitsPlus多租户处理器是一个对于多租户问题的解决方案，主要的方案就是使用jSqlParser对sql进行解析，然后拼接租户id来实现多个租户之间的隔离，并且在删除、添加、修改和查询等操作时都会拼接租户ID

如：

SELECT * FROM info

处理后：

SELECT * FROM info WHERE tenant_id = 'tenant_id'

二、使用

以下复制的官方的demo，官方demo地址：https://gitee.com/baomidou/mybatis-plus-samples/tree/master/mybatis-plus-sample-tenant

package com.baomidou.mybatisplus.samples.tenant.config;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.baomidou.mybatisplus.autoconfigure.ConfigurationCustomizer;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.handler.TenantLineHandler;
import com.baomidou.mybatisplus.extension.plugins.inner.TenantLineInnerInterceptor;

import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.expression.LongValue;

/**
 * @author miemie
 * @since 2018-08-10
 */
@Configuration
@MapperScan("com.baomidou.mybatisplus.samples.tenant.mapper")
public class MybatisPlusConfig {

    /**
     * 新多租户插件配置,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存万一出现问题
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new TenantLineInnerInterceptor(new TenantLineHandler() {
            @Override
            public Expression getTenantId() {
                return new LongValue(1);
            }

            // 这是 default 方法,默认返回 false 表示所有表都需要拼多租户条件
            @Override
            public boolean ignoreTable(String tableName) {
                return !"user".equalsIgnoreCase(tableName);
            }
        }));
        // 如果用了分页插件注意先 add TenantLineInnerInterceptor 再 add PaginationInnerInterceptor
        // 用了分页插件必须设置 MybatisConfiguration#useDeprecatedExecutor = false
//        interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        return interceptor;
    }

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

是不是小伙伴们感觉仅仅是关键的一个配置文件就可以搞定了，用多租户处理器之后就再也不用自己手动进行租户ID的拼接了，那接下来跟大家说一下避坑的地方。

三、避坑

1、语法

在介绍中跟各位小伙伴们说了mybatis-plus使用的是jsqlparser来实现的，mybatis-plus使用jsqlparser来对语法进行解析并且使用jsqlparser来进行拼接租户id的。

然而jsqlparser是对于sql的规范来进行解析的，如果出现一些特别的语法。

如示例：

SELECT CAST('1' as SIGNED) 

经常用mysql的小伙伴们应该很熟悉这是一个字符串转换成数字的，而这种的jsqlparser就会报sql语法解析的一些错误，所以希望大家使用别的方法来替代如：

SELECT CONVERT('1', SIGNED)

2、表名问题

在使用多租户处理器的时候往往很多表是不需要进行租户id判断的，这里作者的处理方式是将不需要租户id判断的表放到配置文件中，并且使用以下进行判断。

    @Value("${system.tenant.not-tenant-tables:null}")
    private TreeSet notTenantIdTable;

    @Override
    public boolean doTableFilter(String tableName) {
        return notTenantIdTable.contains(tableName.toLowerCase());
    }

这里看上去没啥问题，但是需要注意表名的大小写，以及``这种转义符号

3、insert sql问题

作者在使用多租户处理器的时候是在项目后期阶段，这时候大部分业务代码已经写完了，插入sql都是自己手动获取并且插入的，但是mybatis-plus的多租户处理器已经想到这个问题了，启用多租户处理器的时候就会自动插入租户ID，你自己插入了租户ID，多租户处理器也给你插入了租户ID就会出现以下sql：

INSERT INTO info(id, tenant_id, tenant_id) VALUES(1, 'tenant_id', 'tenant_id')

这时候mysql就会毫不留情的报错，解决这个的办法其实也很简单，不插入租户ID了呗，当然也可以用以下办法解决

1、继承TenantSqlParser

/**
 * 多租户sql解析器扩展
 * @author weicong
 * @version 1.0 createTime 2021-2-22 20:05:58
 */
public class TenantSqlParserExt extends TenantSqlParser {

    /**
     * 是否处理插入的sql
     */
    private boolean isHandlerInsert = true;

    /**
     * 是否处理查询的sql
     */
    private boolean isHandlerSelect = true;

    @Override
    public void processInsert(Insert insert) {
        if(isHandlerInsert){
            int index = findTenantIdColumnIndex(insert.getColumns());
            //若不存在租户ID则进行添加租户ID信息
            if(-1 == index){
                super.processInsert(insert);
            }
        }
    }

    /**
     * 获取Column集合中租户ID的位置，若没有返回-1
     * @param columns
     * @return
     */
    public int findTenantIdColumnIndex(List columns){
        Column column;
        for(int i = 0; i < columns.size(); i++){
            column = columns.get(i);
            if(Global.TENANT_ID_COLUMN.equals(column.getColumnName())){
                return i;
            }
        }
        return -1;
    }

    @Override
    public void processSelectBody(SelectBody selectBody) {
        if(isHandlerSelect){
            super.processSelectBody(selectBody);
        }
    }

    public boolean isHandlerInsert() {
        return isHandlerInsert;
    }

    public void setHandlerInsert(boolean handlerInsert) {
        isHandlerInsert = handlerInsert;
    }

    public boolean isHandlerSelect() {
        return isHandlerSelect;
    }

    public void setHandlerSelect(boolean handlerSelect) {
        isHandlerSelect = handlerSelect;
    }
}

2、配置TenantSqlParser

/**
     * 初始化多租户处理器
     * @param paginationInterceptor
     */
    public void initTenantHandler(PaginationInterceptor paginationInterceptor){
        ArrayList sqlParsers = new ArrayList<>();
        TenantSqlParser tenantSqlParser = new TenantSqlParserExt();
        tenantSqlParser.setTenantHandler(new TenantHandler() {
            @Override
            public Expression getTenantId(boolean where) {
                return new LongValue(LoginUserUtils.getTenantId());
            }

            @Override
            public String getTenantIdColumn() {
                return Global.TENANT_ID_COLUMN;
            }

            @Override
            public boolean doTableFilter(String tableName) {
                tableName = clearSymbol(tableName);
                boolean is = tenantProperties.getNotTenantIdTable().contains(tableName.toLowerCase());
                return is;
            }
        });
        sqlParsers.add(tenantSqlParser);
        paginationInterceptor.setSqlParserList(sqlParsers);
    }

四、总结

本文已经介绍了介绍了mybaits-plus多租户处理器的使用以及避坑指南，作者已经整理了完整demo来提供大家参考，如果有问题请大家评论或进入Q群415777345找作者。本文纯手写。

gitee：https://gitee.com/nightowl7/mybatis-plus-tenant-demo