MyBatis-Plus--多租户插件的用法

叁歲伎倆 2023-09-29 16:57 4阅读 0赞

原文网址：[MyBatis-Plus--多租户插件的用法\_IT利刃出鞘的博客-CSDN博客][MyBatis-Plus--_IT_-CSDN]

## 简介 ##

**说明**

本文介绍MyBatis-Plus的多租户插件的用法。

**官网网址**

[多租户插件 | MyBatis-Plus][_ MyBatis-Plus]

**多租户简介**

多租户是一种软件架构技术，在多用户的环境下，共有同一套系统，并且要注意数据之间的隔离性。

举个实际例子：小编曾经开发过一套H5程序，这套程序应用在不同医院的APP上，当医院患者下载医院APP，并且进入相对应的H5页面，APP则会把用户相关数据传输到小编这里。在传输的时候需要带上医院标识（租户ID），以便小编将数据进行隔离。

当不同的租户使用同一套程序，这里就需要考虑一个数据隔离的情况。数据隔离有三种方案：

1、独立数据库：简单来说就是一个租户使用一个数据库，这种数据隔离级别最高，安全性最好，但是提高成本。  
2、共享数据库、隔离表：多租户使用同一个数据库，但是每个租户对应一个表。  
3、共享数据库、共享表：使用同一个数据库，同一个表，在表中增加了租户ID的字段

MP就提供了一种多租户的解决方案，实现方式是基于分页插件进行实现的，用的是方案3。

> **粉丝福利**：有很多粉丝私信问我有没有Java的面试及PDF书籍等资料，我整理一下，包含：**真实**面试题汇总、简历模板、PDF书籍、PPT模板等。这些是**我自己也在用**的资料，面试题是面试官问到我的问题的整理，其他资料也是我自用的，真正**实用、靠谱**。资料可以从这里免费获取：[资料地址][Link 1]

## **配置** ##

@Configuration
    public class MyBatisPlusConfig {
        // 分页插件
        @Bean
        public PaginationInterceptor paginationInterceptor() {
            PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
     
            // 创建SQL解析器集合
            List<ISqlParser> sqlParserList = new ArrayList<>();
     
            // 创建租户SQL解析器
            TenantSqlParser tenantSqlParser = new TenantSqlParser();
     
            // 设置租户处理器
            tenantSqlParser.setTenantHandler(new TenantHandler() {
                @Override
                public Expression getTenantId() {
                    // 设置当前租户ID，实际情况你可以从cookie、或者缓存中拿都行
                    return new StringValue("jiannan");
                }
     
                @Override
                public String getTenantIdColumn() {
                    // 对应数据库租户ID的列名
                    return "tenant_id";
                }
     
                @Override
                public boolean doTableFilter(String tableName) {
                    // 是否需要需要过滤某一张表
                  /*  List<String> tableNameList = Arrays.asList("tb_user");
                    if (tableNameList.contains(tableName)){
                        return true;
                    }*/
                    return false;
                }
            });
     
            sqlParserList.add(tenantSqlParser);
            paginationInterceptor.setSqlParserList(sqlParserList);
     
            return paginationInterceptor;
        }
    }

## **测试** ##

配置好之后，不管是查询、新增、修改删除方法，MP都会自动加上租户ID的标识

@Test
        public void select(){
            List<User> users = userMapper.selectList(Wrappers.<User>lambdaQuery().eq(User::getAge, 18));
            users.forEach(System.out::println);
        }

DEBUG==>  Preparing: SELECT id, name, age, tenant_id FROM tb_user WHERE tb_user.tenant_id = 'jiannan' AND age = ? 
    DEBUG==> Parameters: 18(Integer)
    DEBUG<==      Total: 0

## **特定SQL过滤** ##

如果在程序中，有部分SQL不需要加上租户ID，需要过滤特定的sql，可以通过如下两种方法：

### 法1：自定义方法添加注解 ###

public interface UserMapper extends BaseMapper<User> {
        @SqlParser(filter = true)
        @Update("update xxx")
        int updateByMyWrapper(@Param(Constants.WRAPPER) Wrapper<User> userWrapper, 
                              @Param("user") User user);
    }

# 开启 SQL 解析缓存注解生效，如果你的MP版本在3.1.1及以上则不需要配置
    mybatis-plus:
      global-config:
        sql-parser-cache: true

### 法2：分页插件加上ISqlParserFilter解析器 ###

在配置分页插件中加上配置ISqlParserFilter解析器，如果配置SQL很多，比较麻烦，不建议。

paginationInterceptor.setSqlParserFilter(new ISqlParserFilter() {
        @Override
        public boolean doFilter(MetaObject metaObject) {
            MappedStatement ms = SqlParserHelper.getMappedStatement(metaObject);
            // 对应Mapper、dao中的方法
            if("com.example.demo.mapper.UserMapper.selectList".equals(ms.getId())){
                return true;
            }
            return false;
        }
    });

[MyBatis-Plus--_IT_-CSDN]: https://knife.blog.csdn.net/article/details/126305514
[_ MyBatis-Plus]: https://baomidou.com/pages/aef2f2/
[Link 1]: https://app.yinxiang.com/fx/d2ac6ff4-94c5-4e5f-9d4f-f5dfc344ede6