原文链接:
https://blog.csdn.net/qq_38846242/article/details/86529896

数据权限设计研究-行数据权限

  • 关于权限设计
    • 功能权限
    • 数据权限
  • 前提
    • 数据分类
    • 几种场景
  • 设计方案与思路
    • 映射表
    • 提供过滤sql的方法
  • 测试
  • 实际应用
    • 查询
    • 新增
    • 修改
    • 删除
    • 修改数据的私有,公开,部门属性
      • 私有改为部门
      • 私有改为公开
      • 部门改为公开
      • 其他变更
  • 总结

    关于权限设计

    一般来说,权限模块对于每一个系统而言都是最基础的模块,根据项目需求和功能的不同,设计方案也有许多。但从大的方面来说,可以将权限分为两大类型:功能权限数据权限

    功能权限

    主要控制不同的资源主体(用户、角色、组织等)有操作不同的资源的权限。比如常见的不同的角色能访问不同的页面(菜单权限),以及具有操作同一页面的不同功能(按钮权限)等等。对于java开发而言,功能权限的开发相对来说要简单很多,有很多现成的框架可以实现。我推荐用shiro,因为简单易用,而且能实现按钮级别的控制。

    数据权限

    主要控制不同的资源主体(用户、角色、组织等)有查看不同的数据信息的权限。数据权限又分为数据行权限和数据列权限,本篇文章主要研究一下数据行权限的控制。

    前提

    数据权限一般和业务的关系非常紧密,可能不同的业务有不同的设计方案,所以很难有一种统一而使用简单的设计方案。我的想法是:基于角色-部门的控制方式。即拥有某个角色的人,能看见当前角色所包含的部门中的数据。为了更好的设计数据权限,我总结了一下几种数据。

    数据分类

  1. 公开数据:字面意思,就是公开的数据,不需要控制数据权限。
  2. 部门数据:属于某个部门的数据,只有部门的人员可以查看。
  3. 私有数据:用户自己的数据,只能自己查看。

    几种场景

  4. 某条数据属于多个部门的情况。

  5. 某领导可以跨部门查看数据。
  6. 可以查看子部门的数据。
  7. 私有数据可以分享给别人,部门,或者公开。

    设计方案与思路

    百度上一堆关于数据权限的设计方案,基本上都是基于用户-角色-部门这个来设计,我的思路也和这个差不多,用户与数据角色挂钩,数据角色与部门挂钩,这就比直接角色与部门挂钩要相对灵活一些。虽然某个用户只能属于一个部门,但是有可能出现上面提到的第2中场景,跨部门的情况。
    数据权限设计研究-行数据权限 - 图1
    我的设计思路是提供一个方法,写业务的人员需要将查询的表名传给这个方法,然后我返回一段sql,这段sql只是在原来的表上进行数据权限过滤,返回的数据字段和原表一模一样,然后业务代码编写者再把这个sql作为参数传递到DAO层,拼接到FROM后面或者JOIN后面即可。这样无论是单表查询还是多表查询,都可以实现数据权限控制。
    还有一种思路是就是用mybatis拦截器去拦截sql,然后对sql进行改造拼接,但是这样我需要去拦截每一条select的sql,可能会对性能有影响。
    为了少改原有的业务表,同时统一对系统中的表进行数据权限控制,我设计了一张映射表,来映射数据表,部门,用户之间的关系。

    映射表

    映射表字段如下
字段名 类型 描述 备注
ID 字符串 主键
T_ID 字符串 数据表中的主键
TABLE_NAME 字符串 数据表表名
D_ID 字符串 部门ID主键
U_ID 字符串 用户ID主键

主键字段为字符串纯属个人习惯。
有了这张映射表,我们就能根据映射表中的部门ID和用户ID是否为空来进行数据权限的识别,同时也能修改数据的所属权限(公开,部门,私有)。

数据类型 部门ID 用户ID 备注
公开数据
部门数据 非空 非空
私有数据 非空

因为有私有数据分享给其他人或者部门,单条数据属于多个部门的情况,所以数据表与映射表应该是一对多的关系。

提供过滤sql的方法

