MyBatis Plus 多租户支持_getcurrenttenantid

        随着云计算和微服务架构的发展，多租户系统逐渐成为企业开发中的常见需求。多租户系统指的是在同一个软件实例中为多个租户提供服务，并且这些租户之间的数据需要进行隔离。MyBatis Plus为多租户场景提供了支持，通过合理配置和扩展，可以实现数据隔离和多租户访问控制。

一、多租户支持概述

在多租户系统中，不同的租户共享同一套软件实例，但其数据需要进行有效隔离，确保租户之间互不影响。MyBatis Plus通过提供多租户支持，使得在进行数据库操作时可以轻松实现数据隔离和多租户访问控制。

二、多租户支持的关键配置

1.租户ID注入

MyBatis Plus提供了TenantLineHandler接口，通过实现该接口来动态注入租户ID。

import com.baomidou.mybatisplus.extension.plugins.handler.TenantLineHandler;
import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.expression.StringValue;
 
public class MyTenantLineHandler implements TenantLineHandler {
 
     @Override
     public Expression getTenantId() {
        // 从当前租户上下文中获取租户ID
        String tenantId = MyTenantContext.getCurrentTenantId();
        return new StringValue(tenantId);
    }
 
    @Override
    public String getTenantIdColumn() {
        // 返回租户ID对应的数据库列名
        return "tenant_id";
    }
 
    @Override
    public boolean ignoreTable(String tableName) {
       // 可以配置忽略的表，不进行租户过滤
       return false;
    }
}

2.配置多租户拦截器 

通过配置MyBatis Plus的多租户拦截器，将租户ID注入到SQL语句中。在 mybatis-config.xml中配3置如下：

<configuration>
    <interceptor>
        <property name="tenantLineHandler" value="com.example.MyTenantLineHandler"/>
        <property name="tenantLineHandler" value="com.example.MyTenantLineHandler"/>
        <property name="tenantLineHandler" value="com.example.MyTenantLineHandler"/>
        <property name="tenantLineHandler" value="com.example.MyTenantLineHandler"/>
        <!-- 其他配置 -->
    </interceptor>
</configuration>

3.租户上下文

为了在系统运行时获取当前租户ID，需要实现一个租户上下文工具类。这个工具类的设计可以根据具体业务场景进行定制。

public class MyTenantContext {
 
     private static final ThreadLocal<String> currentTenantId = new ThreadLocal<>();
 
     public static void setCurrentTenantId(String tenantId) {
        currentTenantId.set(tenantId);
     }
 
     public static String getCurrentTenantId() {
        return currentTenantId.get();
    }
 
    public static void clear() {
        currentTenantId.remove();
    }
}

 4.租户解析器

在多租户系统中，需要通过请求或用户身份验证等方式获取当前租户ID。为了实现这一过程，可以设计一个租户解析器接口，然后根据具体情况实现不同的租户解析器。

public interface TenantResolver {
 
    String resolveTenantId();
}

三、多租户实现步骤

在了解了关键配置后，我们可以通过以下步骤来实现MyBatis Plus的多租户支持：

1.实现租户解析器

根据具体业务场景实现租户解析器，例如从请求中解析出租户ID。

public class HttpRequestTenantResolver implements TenantResolver {
 
     @Override
     public String resolveTenantId() {
         //从请求中获取租户ID
         HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
         return request.getHeader("X-Tenant-Id");
    }
}

2.设置租户解析器

在系统启动时，将租户解析器设置到租户上下文中。

@Configuration
public class TenantConfig {
 
     @Bean
     public TenantResolver tenantResolver() {
         return new HttpRequestTenantResolver();
     }
 
     @Bean
    public MyTenantLineHandler myTenantLineHandler(TenantResolver tenantResolver) {
        return new MyTenantLineHandler(tenantResolver);
    }
}

3.配置多租户拦截器

在mybatis-config.xml中配置多租户拦截器。 

<configuration>
    <interceptor>
        <property name="tenantLineHandler" ref="myTenantLineHandler"/>
        <!-- 其他配置 -->
    </interceptor>
</configuration>

4.使用多租户支持

在进行数据库操作前，通过租户上下文设置当前租户ID。

MyTenantContext.setCurrentTenantId("your-tenant-id");

 四、多租户应用场景

1.多企业系统

       多企业系统是一种服务于多个独立企业的软件架构。每个企业在系统中拥有自己的数据和业务逻辑，企业之间的数据需要进行隔离，以确保企业之间的数据隔离和访问控制，确保安全性和独立性。

2.Saas应用

        SaaS（软件即服务）应用是一种通过互联网提供的软件服务模式，多个客户共享同一套软件实例，但每个客户的数据和配置是相互独立的，保障每个客户的数据隔离和安全性。

3.多品牌系统

       多品牌系统是一种在同一软件实例中服务于多个独立品牌的系统架构。每个品牌在系统中有自己的产品线和业务逻辑，保证品牌之间的数据独立性。

4.多部门系统

       多部门系统是一种服务于一个企业内多个独立部门的软件架构。每个部门在系统中有自己的业务流程和数据管理需求，确保部门之间的数据隔离和访问控制。

五、总结

       MyBatis Plus的多租户支持机制为开发者在多租户系统中提供了强大的支持。通过配置和扩展，可以轻松实现数据隔离和多租户访问控制。在实际应用中，根据具体业务场景，选择合适的租户解析器和配置方式，以满足系统对多租户的需求。多租户支持的应用场景广泛，为企业提供了更灵活的解决方案，适应不同业务场景的需求。