MybatisPlus 多租户功能

概念

多租户技术或称多重租赁技术，简称SaaS，是⼀种软件架构技术，是实现如何在多⽤户环境下（此处的多⽤户⼀般是面向企业⽤户）共⽤相同的系统或程序组件，并且可确保各⽤户间数据的隔离性。简单讲：在⼀台服务器上运⾏单个应⽤实例，它为多个租户（客户）提供服务。从定义中我们可以理解：多租户是⼀种架构，⽬的是为了让多⽤户环境下使⽤同⼀套程序，且保证⽤户间数据隔离。
那么重点就很浅显易懂了，多租户的重点就是同⼀套程序下实现多⽤户数据的隔离。

MybatisPlus多租户插件使用

步骤一、添加依赖

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

步骤二、添加配置

1、bootstrap.yml 文件中添加多租户配置

截屏2023-12-21 14.49.08.png

2、新增配置属性类

import java.util.List;

/**
 * @Author: zhanghua
 * @Date: 2023/12/15
 * @Version 1.0
 */
@Data
@ConfigurationProperties(prefix = "tenant")
public class TenantProperties {
    /**
     * 是否开启多租户
     */
    private Boolean enable = true;

    /**
     * 租户id字段名
     */
    private String column = "language_id";

    /**
     * 需要进行租户id过滤的表名集合
     */
    private List<String> filterTables;

    /**
     * 需要忽略的多租户的表，此配置优先filterTables，若此配置为空则启用    filterTables
     */
    private List<String> ignoreTables;

    /**
     * 需要排除租户过滤的登录用户名
     */
    private List<String> ignoreLoginNames;

}

步骤三、多租户处理器实现TenantLineHandler接口

@Slf4j
public class MultiTenantHandler implements TenantLineHandler {
    private final TenantProperties properties;

    public MultiTenantHandler(TenantProperties properties) {
        this.properties = properties;
    }

    /**
     * 获取租户ID值表达式，只支持单个ID值 (实际应该从用户信息中获取)
     *
     * @return 租户ID值表达式
     */
    @Override
    public Expression getTenantId() {

        //实际应该从用户信息中获取
        if(SecurityUtils.getTenantUser()!=null)
        {
            String tenantId = SecurityUtils.getTenantUser().getLanguage_id();
            log.info("tenantId 租户id：" + tenantId);
            ThreadLocalUtil.remove();

            if(tenantId!=null) {
                return new StringValue(tenantId);
            }
        }

        return new StringValue("zh-CN");

    }

    /**
     * 获取租户字段名,默认字段名叫: tenant_id
     *
     * @return 租户字段名
     */
    @Override
    public String getTenantIdColumn() {
        return properties.getColumn();
    }

    /**
     * 根据表名判断是否忽略拼接多租户条件
     *
     * 默认都要进行解析并拼接多租户条件
     *
     * @param tableName 表名
     * @return 是否忽略, true:表示忽略，false:需要解析并拼接多租户条件
     */
    @Override
    public boolean ignoreTable(String tableName) {

        // 忽略指定用户对租户的数据过滤
        List<String> ignoreLoginNames=properties.getIgnoreLoginNames();
        String loginName= SecurityUtils.getTenantUsername();
        if(null!=ignoreLoginNames && ignoreLoginNames.contains(loginName)){
            return true;
        }

        //忽略指定表对租户数据的过滤
        List<String> ignoreTables = properties.getIgnoreTables();
        if (null != ignoreTables && ignoreTables.contains(tableName)) {
            return true;
        }

        return false;
    }
}

租户信息处理工具类

@Slf4j
public class SecurityUtils {

    /**
     * 获取需要排除租户过滤的登录用户名
     **/
    public static String getTenantUsername() {
        //  可以设置一些白名单，大权限用户名称或id

        return "我是超级管理员";
    }

    /**
     * 获取多租户用户信息
     **/
    public static TenantUser getTenantUser() {
        try {

            String language_id = ThreadLocalUtil.get("language_id", "zh-CN");
            log.info("getTenantUser language_id --->" + language_id);
            TenantUser tenantUser = new TenantUser();
            tenantUser.setLanguage_id(language_id);

            return tenantUser;

        } catch (Exception e) {
            e.printStackTrace();
        }

        return null;
    }

}

步骤四、MybatisPlus配置类启用多租户拦截插件

@EnableTransactionManagement(proxyTargetClass = true)
@Configuration
@EnableConfigurationProperties(TenantProperties.class)
public class MybatisPlusConfig {

    /**
     * 如果用了分页插件注意先 add TenantLineInnerInterceptor 再 add PaginationInnerInterceptor
     *
     * @param tenantProperties
     * @return
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor(TenantProperties tenantProperties) {

        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        if (Boolean.TRUE.equals(tenantProperties.getEnable())) {
            // 启用多租户插件拦截
            interceptor.addInnerInterceptor(new TenantLineInnerInterceptor(new MultiTenantHandler(tenantProperties)));
        }

        // 分页插件
        // interceptor.addInnerInterceptor(paginationInnerInterceptor());
        // 乐观锁插件
        // interceptor.addInnerInterceptor(optimisticLockerInnerInterceptor());
        // 阻断插件
        // interceptor.addInnerInterceptor(blockAttackInnerInterceptor());

        return interceptor;
    }

    @Bean
    public PaginationInnerInterceptor paginationInnerInterceptor() {
        return new PaginationInnerInterceptor();
    }
}

特定SQL语句忽略拦截

在一些场景下，无需多租户拦截，或者对于一些超级管理员使用的接口，希望跨租户查询、免数据鉴权时，可以通过下面几种方式实现忽略拦截：

• 使用MybatisPlus框架自带的@InterceptorIgnore注解，以用在Mapper类上，也可以用在方法上

• 添加超级用户账号白名单，在自定义的Handler里进行逻辑判断，跳过拦截

• 添加数据表白名单，在自定义的Handler里进行逻辑判断，跳过拦截

例如

@InterceptorIgnore(tenantLine = "true")
public interface CourseApprovalsMapper extends     BaseMapper<CourseApprovalsPO> {

}


public interface SeriesCoursesMapper extends BaseMapper<SeriesCoursesPO> {
    @InterceptorIgnore(tenantLine = "true")
    SeriesCoursesPO getBySeriesId(@Param("reqLecturer") Long id);

}

注意

多租户 != 权限过滤,不要乱用,租户之间是完全隔离的!!!
启用多租户后所有执行的method的sql都会进行处理.
自写的sql请按规范书写(sql涉及到多个表的每个表都要给别名,特别是 inner join 的要写标准的 inner join)

官网
参考文章

---

文章持续更新中、希望对各位有所帮助、有问题可留言 大家共同学习 !