代码如下

  1. /**
  2. * 数据权限sql拼接
  3. *
  4. * @author chunhui.tan
  5. * @创建时间 2019年1月9日 下午4:30:09
  6. *
  7. */
  8. @Component
  9. public class DataSqlFilter {
  10. @Autowired
  11. private TsysUserRoleService tsysUserRoleService;
  12. @Autowired
  13. private TsysRoleDeptService tsysRoleDeptService;
  14. @Autowired
  15. private TsysDeptService tsysDeptService;
  16. /**
  17. * 部门与数据表映射表的表名
  18. */
  19. public final String MAPPING_TABLE = "DATA_MAPPING";
  20. /**
  21. *
  22. * @param tableName 表名
  23. * @param pkNmae 主键名
  24. * @param isPrivate 是否只获取私有
  25. * @param subDept 是否拥有子部门数据权限
  26. * @return
  27. */
  28. public String getDataSql(String tableName, String pkNmae, Boolean isPrivate, Boolean subDept) {
  29. // 校验参数
  30. checkParam(tableName, pkNmae, isPrivate, subDept);
  31. // 判断当前表是否开启数据权限
  32. if (!isNeedPermissions(tableName)) {
  33. return null;
  34. }
  35. // 获取当前用户
  36. TsysUserEntity user = ShiroUtils.getUserEntity();
  37. // 获取部门数据所需要的sql
  38. String deptSql = getFilterSql(user, subDept);
  39. StringBuilder dataSql = new StringBuilder();
  40. dataSql.append("( SELECT DISTINCT S.* FROM ").append(tableName).append(" S LEFT JOIN ").append(MAPPING_TABLE)
  41. .append(" T ON S.").append(pkNmae).append(" = T.T_ID AND T.TABLE_NAME= ").append("'").append(tableName)
  42. .append("'");
  43. if (isPrivate) {
  44. // 只获取私有数据
  45. dataSql.append(" WHERE (T.U_ID = ").append("'").append(user.getEmId()).append("'")
  46. .append(" AND (T.D_ID='' OR T.D_ID IS NULL))");
  47. } else {
  48. // 正常数据:私有数据+部门数据+公开数据
  49. dataSql.append(" WHERE T.D_ID IN ").append(deptSql).append(" OR (T.U_ID = ").append("'")
  50. .append(user.getEmId()).append("'").append(" AND (T.D_ID='' OR T.D_ID IS NULL))")
  51. .append(" OR ((T.D_ID='' OR T.D_ID IS NULL) AND (T.U_ID='' OR T.U_ID IS NULL))");
  52. }
  53. dataSql.append(")");
  54. return dataSql.toString();
  55. }
  56. /**
  57. * 判断当前表是否开启数据权限
  58. *
  59. * @param tableName
  60. * @return
  61. */
  62. private Boolean isNeedPermissions(String tableName) {
  63. // TODO 这里可以通过表名查询配置或者表来判断改表是否开启了数据权限
  64. return true;
  65. }
  66. /**
  67. * 获取部门数据情况下的过滤条件SQL
  68. *
  69. * @param user
  70. * @param subDept
  71. */
  72. private String getFilterSql(TsysUserEntity user, Boolean subDept) {
  73. // 部门ID列表
  74. Set<String> deptIdList = new HashSet<>();
  75. // 用户角色对应的部门ID列表
  76. List<String> roleIdList = tsysUserRoleService.queryRoleIdList(user.getEmId());
  77. if (roleIdList.size() > 0) {
  78. List<String> userDeptIdList = tsysRoleDeptService
  79. .queryDeptIdList(roleIdList.toArray(new String[roleIdList.size()]));
  80. deptIdList.addAll(userDeptIdList);
  81. }
  82. // 用户子部门ID列表
  83. if (subDept) {
  84. List<String> subDeptIdList = tsysDeptService.getSubDeptIdList(user.getEmDeptId());
  85. deptIdList.addAll(subDeptIdList);
  86. }
  87. List<String> result = deptIdList.stream().map(i -> {
  88. return "'" + i + "'";
  89. }).collect(Collectors.toList());
  90. StringBuilder sqlFilter = new StringBuilder();
  91. sqlFilter.append("(").append(StringUtils.join(result, ",")).append(")");
  92. return sqlFilter.toString();
  93. }
  94. /**
  95. * 参数校验
  96. *
  97. * @param tableName
  98. * @param pkNmae
  99. * @param isPrivate
  100. * @param subDept
  101. */
  102. private void checkParam(String tableName, String pkNmae, Boolean isPrivate, Boolean subDept) {
  103. //TODO 进行sql注入的校验
  104. if (StringUtils.isBlank(tableName) || StringUtils.isBlank(pkNmae) || null == isPrivate || null == subDept) {
  105. throw new XcrmsException("数据权限-缺少参数");
  106. }
  107. }
  108. }

测试

