MyBatis-Plus 多租户实现

应用场景

在指定表的所有查询上添加一个过滤条件,如果一个一个添加过去,工作量大,还容易出错,可以使用 MyBatis-Plus 的多租户模式来实现。
#代码实现

添加依赖包

pom.xml 添加依赖

<dependency>
	<groupId>com.baomidou</groupId>
	<artifactId>mybatis-plus-boot-starter</artifactId>
	<version>3.0.7.1</version>
</dependency>

添加多租户配置

package com.jsh.erp.config;

import com.baomidou.mybatisplus.core.parser.ISqlParser;
import com.baomidou.mybatisplus.core.parser.ISqlParserFilter;
import com.baomidou.mybatisplus.core.parser.SqlParserHelper;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor;
import com.baomidou.mybatisplus.extension.plugins.tenant.TenantHandler;
import com.baomidou.mybatisplus.extension.plugins.tenant.TenantSqlParser;
import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.expression.LongValue;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.reflection.MetaObject;
import org.mybatis.spring.mapper.MapperScannerConfigurer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.servlet.http.HttpServletRequest;
import java.util.ArrayList;
import java.util.List;

@Configuration
public class TenantConfig {
    @Bean
    public PaginationInterceptor paginationInterceptor(HttpServletRequest request) {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        List<ISqlParser> sqlParserList = new ArrayList<>();
        TenantSqlParser tenantSqlParser = new TenantSqlParser();
        tenantSqlParser.setTenantHandler(new TenantHandler() {
            @Override
            public Expression getTenantId() {
                //从session中获取租户id
                Object tenantId = request.getSession().getAttribute("tenantId");
                if(tenantId!=null){
                    //多租户模式,租户id从当前用户获取
                    return new LongValue(Long.parseLong(tenantId.toString()));
                } else {
                    //多租户模式,租户id为null
                    return null;
                }
            }

            @Override
            public String getTenantIdColumn() {
                //多租户模式,sql中拼接的字段名称
                return "tenant_id";
            }

            @Override
            public boolean doTableFilter(String tableName) {
                //获取开启状态
                Object mybatisPlusStatus = request.getSession().getAttribute("mybatisPlusStatus");
                if(mybatisPlusStatus !=null && mybatisPlusStatus.toString().equals("open")) {
                    // 这里可以判断是否过滤表,过滤的表不会添加多租户字段条件
                    if ("tbl_sequence".equals(tableName) || "dual".equals(tableName)) {
                        return true;
                    } else {
                        return false;
                    }
                } else {
                    //无租户模式
                    return true;
                }
            }
        });

        sqlParserList.add(tenantSqlParser);
        paginationInterceptor.setSqlParserList(sqlParserList);
        paginationInterceptor.setSqlParserFilter(new ISqlParserFilter() {
            @Override
            public boolean doFilter(MetaObject metaObject) {
                MappedStatement ms = SqlParserHelper.getMappedStatement(metaObject);
                //获取开启状态
                Object mybatisPlusStatus = request.getSession().getAttribute("mybatisPlusStatus");
                if(mybatisPlusStatus !=null && mybatisPlusStatus.toString().equals("open")) {
                    //多租户模式
                    // 过滤自定义查询,此处跳过指定id的查询(不添加加租户过滤条件)
                    if ("com.jsh.erp.datasource.mappers.UserMapperEx.getUserListByUserNameOrLoginName".equals(ms.getId())) {
                        return true;
                    }
                    return false;
                } else {
                    //无租户模式
                    return true;
                }
            }
        });
        return paginationInterceptor;
    }

    /**
     * 相当于顶部的:
     * {@code @MapperScan("com.jsh.erp.datasource.mappers*")}
     * 这里可以扩展,比如使用配置文件来配置扫描Mapper的路径
     */
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer() {
        MapperScannerConfigurer scannerConfigurer = new MapperScannerConfigurer();
        scannerConfigurer.setBasePackage("com.jsh.erp.datasource.mappers*");
        return scannerConfigurer;
    }

}

参数配置

application.properties

#open开启 close关闭
mybatis-plus.status=close
mybatis-plus.mapper-locations=classpath:./mapper_xml/*.xml
#跳过某些方法过滤配置
mybatis-plus.global-config.sql-parser-cache=true

需要跳过的方法配置

    /**
     * 这个查询不添加租户id,保证登录名全局唯一
     * */
    @SqlParser(filter = true)
    List<User> getUserListByUserNameOrLoginName(@Param("userName") String userName,
                                                @Param("loginame") String loginame);

缺陷

多租户模式在 3.0.7.1 版本及更早之前不支持字段为 null 时使用 is null 查询,即要追加到所有查询条件中的字段必须不能为 null(传递的参数)
否则拼接是这样的

where tenant_id = null

我们想要的是

where tenant_id  is null

官方的解释是目前不支持全局设置某个字段为 null 时使用 is null 去填充 where 条件,所以不要拿多租户去作过滤条件使用。