Mybatis-plus多租户 详解基于Mybatis-plus多租户实现方案
逐梦小生 人气:0一、引言
小编先解释一下什么叫多租户，什么场景下使用多租户。
多租户是一种软件架构技术，在多用户的环境下，共有同一套系统，并且要注意数据之间的隔离性。
举个实际例子：小编曾经开发过一套支付宝程序，这套程序应用在不同的小程序上，当使用者访问不同，并且进入相对应的小程序页面，小程序则会把用户相关数据传输到小编这里。在传输的时候需要带上小程序标识（租户ID），以便小编将数据进行隔离。
当不同的租户使用同一套程序，这里就需要考虑一个数据隔离的情况。
数据隔离有三种方案：
1、独立数据库：简单来说就是一个租户使用一个数据库，这种数据隔离级别最高，安全性最好，但是提高成本。
2、共享数据库、隔离数据架构：多租户使用同一个数据裤，但是每个租户对应一个Schema(数据库user)。-
3、共享数据库、共享数据架构：使用同一个数据库，同一个Schema，但是在表中增加了租户ID的字段，这种共享数据程度最高，隔离级别最低。
二、具体实现
这里采用方案三，即共享数据库，共享数据架构，因为这种方案服务器成本最低，但是提高了开发成本。
实现架构逻辑：
Mybatis-plus实现多租户方案
Mybatis-plus就提供了一种多租户的解决方案，实现方式是基于分页插件(拦截器)进行实现的；
第一步：在应用添加维护一张tenant（租户表），在需要进行隔离的数据表上新增租户id；
第二步：实现TenantHandler接口并实现它的方法：
public interface TenantHandler {
/**
* 获取租户 ID 值表达式，支持多个 ID 条件查询
* <p>
* 支持自定义表达式，比如：tenant_id in (1,2) @since 2019-8-2
*
* @param where 参数 true 表示为 where 条件 false 表示为 insert 或者 select 条件
* @return 租户 ID 值表达式
*/
Expression getTenantId(boolean where);
/**
* 获取租户字段名
*
* @return 租户字段名
*/
String getTenantIdColumn();
/**
* 根据表名判断是否进行过滤
*
* @param tableName 表名
* @return 是否进行过滤, true:表示忽略，false:需要解析多租户字段
*/
boolean doTableFilter(String tableName);
}
PreTenantHandler 实现 TenantHandler
@Slf4j
@Component
public class PreTenantHandler implements TenantHandler {
@Autowired
private PreTenantConfigProperties configProperties;
/**
* 租户Id
*
* @return
*/
@Override
public Expression getTenantId(boolean where) {
//可以通过过滤器从请求中获取对应租户id
Long tenantId = PreTenantContextHolder.getCurrentTenantId();
log.debug("当前租户为{}", tenantId);
if (tenantId == null) {
return new NullValue();
}
return new LongValue(tenantId);
}
/**
* 租户字段名
*
* @return
*/
@Override
public String getTenantIdColumn() {
return configProperties.getTenantIdColumn();
}
/**
* 根据表名判断是否进行过滤
* 忽略掉一些表：如租户表（sys_tenant）本身不需要执行这样的处理
*
* @param tableName
* @return
*/
@Override
public boolean doTableFilter(String tableName) {
return configProperties.getIgnoreTenantTables().stream().anyMatch((e) -> e.equalsIgnoreCase(tableName));
}
}
第三步：配置mybatisPlus的分页插件配置
@EnableTransactionManagement
@Configuration
@MapperScan({"com.xd.pre.**.mapper"})
public class MyBatisPlusConfig {
@Autowired
private PreTenantHandler preTenantHandler;
/**
* 分页插件
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
List<ISqlParser> sqlParserList = new ArrayList<>();
// 攻击 SQL 阻断解析器、加入解析链
sqlParserList.add(new BlockAttackSqlParser());
// 多租户拦截
TenantSqlParser tenantSqlParser = new TenantSqlParser();
tenantSqlParser.setTenantHandler(preTenantHandler);
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);
}
运行sql实例：
DEBUG==> Preparing: SELECT id, login_name, name, password,
email, salt, sex, age, phone, user_type, status,
organization_id, create_time, update_time, version,
tenant_id FROM sys_user
WHERE sys_user.tenant_id = '001' AND is_delete = '0' AND age = ?
注：特定SQL过滤 如果在程序中，有部分SQL不需要加上租户ID的表示，需要过滤特定的sql，可以通过如下两种方式：
方式一：在配置分页插件中加上配置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;
}
});
方式二：通过租户注解 @SqlParser(filter = true) 的形式，目前只能作用于Mapper的方法上：
public interface UserMapper extends BaseMapper<User> {
/**
* 自定Wrapper修改
*
* @param userWrapper 条件构造器
* @param user 修改的对象参数
* @return
*/
@SqlParser(filter = true)
int updateByMyWrapper(@Param(Constants.WRAPPER) Wrapper<User> userWrapper, @Param("user") User user);
}
注：
加载全部内容