当前系统使用shiro做的权限,角色分成两种类型,一种是功能角色,一种是数据角色。功能角色与菜单按钮挂钩,数据角色与部门挂钩。接下来用PostMan接口测试方式来测试获取到的sql。
只获取私有数据

  1. @Autowired(required = true)
  2. private DataSqlFilter dataSqlFilter;
  3. /**
  4. * test
  5. *
  6. * @param id
  7. * @return
  8. */
  9. @GetMapping("/getDataSql")
  10. public Result getDataSql() {
  11. String dataSql = dataSqlFilter.getDataSql("PRODUCT", "P_ID", Boolean.TRUE, Boolean.FALSE);
  12. System.out.println(dataSql);
  13. return ResultUtil.success(dataSql);
  14. }

结果用Navicat处理一下:
数据权限设计研究-行数据权限 - 图2
获取普通数据
所谓普通数据就是用户正常能看见的数据:私有数据+部门数据+公开数据。
将参数isPrivate设置为false即可

  1. @Autowired(required = true)
  2. private DataSqlFilter dataSqlFilter;
  3. /**
  4. * test
  5. *
  6. * @param id
  7. * @return
  8. */
  9. @GetMapping("/getDataSql")
  10. public Result getDataSql() {
  11. String dataSql = dataSqlFilter.getDataSql("PRODUCT", "P_ID", Boolean.FALSE, Boolean.FALSE);
  12. System.out.println(dataSql);
  13. return ResultUtil.success(dataSql);
  14. }

结果用Navicat处理一下:
数据权限设计研究-行数据权限 - 图3

实际应用

查询

业务开发人员在查询是只需要调用这个方法获取到sql后,然后作为参数传入DAO层,在mybatis的xml文件中拼接即可(图片中的${dataSql}应为#{dataSql}),如下:
数据权限设计研究-行数据权限 - 图4

新增

新增业务数据时,业务需要知道这个数据时那种数据类型,然后新增数据后,需要新增一条映射记录。提供过滤sql的类中可以提供统一的新增映射数据的方法。还没写,大概如下:

  1. /**
  2. * 新增映射数据
  3. *
  4. * @param pk_value 数据表数据主键值
  5. * @param tableName 数据表表名
  6. * @param type 数据类型 0 私有 1 公开 2 部门
  7. */
  8. public void addMapping(String pk_value, String tableName, Integer type) {
  9. // TODO 可以通过shiro获取到当前登录的用户,然后获取到用户的部门,然后根据type来新增映射关系
  10. }

修改

若只是修改数据,则不关映射表的事。

删除

删除时需要注意,因为某条数据可能属于多个部门或者多个个人,那么当删除掉这条数据后,那么映射表中就存在多条T_ID相同和TABLE_NAME相同的数据,删除的时候应该通过T_ID和TABLE_NAME来删除映射表中的所有数据。

修改数据的私有,公开,部门属性

即修改映射表,按道理说,一般只会存在数据的所有人能修改,但是以防万一,业务开发人员需要判断当前数据的U_ID是否与当前用户的用户ID一致,不一致不能修改。当然,公开数据时不需要进行这一步校验的。以下修改方法都可以在DataSqlFilter类中统一提供

私有改为部门

即用户将私有数据分享给指定的部门
修改方式:修改映射表中的D_ID为用户指定的部门ID

私有改为公开

即用户将私有数据全部公开
修改方式:置空映射表中的U_ID和D_ID

部门改为公开

即将部门所拥有的数据公开
修改方式:置空映射表中的U_ID和D_ID

其他变更

其他变更只要对照上面那张数据类型表即可进行修改。

总结

有人可能会说为什么不在原来的业务表上面加上部门ID和用户ID,从而不用映射表?
但是这样会有一些问题,一是实际开发过程中,往往由于需求的变化,很难确定哪些表需要加部门ID和用户ID。二是这样无法满足一些特殊需求,比如:个人数据分享出去给其他人或者部门,单条数据属于多个部门。
总结下来用以上方案来控制数据权限的优缺点如下
优点:
1.统一提供过滤sql,维护映射表,修改数据类型的方法,而且不用修改业务数据表,对原来的代码入侵最小化。
2.不论是单表查询还是多表都能支持。
3.比较灵活,针对不同需求,可以灵活调整过滤sql
缺点:
1.因为在对原表进行过滤时需要连接映射表,假如是多表联查,每张表都要连接映射表,可能对查询性能有影响。
2.因为每条业务数据都会对应一条映射数据,那么意味着映射表将会有很多数据,在过滤的时候会影响性能,当然这里可以用分模块设计多个映射表的方法来解决。
以上只是一个设计思路,还没用于实际项目,如有不足,欢迎斧正,谢谢。