75 Star 265 Fork 102

mofum / open-scope

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

OPEN-SCOPE v2.0.0

open-scope

介绍

OpenScope是一种轻量级、易维护的数据权限的解决方案,它能处理比较复杂的权限操作逻辑。兼容操作权限Shiro等框架。

OpenScope提供了一种基于SQL的智能添加权限范围列的方案,相对原始的数据权限方案,它是轻量级的,它只有一些配置代码,同时它也是提高了代码的可维护性。另外它不需要额外的更改您的程序结构,就能轻松使您的项目支持数据权限操作。

什么是操作权限,什么是数据权限详细见WIKI 简介

当前版本支持的功能

  • 数据权限查询过滤
  • 支持注解或代码方式添加范围ID
  • 兼容其他Mybatis插件
  • 支持较细粒度的多范围认证
  • 支持数据SQL列过滤
  • 支持数据返回结果属性过滤

当前版本处理流程

数据权限查询过滤

  • 提取参数中的业务ID(SSID) 记为集合A
  • 将集合A转换为范围ID(SID) 记为集合B
  • 将集合B根据各自的范围拼装进SQL处理

数据权限鉴权

  • 提取参数中的业务ID(SSID) 记为集合A
  • 将集合A转换为范围ID(SID) 记为集合B
  • 校验用户是否拥有集合B的数据权限

数据权限列数据过滤

  • 提供对简单SQL列预查询过滤
  • 提供对返回结果进行属性进行过滤(Map\List\POJO)

涉及技术

编译环境:

  • JDK:1.8
  • SpringBoot:2.4.0(最低支持) ~ 2.7.8(最高支持)
  • hutool:5.8.12
  • druid:1.2.9(最低支持) ~ 1.2.16(最高支持)
  • mybatis:3.4.5(最低支持) ~ 3.5.11(最高支持)
  • mybatis-spring-boot:2.1.4(最低支持) ~ 3.0.1(最高支持)

其他环境需要自行测试和替换可选依赖部分。

测试环境:

  • junit:4.13.2
  • h2:2.1.214

简单用法

依赖部分

注意依赖使可选项,所以不会主动依赖,建议使用推荐的编译环境的依赖版本号。

<dependency>
    <groupId>com.mofum.scope</groupId>
    <artifactId>scope-mybatis-boot-starter</artifactId>
    <version>2.0.0.RELEASE</version>
</dependency>

以下依赖为【可替换】依赖,如果原环境没有,则需要添加,不会主动依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>${spring-boot.version}</version>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
    <version>${spring-boot.version}</version>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure</artifactId>
    <version>${spring-boot.version}</version>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>${mybatis-spring-boot.version}</version>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>${druid.version}</version>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>cglib</groupId>
    <artifactId>cglib-nodep</artifactId>
    <version>${cglib.version}</version>
    <scope>compile</scope>
</dependency>

代码部分

  1. 基础使用
注解说明:

open-scope 提供了丰富的注解,来支持数据操作。

@SID //范围ID注解:用于指明具体的列信息,该注解优先级高于@SSID @Schema

@SSID //业务ID注解:用于提取业务ID,转换范围ID,认证等操作。注解:该注解优先级高于@Schema

@Scope //范围注解:用于指明返回结果的的列,查询结果的列(只有加了@Scope注解时@SSID才会生效)

@Schema //表注解:用于指明同一查询中的的表名,表别名.

以下是一个简单使用示例 ,具体的使用示例可以看我们配置的 【RuoYi-Vue 示例】:https://gitee.com/mofum/open-scope-demo

@RestController
@Scope //被Scope标记的将会被开启权限范围扫描
@RequestMapping("/scope")
public class ScopeController {
    @Autowired
    ScopeService scopeService;

    @GetMapping("/user/list")
    @Scope //被Scope标记的将会被开启转换器功能 业务ID转范围ID
    @Schema(value = "sys_user", alias = "u") //被Schema注解标记则会填充当前业务ID没有指定的表信息
    @SID("dept_id") //被SID标记则会填充具体的数据列对应关系
    public List<SysUser> userList(@SSID String deptId) { // @SSID表示这是一个业务对象,可以是带有@Scope注解的对象,也可以是List,也可以是Map,还可以是JSON字符串(对象和数组)
        return scopeService.selectList();
    }

    //这是一个没有开启权限范围的方法
    @GetMapping("/user/list2")
    public List<SysUser> userList2() {
        return scopeService.selectList();
    }

}
  1. 编程方式使用
//内置环境,编码调整数据权限
Envs.clear();//清空所有的缓存数据。
SID sid = new SID();
sid.setColumn("test");
sid.setValue("2334");
SID sid2 = new SID();
sid2.setColumn("test");
sid2.setValue("2335");

Envs.addSID(sid);
Envs.addSID(sid2);

//配合SQL重构器来配合其他使用(例如JDBC工具类)
DruidSQLRewriter rewriter = new DruidSQLRewriter();
rewriter.getFormatOption().setPrettyFormat(false);
rewriter.getFormatOption().setUppCase(false);
String newSql = rewriter.rewrite(sql);

注意:Envs是存储了当前的环境变量采用了ThreadLocal,所以当线程不是新创建,而是使用连接池的情况下,请务必手动清除范围ID,具体方法未Envs.clear();Envs.scopeCollections().remove()等。

  1. SQL重写器(默认:DruidSQLRewriter)
@Bean
public SQLRewriter sqlRewriter(SQLCompatibleProcessor sqlCompatibleProcessor) {
    CustomSQLRewriter sqlRewriter = new CustomSQLRewriter();
    sqlRewriter.setCompatibleProcessor(sqlCompatibleProcessor);
    return sqlRewriter;
}
  1. SQL兼容器(QL重写器是:DruidSQLRewriter才会生效)
@Bean
public SQLCompatibleProcessor sqlCompatibleProcessor() {
    return new DruidSQLCompatibleProcessor();
}
  1. 关于规则表达式
<name>-<quidn>
<列名/属性名>-<权限>
q:查询权限
u:更新权限
i:插入权限
d:删除权限
n:无权限
  1. 数据结果SQL列过滤
@Scope 指定 columnRules属性即可

//意思是id没有权限,将被过滤
@Scope(columnRules="id-n")
  1. 数据结果属性过滤
@Scope 指定 propertiesRules属性即可

//意思是属性id没有权限,将被过滤
@Scope(columnRules="id-n")
  1. 编程方式使用过滤
//属性过滤
EnvsRule.addPropertiesRule("prop-n");
//SQL列过滤
EnvsRule.addColumnRule("col-n");
  1. 关于认证器

认证器提供对每一组业务ID,权限ID进行单独校验,你只需要在@SSID注解中指定authenticator或者authenticatorClass即可

authenticator : 取全局环境的配置,如果全局没有,存在Spring环境,则取Spring容器的认证器。
authenticatorClass :静态认证器,通过反射新建认证器进行认证

关于3.0.0 前瞻

3.0.0 OpenScope 将采用更为简洁的方式来实现数据权限管理,并将运行的环境数据通过Caffeine\Redis\关系数据库等管理起来。

联系我们

QQ交流群:1062019634(200人)

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under com.mofum.scope.common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

OpenScope是一种轻量级、易维护的“数据权限”的解决方案,它能处理比较复杂的“数据权限”操作逻辑。兼容Shiro等操作权限框架。 展开 收起
Java
Apache-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/mofum/open-scope.git
git@gitee.com:mofum/open-scope.git
mofum
open-scope
open-scope
master

搜索帮助

14c37bed 8189591 565d56ea 8189591