什么叫做saas，mybatis-plus优雅实现多租户数据权限隔离方案

1.背景

2.多租户数据隔离架构设计

3.mybatis-plus优雅实现多租户数据权限隔离

4.总结

1.背景

开发过SaaS系统平台的小伙伴一定对多租户这个概念不陌生，简单来说一个租户就是一个公司客户，多个租户共用同一个SaaS系统，一旦SaaS系统不可用，那么所有的租户都不可用。你可以这么理解SaaS系统就像一栋大楼，而租户就是大楼里面租办公楼层的公司，平时每家公司做着自己的业务，互不干扰，但是一旦大楼的电梯坏了，那么影响到的就是所有的公司。

多租户问题，其是一种架构设计方式，就是在一台或者一组服务器上运行的SaaS系统，可以为多个租户（客户）提供服务，目的是为了让多个租户在互联网环境下使用同一套程序，且保证租户间的数据隔离。

从这种架构设计的模式上，不难看出来，多租户架构的重点就是同一套程序下多个租户数据的隔离。由于租户数据是集中存储的，所以要实现数据的安全性，就是看能否实现对租户数据的隔离，防止租户数据不经意或被他人恶意地获取和篡改。在讲多租户数据隔离实现之前，先来看看什么是SaaS系统。

什么是SaaS系统 ？

SaaS平台是运营saas软件的平台。SaaS提供商为企业搭建信息化所需要的所有网络基础设施及软件、硬件运作平台，并负责所有前期的实施、后期的维护等一系列服务，租户(企业)无需购买软硬件、建设机房、招聘IT人员，即可通过互联网使用信息系统。SaaS 是一种软件布局模型，其应用专为网络交付而设计，便于用户通过互联网托管、部署及接入。

简单来说就是租户给SaaS平台付租金就能使用平台提供的功能服务，当下比较典型就是各种云平台、云服务厂商。

2.多租户数据隔离架构设计

目前saas多租户系统的数据隔离有三种架构设计，即为每个租户提供独立的数据库、独立的表空间、按字段区分租户，每种方案都有其各自的适用情况。

一个租户独立一个数据库

一个租户独立使用一个数据库，那就意味着我们的SaaS系统需要连接多个数据库，这种实现方案其实就和分库分表架构设计是一样的，好处就是数据隔离级别高、安全性好，毕竟一个租户单用一个数据库，但是物理硬件成本，维护成本也变高了。

独立的表空间

这种方案的实现方式，就是所有租户共用一个数据库系统，但是每个租户在数据库系统中拥有一个独立的表空间。

按租户id字段隔离租户

这种方案是多租户方案中最简单的数据隔离方法，即在每张表中都添加一个用于区分租户的字段（如tenant_id或org_id啥的）来标识每条数据属于哪个租户，当进行查询的时候每条语句都要添加该字段作为过滤条件，其特点是所有租户的数据全都存放在同一个表中，数据的隔离性是最低的，完全是通过字段来区分的，很容易把数据搞串或者误操作。

三种数据隔离架构设计的对比如下：

隔离方案	成本	支持租户数量	优点	缺点
独立数据库系统	高	少	数据隔离级别高，安全性，可以针对单个租户开发个性化需求	数据库独立安装，物理成本和维护成本都比较高
独立的表空间	中	较多	提供了一定程度的逻辑数据隔离，一个数据库系统可支持多个租户	数据库管理比较困难，表繁多，同时数据修复稍复杂
按租户id字段区分	低	多	维护和购置成本最低，每个数据库能够支持的租户数量最多	隔离级别最低，安全性也最低

大部分公司都是采用第三种：按租户id字段隔离租户 架构设计实现多租户数据隔离的。接下来我们就来看看代码层面怎么实现多租户数据隔离的。

3.mybatis-plus优雅实现多租户数据权限隔离

上面我们说过按租户id字段隔离租户 这种方式就是在获取数据的时候对每一条SQL语句添加租户id作为过滤条件来隔离租户数据的。但是这样意味着每个查询SQL都必须加上租户id这个过滤条件，如果漏加就意味着会查询出不同租户的数据，这是绝对不允许的，同时每个查询接口都需要手动设置过滤条件，重复劳动，一点都不够优雅。这时候就不得不说说mybatis-plus的多租户插件了，看看它如何优雅实现多租户隔离的？

再讲述之前，我们先思考一下如何优雅实现数据隔离？首先我们要求每一条SQL都加上租户id这个过滤条件，这意味着我们需要解析原始SQL在合适的地方加上租户id过滤条件，我们知道mybatis提供扩展点就是拦截器，可以对SQL语句处理前后进行增强逻辑，分页插件就是这么做的，所以我们这里要增强SQL自然也是这样，接下来我们就来看看mybatis-plus多租户插件是怎么实现多租户数据隔离的。

