mybatis-plus进行多租户化

向猪羊
949 阅读6分钟

一、SaaS多租户简介

1.什么是SaaS多租户技术

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

2.什么是SaaS多租户

  • SaaS，是Software-as-a-Service的缩写名称，意思为软件即服务，即通过网络提供软件服务。
  • SaaS平台供应商将应用软件统一部署在自己的服务器上，客户可以根据工作实际需求，通过互联网向厂商定购所需的应用软件服务，按定购的服务多少和时间长短向厂商支付费用，并通过互联网获得Saas平台供应商提供的服务。
  • SaaS服务通常基于一套标准软件系统为成百上千的不同客户(又称为租户)提供服务。这要求SaaS服务能够支持不同租户之间数据和配置的隔离，从而保证每个租户数据的安全与隐私，以及用户对诸如界面、业务逻辑、数据结构等的个性化需求。由于SaaS同时支持多个租户，每个租户又有很多用户，这对支撑软件的基础设施平台的性能、稳定性和扩展性提出很大挑战。

3.SaaS多租户的优势

  • 开发和运维成本低
  • 按需付费，节约成本
  • 即租即用，软件版本更新快
  • 故障排查更及时
  • 大数据和AI的能力支持更强大

二、SaaS多租户的数据隔离设计方案

1.方案

图片.png 大部分公司都采用方案三：按租户id字段隔离租户 架构设计实现多租户数据隔离。这种方案服务器成本最低，但提高了开发成本。

2.MyBatis-Plus多租户插件实现数据隔离

如果希望以最少的服务器为最多的租户提供服务，并且租户接受以牺牲隔离级别换取降低成本。可以采用方案三，即共享数据库，共享数据架构，因为这种方案服务器成本最低，但是提高了开发成本。

所以MybatisPlus提供了一种多租户的解决方案，实现方式是基于多租户插件TenantLineInnerInterceptor进行实现。

在 MyBatis Plus 中，采用“共享数据库，共享数据架构”方式实现多租户。

前往mybati-plus官网文档：baomidou.com/pages/aef2f…

三、实现

1.引入maven

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

3.2.0版本不可以

2.配置文件中添加多租户配置、新增配置类

tenant:
  enable: true #开启saas化
  enable: false #关闭saas化
  column: tenant_id
  filterTables:
  ignoreTables:
    - idaas_org
    - idaas_org_user_rel
    - idaas_use
  ignoreLoginNames:

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.List;

/**
 * 多租户配置属性类*
 */
@Data
@ConfigurationProperties(prefix = "tenant")
public class TenantProperties {
    /**
     * 是否开启多租户
     */
    private Boolean enable = true;

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

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

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

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

3.实现TenantLineHandler接口

import com.ido85.contractormanage.common.config.TenantProperties;
import com.baomidou.mybatisplus.extension.plugins.handler.TenantLineHandler;
import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.expression.LongValue;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

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

/**
 *  多租户处理器实现TenantLineHandler接口*
 */
public class MultiTenantHandler implements TenantLineHandler {

    private final TenantProperties properties;

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

    /**
     * 获取租户ID值表达式，只支持单个ID值 (实际应该从用户信息中获取)
     * 此处是从请求头中获取的
     *
     * @return 租户ID值表达式
     */
    @Override
    public Expression getTenantId() {
        RequestAttributes requestAttributes = RequestContextHolder.currentRequestAttributes();
        HttpServletRequest request = ((ServletRequestAttributes)requestAttributes).getRequest();
        String header = request.getHeader("Tenant-Id");

        //实际应该从用户信息中获取
        if(header != null)
        {
            return new LongValue(header);
        }

        return new LongValue(0);

    }

    /**
     * 获取租户字段名,默认字段名叫: 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=getTenantUsername();
        if(null!=ignoreLoginNames && ignoreLoginNames.contains(loginName)){
            return true;
        }*/

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

