前言
多租户(Multi-Tenant)是SaaS中的一个重要概念,它是一种软件架构技术,在多个租户的环境下,共享同一套系统实例,并且租户之间的数据具有隔离性,也就是说一个租户不能去访问其他租户的数据。基于不同的隔离级别,通常具有下面三种实现方案:
- 每个租户使用独立DataBase,隔离级别高,性能好,但成本大
- 租户之间共享DataBase,使用独立的Schema
- 租户之间共享Schema,在表上添加租户字段,共享数据程度最高,隔离级别最低。
基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能
数据库设计
Mybatis-plus在第3层隔离级别上,提供了基于分页插件的多租户的解决方案,我们对此来进行介绍。在正式开始前,首先做好准备工作创建两张表,在基础字段后都添加租户字段tenant_id:
CREATE TABLE `user` ( `id` bigint(20) NOT NULL, `name` varchar(20) DEFAULT NULL, `phone` varchar(11) DEFAULT NULL, `address` varchar(64) DEFAULT NULL, `tenant_id` bigint(20) DEFAULT NULL, PRIMARY KEY (`id`) ) CREATE TABLE `dept` ( `id` bigint(20) NOT NULL, `dept_name` varchar(64) DEFAULT NULL, `comment` varchar(128) DEFAULT NULL, `tenant_id` bigint(20) DEFAULT NULL, PRIMARY KEY (`id`) )
基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能
引入依赖
在项目中导入需要的依赖:
<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.3.2</version> </dependency> <dependency> <groupId>com.github.jsqlparser</groupId> <artifactId>jsqlparser</artifactId> <version>3.1</version> </dependency>
实现
Mybatis-plus 配置类:
@EnableTransactionManagement(proxyTargetClass = true) @Configuration public class MybatisPlusConfig { @Bean public PaginationInterceptor paginationInterceptor() { PaginationInterceptor paginationInterceptor = new PaginationInterceptor(); List<ISqlParser> sqlParserList=new ArrayList<>(); TenantSqlParser tenantSqlParser=new TenantSqlParser(); tenantSqlParser.setTenantHandler(new TenantHandler() { @Override public Expression getTenantId(boolean select) { String tenantId = "3"; return new StringValue(tenantId); } @Override public String getTenantIdColumn() { return "tenant_id"; } @Override public boolean doTableFilter(String tableName) { return false; } }); sqlParserList.add(tenantSqlParser); paginationInterceptor.setSqlParserList(sqlParserList); return paginationInterceptor; } }
这里主要实现的功能:
- 创建SQL解析器集合
- 创建租户SQL解析器
- 设置租户处理器,具体处理租户逻辑
这里暂时把租户的id固定写成3,来进行测试。测试执行全表语句:
public List<User> getUserList() { return userMapper.selectList(new LambdaQueryWrapper<User>().isNotNull(User::getId)); }
使用插件解析执行的SQL语句,可以看到自动在查询条件后加上了租户过滤条件:
那么在实际的项目中,怎么将租户信息传给租户处理器呢,根据情况我们可以从缓存或者请求头中获取,以从Request请求头获取为例:
@Override public Expression getTenantId(boolean select) { ServletRequestAttributes attributes=(ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = attributes.getRequest(); String tenantId = request.getHeader("tenantId"); return new StringValue(tenantId); }
前端在发起http请求时,在Header中加入tenantId字段,后端在处理器中获取后,设置为当前这次请求的租户过滤条件。
如果是基于请求头携带租户信息的情况,那么在使用中可能会遇到一个坑,如果当使用多线程的时候,新开启的异步线程并不会自动携带当前线程的Request请求。
@Override public List<User> getUserListByFuture() { Callable getUser=()-> userMapper.selectList(new LambdaQueryWrapper<User>().isNotNull(User::getId)); FutureTask<List<User>> future=new FutureTask<>(getUser); new Thread(future).start(); try { return future.get(); } catch (Exception e) { e.printStackTrace(); } return null; }
执行上面的方法,可以看出是获取不到当前的Request请求的,因此无法获得租户id,会导致后续报错空指针异常:
修改的话也非常简单,开启RequestAttributes的子线程共享,修改上面的代码:
@Override public List<User> getUserListByFuture() { ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); Callable getUser=()-> { RequestContextHolder.setRequestAttributes(sra, true); return userMapper.selectList(new LambdaQueryWrapper<User>().isNotNull(User::getId)); }; FutureTask<List<User>> future=new FutureTask<>(getUser); new Thread(future).start(); try { return future.get(); } catch (Exception e) { e.printStackTrace(); } return null; }
这样修改后,在异步线程中也能正常的获取租户信息了。