该拦截器部分源码如下：

public class TenantLineInnerInterceptor extends JsqlParserSupport implements InnerInterceptor {
    // 多租户处理器
    private TenantLineHandler tenantLineHandler;

    // 改SQL，添加多租户id条件
    public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
        if (!InterceptorIgnoreHelper.willIgnoreTenantLine(ms.getId())) {
            MPBoundSql mpBs = PluginUtils.mpBoundSql(boundSql);
            mpBs.sql(this.parserSingle(mpBs.sql(), (Object)null));
        }
    }

    public void beforePrepare(StatementHandler sh, Connection connection, Integer transactionTimeout) {
        MPStatementHandler mpSh = PluginUtils.mpStatementHandler(sh);
        MappedStatement ms = mpSh.mappedStatement();
        SqlCommandType sct = ms.getSqlCommandType();
        if (sct == SqlCommandType.INSERT || sct == SqlCommandType.UPDATE || sct == SqlCommandType.DELETE) {
            if (InterceptorIgnoreHelper.willIgnoreTenantLine(ms.getId())) {
                return;
            }

            MPBoundSql mpBs = mpSh.mPBoundSql();
            mpBs.sql(this.parserMulti(mpBs.sql(), (Object)null));
        }

    }

    // 碍于篇幅问题，下面省略的代码就是继承抽象类JsqlParserSupport解析SQL然后添加多租户id条件的，可以自行查看源码
  ......
}

接着我们来看看处理器TenantLineHandler，这是一个接口，需要我们提供自定义实现，指定多租户相关配置：

public class TenantDatabaseHandler implements TenantLineHandler {
    private final Set ignoreTables = new HashSet<>();

    public TenantDatabaseHandler(TenantProperties properties) {
        // 将配置文件配置的忽略表名同步大小写，适配不同写法
        properties.getIgnoreTables().forEach(table -> {
            ignoreTables.add(table.toLowerCase());
            ignoreTables.add(table.toUpperCase());
        });
    }

    /**
     * 获取租户字段名
     * 

     * 默认字段名叫: tenant_id，我这里使用org_id
     *
     * @return 租户字段名
     */
    @Override
    public String getTenantIdColumn() {
        return "org_id";
    }


    @Override
    public Expression getTenantId() {
        // 这里通过登录信息上下文返回租户id给多租户拦截器增强SQL使用
        return new LongValue(RequestUserHolder.getCurrentUser().getOrgId());
    }

    @Override
    public boolean ignoreTable(String tableName) {
        // 忽略多租户的表
        return CollUtil.contains(ignoreTables, tableName);
    }
}

配置属性如下：

@ConfigurationProperties(prefix = "ptc.tenant")
@Data
public class TenantProperties {


    /**
     * 全局控制是否开启多租户功能
     */
    private Boolean enable = Boolean.TRUE;

    /**
     * 需要忽略多租户的表
     *
     * 即默认所有表都开启多租户的功能，所以记得添加对应的 tenant_id 字段哟
     */
    private Set ignoreTables = Collections.emptySet();
}

接下来注入拦截器插件即可：

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor(TenantProperties properties) {
        MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
        // 必须保证多租户插件在分页插件之前，这个是 MyBatis-plus 的规定
        if (properties.getEnable()) {
        mybatisPlusInterceptor.addInnerInterceptor(new TenantLineInnerInterceptor(new TenantDatabaseHandler(properties)));
        }
        // 分页插件
        mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        return mybatisPlusInterceptor;
        }