        /*List<String> filterTables = properties.getFilterTables();
        if (null != filterTables && !filterTables.contains(tableName)) {
            return true;
        }*/

        return false;
    }

4.MybatisPlus配置类启用多租户拦截插件

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.BlockAttackInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.TenantLineInnerInterceptor;
import com.ido85.contractormanage.common.handler.MultiTenantHandler;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

/**
 * Mybatis Plus 配置*
 */
@EnableTransactionManagement(proxyTargetClass = true)
@Configuration
@EnableConfigurationProperties(TenantProperties.class)
public class MybatisPlusConfig {

    // 分页插件
    @Bean
    public PaginationInnerInterceptor paginationInterceptor() {
        return  new PaginationInnerInterceptor();
    }

    @Bean
    public BlockAttackInnerInterceptor blockAttackInnerInterceptor(){
        return new BlockAttackInnerInterceptor();
    }

    @Bean
    public OptimisticLockerInnerInterceptor optimisticLockerInnerInterceptor(){
        return new OptimisticLockerInnerInterceptor();
    }



    /**
     * 如果用了分页插件注意先 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(paginationInterceptor());
        // 乐观锁插件
        interceptor.addInnerInterceptor(optimisticLockerInnerInterceptor());
        // 阻断插件
        interceptor.addInnerInterceptor(blockAttackInnerInterceptor());

        return interceptor;
    }

}

5.测试

CREATE TABLE `org`  (
  `id` bigint UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `org_name` varchar(300) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '部门名称',
  `org_address` varchar(300) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '部门地址',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1 CHARACTER SET = utf8 COLLATE = utf8_general_ci COMMENT = '部门表' ROW_FORMAT = Dynamic;
 

CREATE TABLE `role`  (
  `id` bigint UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `tenant_id` bigint NULL DEFAULT NULL COMMENT '租户id',
  `role_name` varchar(300) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '角色名称',
  `role_code` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '角色编码',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1 CHARACTER SET = utf8 COLLATE = utf8_general_ci COMMENT = '角色表' ROW_FORMAT = Dynamic;
 
CREATE TABLE `user`  (
  `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `tenant_id` bigint NOT NULL COMMENT '租户id',
  `org_id` bigint NOT NULL COMMENT '部门id',
  `role_id` bigint NOT NULL COMMENT '角色id',
  `name` varchar(300) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '姓名',
  `age` int unsigned NOT NULL DEFAULT '0' COMMENT '年龄',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1 CHARACTER SET = utf8 COLLATE = utf8_general_ci COMMENT = '用户表' ROW_FORMAT = Dynamic;
 
SET FOREIGN_KEY_CHECKS = 1;

联表查询处理前：

SELECT
	u.tenant_id,
	u.org_id,
	org.org_name,
	org.org_address,
	u.role_id,
	role.role_name,
	role.role_code,
	.id AS user_id,
	u.NAME AS user_name,
	u.age AS user_age 
FROM
	USER u
	LEFT JOIN org AS org ON u.org_id = org.id
	LEFT JOIN role AS role ON u.role_id = role.id 
WHERE
	u.id = ?

处理后：

SELECT
	u.tenant_id,
	u.org_id,
	org.org_name,
	org.org_address,
	u.role_id,
	role.role_name,
	role.role_code,
	.id AS user_id,
	u.NAME AS user_name,
	u.age AS user_age 
FROM
	USER u
	LEFT JOIN org AS org ON u.org_id = org.id
	LEFT JOIN role AS role ON u.role_id = role.id 
	AND role.tenant_id = 1 
WHERE
	u.id = ? 
	AND u.tenant_id = 1

6.定时任务不需要组装的处理

在MultiTenantHandler类的ignoreTable()方法中增加

//定时任务没有应用上下文，借助应用上下文跳过对定时任务相关处理的封装
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
if(attributes == null){
    return true;
}
avatar
文章
阅读
粉丝