mybatis-plus: 多租户隔离机制

一、TenantLineHandler

1、介绍

TenantLineHandler 是 Mybatis-Plus 中用于处理多租户的接口，用于实现多租户数据隔离的具体逻辑。通过实现这个接口，我们可以自定义多租户的处理方式，例如根据不同的租户信息动态拼装 SQL 条件，实现数据的隔离。

2、包含的方法

在 Mybatis-Plus 中，TenantLineHandler 接口包含了以下方法：

• getTenantIdColumn()：获取租户 ID 字段名。
• getTenantId()：获取当前租户 ID。
• getTenantIdValue()：获取租户 ID 的具体数值。
• getTenantIdList()：获取租户 ID 列表。
• getTenantIdExpression()：获取租户 ID 的 SQL 表达式。
  通过实现 TenantLineHandler 接口，并重写以上方法，我们可以根据具体的业务需求来自定义多租户的处理逻辑。例如，可以根据不同的租户 ID 动态拼装 SQL 条件，实现数据的隔离查询。

二、简单实例

面是一个简单示例，展示了如何自定义一个 TenantLineHandler 的实现类：

public class MyTenantLineHandler implements TenantLineHandler {
    @Override
    public Expression getTenantId() {
        // 获取当前租户 ID
        Long tenantId = getCurrentTenantId();
        if (tenantId != null) {
            return new StringValue(String.valueOf(tenantId));
        } else {
            return null;
        }
    }

    @Override
    public String getTenantIdColumn() {
        // 返回租户 ID 字段名
        return "tenant_id";
    }

    // 自定义方法，获取当前的租户 ID
    private Long getCurrentTenantId() {
        // 这里可以根据实际情况获取当前的租户 ID，可以从 ThreadLocal、token、session 等地方获取
        // 这里只是一个示例，实际中需要根据具体的业务逻辑进行实现
        return 1L;
    }
}

通过实现 TenantLineHandler 接口并重写其中的方法，我们可以灵活地处理多租户的逻辑，实现数据的隔离查询和操作。

三、实践

1、实现TenantLineHandler接口

import com.alibaba.nacos.common.utils.CollectionUtils;
import com.baomidou.mybatisplus.extension.plugins.handler.TenantLineHandler;
import com.xxx.ContextHolder;
import com.xxx.TenantConfig;
import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.expression.LongValue;
import net.sf.jsqlparser.schema.Column;
import org.apache.commons.lang3.StringUtils;
import java.util.Objects;

import java.util.List;
import java.util.Optional;

public class MultiTenantHandler implements TenantLineHandler{

    private final Config config;

    public MultiTenantHandler(Config config) {
        this.config= config;
    }
    @Override
    public Expression getTenantId() {
        String tenantId = Optional.ofNullable(ContextHolder.getTenantId()).orElse("1");
        return new LongValue(tenantId);
    }

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

    @Override
    public boolean ignoreTable(String tableName) {
		// 其他处理逻辑
        return TenantLineHandler.super.ignoreTable(tableName);
    }

    @Override
    public boolean ignoreInsert(List<Column> columns, String tenantIdColumn) {
        return TenantLineHandler.super.ignoreInsert(columns, tenantIdColumn);
    }
}

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import java.util.List;
@Configuration
@ConfigurationProperties(prefix = "tenant")
@Data
public class Config {
    /**
     * 是否开启多租户
     */
    private Boolean enable = true;

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

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

    /**
     * 忽略指定用户对租户的数据过滤
     */
    private List<String> ignoreLoginNames;

    /**
     * 忽略某租户对数据的过滤
     */
    private String ignoreTenantId;

}