更新网站内容有什么用,科研院所网站建设,给装修公司做推广的网站,企业做网站需要做哪些工作目录 Mybatis-plus多租户插件实现原理使用 Mybatis-plus多租户插件
Mybatis-plus多租户插件是一种用于实现多租户功能的插件#xff0c;它基于Mybatis框架#xff0c;通过拦截器机制实现对多租户的支持。该插件的核心组件包括TenantHandler和TenantInterceptor#xff0c;其… 目录 Mybatis-plus多租户插件实现原理使用 Mybatis-plus多租户插件
Mybatis-plus多租户插件是一种用于实现多租户功能的插件它基于Mybatis框架通过拦截器机制实现对多租户的支持。该插件的核心组件包括TenantHandler和TenantInterceptor其中TenantHandler用于处理租户相关的逻辑如获取租户ID、设置租户信息等而TenantInterceptor则用于拦截需要处理多租户的SQL语句并在SQL中添加租户条件。
官方说明
多租户 ! 权限过滤,不要乱用,租户之间是完全隔离的!!!启用多租户后所有执行的method的sql都会进行处理.自写的sql请按规范书写(sql涉及到多个表的每个表都要给别名,特别是 inner join 的要写标准的 inner join
实现原理
Mybatis-plus多租户插件的实现原理主要基于Mybatis的拦截器(Interceptor)机制通过拦截器在需要执行的sql后面自动添加租户的查询条件实现多租户功能。具体来说Mybatis-plus提供了TenantLineInnerInterceptor租户处理器来实现多租户功能。在启用多租户后所有执行的method的sql都会被处理即自写的sql需要按照规范书写sql涉及到多个表的每个表都要给别名特别是inner join的要写标准的inner join。
简单来说Mybatis-plus多租户插件通过自定义Mybatis拦截器在执行sql时自动添加租户的查询条件实现多租户功能。
和基于物理隔离分表实现多租户不同基于逻辑隔离租户标识列tenant_id实现多租户是在每一张表中添加一个租户标识列tenant_id通过该列来区分各个租户的数据。
TenantLineInnerInterceptor插件也是基于逻辑隔离租户标识列tenant_id实现多租户的只不过它给我们封装了部分逻辑让我们不用再SQL中显示地指定tenant_id作为条件它会自动为我们拼接。
使用
1、自定义TenantLineHandler
下面是TenantLineHandler 接口的定义主要是用于获取租户ID和表是否需要需要租户隔离判断
/*** 租户处理器 TenantId 行级 ** author hubin* since 3.4.0*/
public interface TenantLineHandler {/*** 获取租户 ID 值表达式只支持单个 ID 值* p** return 租户 ID 值表达式*/Expression getTenantId();/*** 获取租户字段名* p* 默认字段名叫: tenant_id** return 租户字段名*/default String getTenantIdColumn() {return tenant_id;}/*** 根据表名判断是否忽略拼接多租户条件* p* 默认都要进行解析并拼接多租户条件** param tableName 表名* return 是否忽略, true:表示忽略false:需要解析并拼接多租户条件*/default boolean ignoreTable(String tableName) {return false;}/*** 忽略插入租户字段逻辑** param columns 插入字段* param tenantIdColumn 租户 ID 字段* return*/default boolean ignoreInsert(ListColumn columns, String tenantIdColumn) {return columns.stream().map(Column::getColumnName).anyMatch(i - i.equalsIgnoreCase(tenantIdColumn));}
}自定义的TenantLineHandler 我们需要按照自己的实际情况来定义自己的租户字段和获取
Slf4j
Component
public class MyTenantLineHandler implements TenantLineHandler {/*** 租户字段名*/private static final String SYSTEM_TENANT_ID tenant_id;/*** 默认的租户ID*/public static final Long DEFAULT_TENANT_ID 1L;/*** 需要过滤的表*/private static final ListString IGNORE_TENANT_TABLES new ArrayList();/*** 获取租户ID值* return*/Overridepublic Expression getTenantId() {//获取登录用户的租户IDLong loginUserTenantId getLoginUserTenantId();if (loginUserTenantId null){loginUserTenantId DEFAULT_TENANT_ID;}return new LongValue(loginUserTenantId);}/*** 租户字段名默认是tenant_id如果想改成其他字段在这里返回即可* return*/Overridepublic String getTenantIdColumn() {return SYSTEM_TENANT_ID;}/*** 有不需要进行租户隔离的表在这里返回true* param tableName* return*/Overridepublic boolean ignoreTable(String tableName) {return IGNORE_TENANT_TABLES.contains(tableName);}public Long getLoginUserTenantId(){//模拟获取登录用户的租户ID实际项目可以从登录用户缓存信息中获取return 1L;}}2、添加租户ID字段
我们的表和实体类都需要添加上租户ID字段
表字段 tenant_id bigint(20) NOT NULL COMMENT 多租户下的租户ID,实体字段 TableField(tenant_id)private Long tenantId;3、注册mybatisplus的多租户实现到 MybatisPlusInterceptor
Configuration
public class MybatisPlusConfig {/*** 添加MP插件*/Beanpublic MybatisPlusInterceptor mybatisPlusInterceptor() {MybatisPlusInterceptor interceptor new MybatisPlusInterceptor();// 添加多租户插件interceptor.addInnerInterceptor(new TenantLineInnerInterceptor(new MyTenantLineHandler()));//如果配置多个插件,切记分页最后添加,如果有多数据源可以不配具体类型 否则都建议配上具体的DbTypePaginationInnerInterceptor paginationInnerInterceptor new PaginationInnerInterceptor(DbType.MYSQL);//设置单页分页最大数量paginationInnerInterceptor.setMaxLimit(500L);interceptor.addInnerInterceptor(paginationInnerInterceptor);return interceptor;}}完成上面配置之后Mybatisplus就会帮我们在增删改查的所有操作都给拼接上携带租户条件。
