大型SaaS系统的数据范围权限设计与实现！

　　前言
　　多租户（MultiTenant）是SaaS中的一个重要概念，它是一种软件架构技术，在多个租户的环境下，共享同一套系统实例，并且租户之间的数据具有隔离性，也就是说一个租户不能去访问其他租户的数据。基于不同的隔离级别，通常具有下面三种实现方案：每个租户使用独立DataBase，隔离级别高，性能好，但成本大租户之间共享DataBase，使用独立的Schema租户之间共享Schema，在表上添加租户字段，共享数据程度最高，隔离级别最低。数据库设计
　　Mybatisplus在第3层隔离级别上，提供了基于分页插件的多租户的解决方案，我们对此来进行介绍。在正式开始前，首先做好准备工作创建两张表，在基础字段后都添加租户字段tenantid：CREATETABLEuser（idbigint（20）NOTNULL，namevarchar（20）DEFAULTNULL，phonevarchar（11）DEFAULTNULL，addressvarchar（64）DEFAULTNULL，tenantidbigint（20）DEFAULTNULL，PRIMARYKEY（id））CREATETABLEdept（idbigint（20）NOTNULL，deptnamevarchar（64）DEFAULTNULL，commentvarchar（128）DEFAULTNULL，tenantidbigint（20）DEFAULTNULL，PRIMARYKEY（id））引入依赖
　　在项目中导入需要的依赖：dependencygroupIdcom。baomidougroupIdmybatisplusbootstarterartifactIdversion3。3。2versiondependencydependencygroupIdcom。github。jsqlparsergroupIdjsqlparserartifactIdversion3。1versiondependency实现
　　Mybatisplus配置类：EnableTransactionManagement（proxyTargetClasstrue）ConfigurationpublicclassMybatisPlusConfig｛BeanpublicPaginationInterceptorpaginationInterceptor（）｛PaginationInterceptorpaginationInterceptornewPaginationInterceptor（）；ListISqlParsersqlParserListnewArrayList（）；TenantSqlParsertenantSqlParsernewTenantSqlParser（）；tenantSqlParser。setTenantHandler（newTenantHandler（）｛OverridepublicExpressiongetTenantId（booleanselect）｛StringtenantId3；returnnewStringValue（tenantId）；｝OverridepublicStringgetTenantIdColumn（）｛returntenantid；｝OverridepublicbooleandoTableFilter（StringtableName）｛returnfalse；｝｝）；sqlParserList。add（tenantSqlParser）；paginationInterceptor。setSqlParserList（sqlParserList）；returnpaginationInterceptor；｝｝
　　这里主要实现的功能：创建SQL解析器集合创建租户SQL解析器设置租户处理器，具体处理租户逻辑
　　这里暂时把租户的id固定写成3，来进行测试。测试执行全表语句：publicListUsergetUserList（）｛returnuserMapper。selectList（newLambdaQueryWrapperUser（）。isNotNull（User：：getId））；｝
　　使用插件解析执行的SQL语句，可以看到自动在查询条件后加上了租户过滤条件：
　　那么在实际的项目中，怎么将租户信息传给租户处理器呢，根据情况我们可以从缓存或者请求头中获取，以从Request请求头获取为例：OverridepublicExpressiongetTenantId（booleanselect）｛ServletRequestAttributesattributes（ServletRequestAttributes）RequestContextHolder。getRequestAttributes（）；HttpServletRequestrequestattributes。getRequest（）；StringtenantIdrequest。getHeader（tenantId）；returnnewStringValue（tenantId）；｝
　　前端在发起http请求时，在Header中加入tenantId字段，后端在处理器中获取后，设置为当前这次请求的租户过滤条件。
　　如果是基于请求头携带租户信息的情况，那么在使用中可能会遇到一个坑，如果当使用多线程的时候，新开启的异步线程并不会自动携带当前线程的Request请求。OverridepublicListUsergetUserListByFuture（）｛CallablegetUser（）userMapper。selectList（newLambdaQueryWrapperUser（）。isNotNull（User：：getId））；FutureTaskListUserfuturenewFutureTask（getUser）；newThread（future）。start（）；try｛returnfuture。get（）；｝catch（Exceptione）｛e。printStackTrace（）；｝returnnull；｝
　　执行上面的方法，可以看出是获取不到当前的Request请求的，因此无法获得租户id，会导致后续报错空指针异常：
　　修改的话也非常简单，开启RequestAttributes的子线程共享，修改上面的代码：OverridepublicListUsergetUserListByFuture（）｛ServletRequestAttributessra（ServletRequestAttributes）RequestContextHolder。getRequestAttributes（）；CallablegetUser（）｛RequestContextHolder。setRequestAttributes（sra，true）；returnuserMapper。selectList（newLambdaQueryWrapperUser（）。isNotNull（User：：getId））；｝；FutureTaskListUserfuturenewFutureTask（getUser）；newThread（future）。start（）；try｛returnfuture。get（）；｝catch（Exceptione）｛e。printStackTrace（）；｝returnnull；｝
　　这样修改后，在异步线程中也能正常的获取租户信息了。
　　那么，有的小伙伴可能要问了，在业务中并不是所有的查询都需要过滤租户条件啊，针对这种情况，有两种方式来进行处理。
　　1、如果整张表的所有SQL操作都不需要针对租户进行操作，那么就对表进行过滤，修改doTableFilter方法，添加表的名称：OverridepublicbooleandoTableFilter（StringtableName）｛ListStringIGNORETENANTTABLESArrays。asList（dept）；returnIGNORETENANTTABLES。stream（）。anyMatch（ee。equalsIgnoreCase（tableName））；｝
　　这样，在dept表的所有查询都不进行过滤：
　　2、如果有一些特定的SQL语句不想被执行租户过滤，可以通过SqlParser注解的形式开启，注意注解只能加在Mapper接口的方法上：SqlParser（filtertrue）Select（selectfromuserwherename｛name｝）UserselectUserByName（Param（valuename）Stringname）；
　　或在分页拦截器中指定需要过滤的方法：BeanpublicPaginationInterceptorpaginationInterceptor（）｛PaginationInterceptorpaginationInterceptornewPaginationInterceptor（）；paginationInterceptor。setSqlParserFilter（metaObject｛MappedStatementmsSqlParserHelper。getMappedStatement（metaObject）；对应Mapper、dao中的方法if（com。cn。tenant。dao。UserMapper。selectUserByPhone。equals（ms。getId（）））｛returntrue；｝returnfalse；｝）；。。。｝
　　上面这两种方式实现的功能相同，但是如果需要过滤的SQL语句很多，那么第二种方式配置起来会比较麻烦，因此建议通过注解的方式进行过滤。
　　除此之外，还有一个比较容易踩的坑就是在复制Bean时，不要复制租户id字段，否则会导致SQL语句报错：publicvoidcreateSnapshot（LonguserId）｛UseruseruserMapper。selectOne（newLambdaQueryWrapperUser（）。eq（User：：getId，userId））；UserSnapshotuserSnapshotnewUserSnapshot（）；BeanUtil。copyProperties（user，userSnapshot）；userSnapshotMapper。insert（userSnapshot）；｝
　　查看报错可以看出，本身Bean的租户字段不为空的情况下，SQL又自动添加一次租户查询条件，因此导致了报错：
　　我们可以修改复制Bean语句，手动忽略租户id字段，这里使用的是hutool的BeanUtil工具类，可以添加忽略字段。BeanUtil。copyProperties（user，userSnapshot，tenantId）；
　　在忽略了租户id的拷贝后，查询可以正常执行。
　　最后，再来看一下对联表查询的支持，首先看一下包含子查询的SQL：Select（selectfromuserwhereidin（selectidfromusersnapshot））ListUserselectSnapshot（）；
　　查看执行结果，可以看见，在子查询的内部也自动添加的租户查询条件：
　　再来看一下使用Join进行联表查询：Select（selectu。fromuseruleftjoinusersnapshotusonu。idus。id）ListUserselectSnapshot（）；
　　同样，会在左右两张表上都添加租户的过滤条件：
　　再看一下不使用Join的普通联表查询：Select（selectu。fromuseru，usersnapshotus，deptdwhereu。idus。idandd。idisnotnull）ListUserselectSnapshot（）；
　　查看执行结果，可以看见在这种情况下，只在FROM关键字后面的第一张表上添加了租户的过滤条件，因此如果使用这种查询方式，需要额外注意，用户需要手动在SQL语句中添加租户过滤。
　　来源：https：mp。weixin。qq。comsSREXWGeYvtoCbabBBWrg