MybatisPlus之租户拦截器TenantLineInnerInterceptor使用攻略

业务场景

在多项目的业务场景下，所有查询语句的where必须限制租户，比如where tenant_id = ‘xxx’,但是如果每个sql都手动拼接会很麻烦，因为MybatisPlus提供了租户拦截器TenantLineInnerInterceptor用于实现上述需求。

代码实现

@Configuration
@MapperScan("com.xxx.dao")
public class MybatisPlusConfig {
    
    /**
     * 先默认一个租户ID, 后面可能不需要.
     */
    private static final UUID DEFAULT_TENANT_ID = UUID.fromString("94680338-ca7c-480d-85d0-29ae201f6465");
    
    /**
     * 配置mybatis-plus插件.
     *
     * @return MybatisPlus拦截器
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 多租户插件必须要放在分页插件前.
        interceptor.addInnerInterceptor(new TenantLineInnerInterceptor(() -> {
            UUID tenantId = null;
            // 1.正常从SecurityUser中获取租户ID, 处理登录用户的情况
            xxx
            // 2.服务间调用, tenantId需要在request header中带入. 通过拦截器获取.
            xxx
            return new StringValue(tenantId.toString());
        }));
        
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.POSTGRE_SQL));
        return interceptor;
    }
}

存在问题

上述多租户配置会使得所有sql都会拼接上tenant_id = ‘xxx’，但还是会有特殊情况不需要拼接tenant_id，或者说部分表就没有tenant_id字段，一旦拼接上就会报错，因此需要手动忽视点某些表

解决方案

@Configuration
@MapperScan("com.xx.dao")
public class MybatisPlusConfig {
    
    /**
     * 先默认一个租户ID, 后面可能不需要.
     */
    private static final UUID DEFAULT_TENANT_ID = UUID.fromString("94680338-ca7c-480d-85d0-29ae201f6465");
    
    /**
     * 忽略的表.
     */
    @Value("${spring.tenant.ignore-tables}")
    private String[] ignoreTables;
    
    /**
     * 配置mybatis-plus插件.
     *
     * @return MybatisPlus拦截器
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 多租户插件必须要放在分页插件前.
        TenantLineInnerInterceptor tenantInterceptor = new TenantLineInnerInterceptor(
                new TenantLineHandler() {
                    @Override
                    public Expression getTenantId() {
                        UUID tenantId = null;
                        // 1.正常从SecurityUser中获取租户ID, 处理登录用户的情况
                        xxx
                        // 2.服务间调用, tenantId需要在request header中带入. 通过拦截器获取.
                        xxx
                        return new StringValue(tenantId.toString());
                    }
                    
                    @Override
                    public boolean ignoreTable(String tableName) {
                        return StrUtil.equalsAny(tableName, ignoreTables);
                    }
                });
        interceptor.addInnerInterceptor(tenantInterceptor);
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.POSTGRE_SQL));
        return interceptor;
    }
}