使用 MyBatis-Plus 实现数据库的多租户管理

在现代 SaaS（软件即服务）应用中，多租户架构是一种常见的设计模式。它允许多个租户共享同一个应用实例，同时确保每个租户的数据相互隔离。MyBatis-Plus 提供了强大的多租户支持，能够帮助开发者轻松实现多租户管理。本文将详细介绍多租户的实现原理、在 MyBatis-Plus 中如何配置多租户、SQL 拦截与动态参数注入，以及多租户系统中的权限与数据隔离。

---

1. 多租户的实现原理

1.1 什么是多租户？

多租户是指在一个应用实例中，多个租户（客户或组织）共享相同的硬件和软件资源，但每个租户的数据和配置是相互隔离的。多租户架构的核心目标是：

• 资源共享：降低硬件和运维成本。
• 数据隔离：确保每个租户的数据安全性和隐私性。

1.2 多租户的实现方式

多租户通常有以下三种实现方式：

（1）独立数据库（Database per Tenant）

• 每个租户拥有独立的数据库。
• 优点：数据隔离性好，性能高。
• 缺点：成本高，维护复杂。

（2）共享数据库，独立 Schema（Schema per Tenant）

• 所有租户共享同一个数据库，但每个租户拥有独立的 Schema。
• 优点：数据隔离性较好，成本较低。
• 缺点：Schema 管理复杂。

（3）共享数据库，共享 Schema（Shared Database, Shared Schema）

• 所有租户共享同一个数据库和 Schema，通过租户 ID 区分数据。
• 优点：成本最低，维护简单。
• 缺点：数据隔离性较差，需要额外的逻辑确保数据安全。

1.3 多租户的核心技术

• 租户标识（Tenant ID）：每个租户有一个唯一的标识，用于区分数据。
• SQL 拦截与动态参数注入：在 SQL 执行时，自动添加租户 ID 作为查询条件。
• 数据隔离与权限控制：确保每个租户只能访问自己的数据。

---

2. 在 MyBatis-Plus 中如何配置多租户

对于**独立数据库（Database Per Tenant）**的多租户实现方式，Mybatis-Plus 本身并没有直接提供开箱即用的支持；通常独立数据库的多租户实现需要动态切换数据源（DataSource）。而 Mybatis-Plus 更专注于 SQL 层面的多租户支持（如共享数据库的多租户过滤）。

2.1 引入依赖

确保项目中已经引入 MyBatis-Plus 的依赖：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>最新版本</version>
</dependency>

2.2 配置多租户拦截器

在 MyBatis-Plus 中，通过 TenantLineInnerInterceptor 实现多租户的 SQL 拦截与动态参数注入。

配置示例：

@Configuration
public class MybatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();

        // 添加多租户拦截器
        TenantLineInnerInterceptor tenantInterceptor = new TenantLineInnerInterceptor();
        tenantInterceptor.setTenantLineHandler(new TenantLineHandler() {
            @Override
            public Expression getTenantId() {
                // 返回当前租户 ID
                return new LongValue(1L); // 假设当前租户 ID 为 1
            }

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

            @Override
            public boolean ignoreTable(String tableName) {
                // 忽略不需要多租户过滤的表
                return "sys_config".equals(tableName); // 例如系统配置表不需要过滤
            }
        });

        interceptor.addInnerInterceptor(tenantInterceptor);
        return interceptor;
    }
}

2.3 实体类配置

在实体类中添加租户 ID 字段，并使用 @TableField 注解标记：

@Data
public class User {
    private Long id;
    private String username;

    @TableField("tenant_id")
    private Long tenantId; // 租户 ID
}

---

3. 多租户的 SQL 拦截与动态参数注入

3.1 SQL 拦截原理

MyBatis-Plus 的多租户拦截器会在 SQL 执行时，自动在查询条件中添加租户 ID。例如：

• 原始 SQL：

  SELECT * FROM user WHERE username = 'admin';
  

• 拦截后的 SQL：

  SELECT * FROM user WHERE username = 'admin' AND tenant_id = 1;
  

3.2 动态参数注入

通过 TenantLineHandler，可以动态注入当前租户 ID。例如：

@Override
public Expression getTenantId() {
    // 从当前线程或上下文中获取租户 ID
    return new LongValue(TenantContext.getCurrentTenantId());
}

---

4. 多租户系统中的权限与数据隔离

4.1 数据隔离

在多租户系统中，数据隔离是核心需求。通过 MyBatis-Plus 的多租户拦截器，可以确保每个租户只能访问自己的数据。

示例：

• 租户 A（ID=1）只能访问 tenant_id = 1 的数据。
• 租户 B（ID=2）只能访问 tenant_id = 2 的数据。

4.2 权限控制

在多租户系统中，权限控制需要结合租户 ID 和用户角色。例如：

• 超级管理员：可以访问所有租户的数据。
• 租户管理员：只能访问自己租户的数据。
• 普通用户：只能访问自己创建的数据。

实现方式：

• 在查询时，动态添加租户 ID 和用户权限条件。
• 使用 Spring Security 或自定义权限框架实现细粒度的权限控制。

示例代码：

public List<User> getUsersByRole(Long tenantId, String role) {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.eq("tenant_id", tenantId)
                .eq("role", role);
    return userMapper.selectList(queryWrapper);
}

---

5. 总结

通过 MyBatis-Plus 的多租户支持，可以轻松实现多租户管理。以下是关键点总结：

1. 多租户的实现原理：

   • 独立数据库、独立 Schema、共享数据库三种方式。
   • 核心是通过租户 ID 实现数据隔离。

2. MyBatis-Plus 的多租户配置：

   • 使用 TenantLineInnerInterceptor 实现 SQL 拦截与动态参数注入。
   • 在实体类中标记租户 ID 字段。

3. SQL 拦截与动态参数注入：

   • 自动在查询条件中添加租户 ID。
   • 动态注入当前租户 ID。

4. 权限与数据隔离：

   • 结合租户 ID 和用户角色实现细粒度的权限控制。
   • 确保每个租户只能访问自己的数据。

通过合理的设计和配置，MyBatis-Plus 可以帮助开发者构建高效、安全的多租户系统。