使用示例如下：这里提供了一个常见的案例：用户和角色关联查询的SQL：getUserList()

    
select u.* from user u
                    left join user_role r on u.id = r.user_id
    
         
       and u.status = #{query.status}
         
         
       and r.role_id = #{query.roleId}
         
         
       and ((u.name like concat('%',#{query.keyword},'%')) or (u.mobile like concat(#{query.keyword},'%')))
         
         
       and u.entry_time >= #{query.startEntryTime}
         
         
         
         

         
group by u.id
order by u.id desc
        

启动项目，先登录之后使用token掉接口执行下面代码逻辑：

 public PageResult getList(UserQuery query) {

        Page page = new Page<>(query.getPageNo(), query.getPageSize());
        List userList = userDAO.getUserList(page, query);
        List userDTOS = toUserDTOList(userList);
        return new PageResult<>(userDTOS, page.getTotal(), page.getPages());
        }

查看控制台发现：

[1658720355293990912] [DEBUG] [2023-05-17 14:25:25.504] [http-nio-16688-exec-1@23652]  com.plasticene.textile.dao.UserDAO.getUserList debug : ==>  Preparing: SELECT u.* FROM user u LEFT JOIN user_role r ON u.id = r.user_id AND r.org_id = 3 WHERE u.org_id = 3 GROUP BY u.id ORDER BY u.id DESC LIMIT ?

        [1658720355293990912] [DEBUG] [2023-05-17 14:25:25.505] [http-nio-16688-exec-1@23652]  com.plasticene.textile.dao.UserDAO.getUserList debug : ==> Parameters: 20(Long)

user表u加上u.org_id=3这个多租户过滤条件，user_role也同样加上了，说明多租户插件起作用了。

当然如果想忽略掉表user，我们只需要在配置文件如下配置即可：

ptc:
  tenant:
    ignore-tables: user

这样user表u就不会再加上u.org_id=3这个多租户过滤条件，但是这里有一个细节需要注意，由于user在MySQL中是关键字，所以我有时候为了规范书写SQL，会按照如下编写：

select u.* from `user` u
                    left join user_role r on u.id = r.user_id

这时候你会发现上面配置的忽略表user不起作用，还是会加上u.org_id=3这个多租户过滤条件，跟源码才发现我们上面自定义的多租户处理器TenantLineHandler只对表名进行了大小写适配，然而这里SQL解析出来的表名是: user ，所以匹配不到配置不起作用。

当然我们有可能需要针对单一SQL语句不加多租户过滤条件，可以使用@InterceptorIgnore注解：

public interface UserDAO extends BaseMapperX {

    @InterceptorIgnore(tenantLine = "true")
    List getUserList(IPage userPage, @Param("query") UserQuery query);
}

这样调用getUserList()不再会加多租户过滤条件了。

通过上面我们知道了这个多租户插件其实就是通过解析SQL，然后进行拼接多租户id过滤条件来实现SQL增强从而做到数据隔离，解析SQL的框架叫：JSqlParser

Druid也可以解析SQL，我们都知道SQL语句会生成语法树，两者对SQL解析的孰强孰弱(特别是复杂SQL)不得而知，可以自行验证对比，我这里给出一个JSqlParser解析出错的情况，把上面的SQL语句user_role r 改为 user_role ur

select u.* from user u

                    left join user_role ur on u.id = ur.user_id

按照上面一样调用执行getUserList()， 会报解析错误：

Caused by: com.baomidou.mybatisplus.core.exceptions.MybatisPlusException: Failed to process, Error SQL: select u.* from user u

        left join user_role ur on u.id = ur.user_id
        group by u.id
        order by u.id desc
        at com.baomidou.mybatisplus.core.toolkit.ExceptionUtils.mpe(ExceptionUtils.java:39)
        at com.baomidou.mybatisplus.extension.parser.JsqlParserSupport.parserSingle(JsqlParserSupport.java:52)
        at com.baomidou.mybatisplus.extension.plugins.inner.TenantLineInnerInterceptor.beforeQuery(TenantLineInnerInterceptor.java:65)
        at com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor.intercept(MybatisPlusInterceptor.java:78)
        at org.apache.ibatis.plugin.Plugin.invoke(Plugin.java:62)
        at com.sun.proxy.$Proxy178.query(Unknown Source)
        at org.apache.ibatis.session.defaults.DefaultSqlSession.selectList(DefaultSqlSession.java:151)
        ... 101 common frames omitted
        Caused by: net.sf.jsqlparser.parser.ParseException: Encountered unexpected token: "ur" 
at line 2, column 29.

我在mybatis-plus的官方提了一个issue：https://github.com/baomidou/mybatis-plus/issues/5086，也得到官方维护者的迅速回应说是JSqlParser解析的问题，不是mybatis-plus的问题~~~，给出的建议就是把别名ur改成别的，或者升级到JSqlParser的最新版本。

4.总结

至此，我们对多租户系统数据隔离实现方案，架构设计，以及如何优雅实现全局操作数据隔离都讲完了，同时也对mybati-plus的多租户插件实现原理和源码流程套路进行了浅析，也对实际应用案例中进行了举证并阐述了相关细节点。

当然数据权限不止停留在租户(公司)层面上面，大多数系统的数据权限会按照业务组织架构角色来控制，数据权限其套路和根据角色判断菜单权限一回事。

由于数据权限通常与公司业务相关，比较个性化，每家公司业务组织架构不尽相同，所以实际开发项目的数据权限隔离还需要大家按实际需求进行修改，但总的来说我们可以模仿多租户隔离实现方式，比如说一个业务系统组织架构有公司(org_id)，公司下有多个部门(dept_id)，部门下有多个团队分组(team_id)，团队下有多个人员(user_id)。

不同角色只能看到不同数据，部门经理只能看到自己部门的数据，小组长只能看到自己小组的数据，这些实现逻辑套路都可以模仿多租户插件的方式进行优雅实现，这也是我后面有时间想研究的，后续会再出一篇数据权限的实现方案总结。

编辑：黄飞