整合 Mybatis-Plus-多租户

  • 使用背景
  • 多租户技术概述
  • 数据隔离三种方案
  • Mybatis-plus实现多租户方案


使用背景

当时项目架构搭建的时候使用了Mybatis-plus代替Myabtis，便使用了mp提供的多租户拦截器进行数据隔离。

多租户技术概述

链接: 一文带您了解软件多租户技术架构.

数据隔离三种方案

1、独立数据库：简单来说就是一个租户使用一个数据库，这种数据隔离级别最高，安全性最好，但是提高成本。

2、共享数据库、隔离数据架构：多租户使用同一个数据裤，但是每个租户对应一个Schema(数据库user)。-

3、共享数据库、共享数据架构：使用同一个数据库，同一个Schema，但是在表中增加了租户ID的字段，这种共享数据程度最高，隔离级别最低。下面样例以共享数据库、共享数据结构的形式的讲述

这里采用方案三，即共享数据库，共享数据架构，因为这种方案服务器成本最低，但是提高了开发成本
。

Mybatis-plus实现多租户方案

使用mybatis-plus 3.4.3.4的多租户解决方案
3.4之前版本的多租户依赖分页插件，现在的版本已不推荐，现在使用
官文文档：https://mp.baomidou.com/guide/interceptor-tenant-line.html#tenantlineinnerinterceptor.

1.引入mp的jar包

<dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.4.3.4</version>
 </dependency>

2.配置多租户插件

/**
 * 多租户处理插件
 *
 */
public class MyTenantLineHandler implements TenantLineHandler {


    public class CustomTenantLineHandler（String tenant_id） {
	        this.tenant_id = tenant_id；
	}
  
    /**
     * 需要添加租户ID的表
     */
    private final static List<String> IGNORE_TABLE_NAMES = Lists.newArrayList(
	"t_tenant"
    );
    private final static String tenant_name；
    private final static String tenant_id；

    /**
     * 获取租户ID值表达式(可从cookie、token、缓存中取)
     *
     * @return
     */
    @Override
    public Expression getTenantId() {
        return new LongValue(tenant_id));
    }

    /**
     * 获取租户字段名(数据库的租户ID字段名)
     *
     * @return
     */
    @Override
    public String getTenantIdColumn() {
        return tenant_name;
    }

    /**
     * 根据表名判断是否忽略拼接多租户条件
     *
     * @param tableName
     * @return
     */
    @Override
    public boolean ignoreTable(String tableName) {
        return IGNORE_TABLE_NAMES.contains(tableName);
    }

3.配置数据源

public class DataSourceConfiguration {
    private static Logger logger = LoggerFactory.getLogger(DataSourceConfiguration.class);

    @Value("${mybatis.package}")
    private String typeAliasesPackage;

    // 获取数据源
    @Bean("dataSource")
    @Qualifier("dataSource")
    public DataSource dataSource(HikariConfiguration configuration) {
        return new HikariDataSource(configuration.getConfig());
    }

    @Bean("jdbcTemplate")
    public JdbcTemplate jdbcTemplate(@Qualifier("dataSource") DataSource dataSource) {
        return new JdbcTemplate(dataSource);
    }

    @Bean("transactionManager")
    public DataSourceTransactionManager transactionManager(@Qualifier("dataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

    @Bean(name = "sqlSessionFactory")
    public SqlSessionFactory sqlSessionFactory(@Qualifier("dataSource") DataSource dataSource) throws Exception {
    
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(ffhjds);
        factoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:/mapper/*.xml")
        );
        
        //3.在生成SqlSessionFactory的方法中，通过setPlugins设置拦截器
        sessionFactory.setPlugins(mybatisPlusInterceptor());
        return sessionFactory.getObject();
    }


    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        //2.MybatisPlusInterceptor   addInnerInterceptor方法中添加 多租户插件的注入
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 多租户插件（注意：这个一定要放在最上面） 注入 多租户拦截器
        interceptor.addInnerInterceptor(tenantLineInnerInterceptor());
        return interceptor;
    }

    @Bean
    public MyTenantLineHandler tenantLineInnerInterceptor() {
        // 可从上下文 获取你得 租户id tenant_id
        // 1. 设置你得 租户配置
        return new TenantLineInnerInterceptor(new MyTenantLineHandler (tenant_id));
    }

4.配置好之后就可以让mp去拦截sql，进行sql拼接了。

mp会在改、删 的操作时，将tenant_id到where条件后，tenant_id的值 需要你用自己的逻辑去取。
新增的时候会根据当前的tenant_id，自动拼接然后insert到数据库中。