SpringBoot 專案使用 Mybatis Plus 實現多租戶

Kllin發表於2024-06-22
Spring BootMyBatis

pom檔案

    <properties>
      <mybatis-plus.version>3.5.1</mybatis-plus.version>
    </properties>

    <!-- mybatis-plus 依賴配置 -->
    <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-boot-starter</artifactId>
      <version>${mybatis-plus.version}</version>
    </dependency>

    <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-extension</artifactId>
      <version>${mybatis-plus.version}</version>
</dependency>

bootstrap.yml配置

#多租戶配置
tenant:
  enable: true
  column: tenant_id
  filterTables:
  ignoreTables:
    - sys_app
  ignoreLoginNames:

租戶配置屬性類


import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * 多租戶配置屬性類
 */
@Data
@ConfigurationProperties(prefix = "tenant")
public class TenantProperties {
    /**
     * 是否開啟多租戶
     */
    private Boolean enable;

    /**
     * 租戶id欄位名
     */
    private String column;

    /**
     * 需要進行租戶id過濾的表名集合
     */
    private List<String> filterTables;

    /**
     * 需要忽略的多租戶的表，此配置優先filterTables，若此配置為空則啟用filterTables
     */
    private List<String> ignoreTables;

    /**
     * 需要排除租戶過濾的登入使用者名稱
     */
    private List<String> ignoreLoginNames;
}

多租戶校驗邏輯處理

/**
 * 多租戶處理器實現類
 */

import com.baomidou.mybatisplus.extension.plugins.handler.TenantLineHandler;
import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.expression.StringValue;

public class MultiTenantHandler implements TenantLineHandler {

    private final TenantProperties properties;

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

    /**
     * 獲取租戶ID值表示式，只支援單個ID值 (實際應該從使用者資訊中獲取)
     *
     * @return 租戶ID值表示式
     */
    @Override
    public Expression getTenantId() {
        // 實際應該從使用者資訊中獲取，框架一般都有獲取使用者資訊的介面
        String tenant_id = ""；
        // 判空校驗
        if (StringUtil.isNotEmpty(tenant_id)) {
            return new StringValue(tenant_id);
        }
        return new StringValue("");
    }

    /**
     * 獲取租戶欄位名,預設欄位名叫: tenant_id
     *
     * @return 租戶欄位名
     */
    @Override
    public String getTenantIdColumn() {
        return properties.getColumn();
    }

    /**
     * 根據表名判斷是否忽略拼接多租戶條件
     * <p>
     * 預設都要進行解析並拼接多租戶條件
     *
     * @param tableName 表名
     * @return 是否忽略, true:表示忽略，false:需要解析並拼接多租戶條件
     */
    @Override
    public boolean ignoreTable(String tableName) {
        // 自定義註解忽略攔截（可選，有的場景是獲取不到登入使用者資訊的，比如系統內部呼叫介面，所以用一個記憶體變數來儲存是否忽略校驗）
        if (TenantContext.isInternalInvocation()) {
            return true;
        }

        // 可以自行增加一些校驗比如獲取不到使用者就直接 return false 之類的。

        // 忽略指定使用者對租戶的資料過濾
        String username = "";
        if (null != ignoreLoginNames && ignoreLoginNames.contains(username)) {
            return true;
        }

        // 忽略指定表對租戶資料的過濾
        List<String> ignoreTables = properties.getIgnoreTables();
        if (null != ignoreTables && ignoreTables.contains(tableName)) {
            return true;
        }
        return false;
    }
}

配置類

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

    /**
     * 如果用了分頁外掛注意先 add TenantLineInnerInterceptor 再 add PaginationInnerInterceptor
     */
    @Bean("mybatisPlusInterceptor")
    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;
    }


    /**
     * 分頁外掛，自動識別資料庫型別 https://baomidou.com/guide/interceptor-pagination.html
     */
    public PaginationInnerInterceptor paginationInnerInterceptor() {
        PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor();
        // 設定資料庫型別為mysql
        paginationInnerInterceptor.setDbType(DbType.MYSQL);
        // 設定最大單頁限制數量，預設 500 條，-1 不受限制
        paginationInnerInterceptor.setMaxLimit(-1L);
        return paginationInnerInterceptor;
    }

    /**
     * 樂觀鎖外掛 https://baomidou.com/guide/interceptor-optimistic-locker.html
     */
    public OptimisticLockerInnerInterceptor optimisticLockerInnerInterceptor() {
        return new OptimisticLockerInnerInterceptor();
    }

    /**
     * 如果是對全表的刪除或更新操作，就會終止該操作 https://baomidou.com/guide/interceptor-block-attack.html
     */
    public BlockAttackInnerInterceptor blockAttackInnerInterceptor() {
        return new BlockAttackInnerInterceptor();
    }
}

忽略校驗自定義註解(可選)

/**
 * 忽略多租戶校驗
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface IgnoreTenant {
}

自定義註解切面類(可選)

/**
 * 自定義註解切面類
 */
@Aspect
@Component
public class TenantAspect {

    @Around("@annotation(xxx.xxx.IgnoreTenant)")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        try {
            TenantContext.setInternalInvocation(true);
            return joinPoint.proceed();
        } finally {
            TenantContext.clear();
        }
    }
}

提供操作記憶體變數的方法(可選)

/**
 * 租戶上下文
 */
public class TenantContext {
    private static final ThreadLocal<Boolean> THREAD_LOCAL = ThreadLocal.withInitial(() -> false);

    public static void setInternalInvocation(boolean internal) {
        THREAD_LOCAL.set(internal);
    }

    public static boolean isInternalInvocation() {
        return THREAD_LOCAL.get();
    }

    public static void clear() {
        THREAD_LOCAL.remove();
    }
}

相關文章