4 Star 21 Fork 4

Silwings / quick-transform

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

quick-transform

介绍

这是一款基于SpringBoot的返回值数据处理组件,主要目的是用于数据脱敏等返回数据额外处理操作 1.该组件提供默认的注解和对应的处理策略利用AOP,可以便捷的对一些常见敏感数据进行数据修改操作

2.允许用户添加自定义的处理策略对方法返回值进行便携加工

3.项目地址: 码云: 查看gitee仓库 github: 查看github仓库

安装教程

  1. 该组件已提交到中央仓库,直接引入下面依赖即可

    <dependency>
         <groupId>com.github.Silwings-git</groupId>
         <artifactId>quick-transform-spring-boot-starter</artifactId>
         <version>1.1.0</version>
    </dependency>

版本说明

1.1.0

​ 新增原始数据备份功能

1.0.1
1.0.0

使用说明

1.核心注解说明
  1. @MethodTransform
    1. 添加了该注解的方法会被AOP操作类检测到,并通过该注解指定的strategy的实例进行数据操作
    2. strategy的值必须是实现了TransformStrategy接口的java类,组件中提供了一些常用的实现,用户可以自己定义.
    3. @MethodTransform注解中提供了一个默认值TransformStrategy.class,即strategy需要实现的接口的class,表示不指定任何操作策略.这种情况下会检查方法返回值是否包含一个@Transform注解.如果包含,则按照类中属性上定义的具体注解进行操作
    4. 如果自己指定strategy的值,将不理会返回值上可能存在的@Transform注解,而是按照指定的值的实例进行数据处理.可以理解为实体类上的@Transform及相关注解配置的策略是默认策略.当不通过@MethodTransform注解指定其他处理策略时会使用默认配置,否则使用指定策略
    5. 可以通过execute指定是否需要执行,默认为true表示需要执行
  2. @Transform
    1. 该注解用于在标记当前实体类存在需要处理的属性
    2. 仅仅是作为一个是否需要遍历类属性列表的标识,必须与@MethodTransform或@DataTransform配合使用,在只有该注解的情况下不会有任何效果
    3. 添加该注解的实体类的属性上可以添加@DataTransform及其语义化注解,当该注解被应用时,管理器会对类中属性进行遍历寻找属性上包含的@DataTransform注解.
  3. @DataTransform
    1. 该注解标记需要进行数据处理的属性或方法返回值
    2. @MethodTransform一样,需要且必须指定一个strategy策略来明确数据处理逻辑.
    3. 组件中提供了一些常用的该注解的语义化注解,如有需要可以直接使用语义化注解,而不用去自定义处理策略并指定
    4. 可以通过execute指定是否需要执行,默认为true表示需要执行
2.@DataTransform的语义化注解
  1. @BankCardTransform: 银行卡处理策略,显示前 6 位 + (实际位数) + 后 4 位,如:622575*****1496
  2. @EmailTransform: 邮箱处理策略,展示首个字符和@符号后面的值
  3. @FixedPhoneTransform: 固定电话处理策略,固定电话展示后四位
  4. @IdCardTransform: 身份证处理策略,隐藏出生日期及其前三位
  5. @NameTransform: 名称处理策略,展示姓,隐藏其他
  6. @PasswordTransform: 密码处理策略,8位数星号
  7. @PhoneTransform: 手机号处理策略,隐藏第4-8位,例:138*****245
3.自定义策略
  1. 自定义策略需要实现com.silwings.transform.strategy.TransformStrategy接口

  2. 该接口包含一个T transform(T t);抽象方法,其就是真正执行数据处理的方法.自定义实现类时务必保证该方法的返回值与被指定策略类为当前实现类的方法的返回值类型一致,否则可能发生类型转换异常.

  3. 实现类需要添加@Component注解注入Spring容器才能正常生效.

  4. 使用时直接指定strategy为实现类class即可

  5. 示例:

    1. 自定义实现

      import com.silwings.transform.strategy.TransformStrategy;
      import org.springframework.stereotype.Component;
      
      /**
       * @author Silwings
       * @Classname MyStrategy
       * @Description
       * @Date 2020/11/8
       */
      @Component
      public class MyStrategy implements TransformStrategy<String> {
          @Override
          public String transform(String s) {
              return "自定义字符串" + s;
          }
      }
    2. 使用自定义策略

      import com.silwings.goods.strategy.MyStrategy;
      import com.silwings.transform.annotation.DataTransform;
      import com.silwings.transform.annotation.MethodTransform;
      import org.springframework.web.bind.annotation.GetMapping;
      import org.springframework.web.bind.annotation.RestController;
      
      /**
       * @author Silwings
       * @Classname Demo
       * @Description
       * @Date 2020/11/8
       */
      @RestController
      public class Demo {
      
          @GetMapping("/demo")
          @MethodTransform(strategy = MyStrategy.class)
      //    @DataTransform(strategy = MyStrategy.class)
          public String demo() {
              return "Hello Word";
          }
      
      }
    3. 结果参考

      原结果:Hello Word
      现结果:自定义字符串Hello Word 
4.自定义模糊字符
  1. 组件默认的模糊字符是*,需要时使用等长度的星号字符串对原数据替换
  2. 该组件支持对该默认字符进行自定义修改,在配置文件配置transform.replaceSymbol即可.接收一个字符串,但只有首个字符会被使用
  3. 注意:部分字符在Spring中不支持,如&
5.原始数据备份(1.1.0版本新增)
  1. 原始数据备份默认是关闭状态,开启数据备份后,会将数据转换之前的原始数据备份到线程中(基于ThreadLocal),在之后需要使用原始数据时即可通过工具类获取.
  2. 开启方式:
    1. 全局配置: 在配置文件中添加transform.open-backups,接收布尔类型,true表示开启全局原始数据备份.
    2. 注解配置: @MethodTransform,@Transform,@DataTransform及其语义化注解中均包含backups字段,默认为FOLLOW,表示跟随全局配置.如果需要开启数据备份,设置为OPEN.
    3. 优先级说明:
      1. 注解配置优先级高于全局配置,无论全局如何,只要注解上设置为OPEN,就会执行原始数据备份.注解默认跟随全局配置
      2. 与@MethodTransform相同,当原始数据是实体类,而方法与实体类同时声明了备份设置时,是否备份以方法上的配置为准,如果方法没有配置,才以实体类上的@Transform为准.
  3. 获取/删除备份数据
    1. 数据转换后会返回一个增强后的新数据,需要使用该新数据对象来获取原始数据
    2. 调用工具类TransformUtils的getBackup(T res)即可获取原始数据,res为数据转换后获取到的新数据实例
    3. 调用工具类TransformUtils的removeBackup(T res)即可删除指定数据的原始数据,res为数据转换后获取到的新数据实例
    4. 调用工具类TransformUtils的removeAllBackup()即可删除全部备份数据
  4. 支持的数据类型
    1. 目前只支持基本数据类型(含包装类),String和实体类实例的数据备份,集合数组等类型暂不支持,如果对这些数据类型设置为备份,会在日志提示相关信息,不会导致程序终止,另外也无法获取到备份数据
    2. 备份数据的存储容器是HashMap,所以当存入相同key时,旧的数据会被覆盖,届时会有相关日志提示.
  5. 其他说明
    1. 数据备份是以进入策略类transform(T t)方法的实例为单位的,所以在进行数据备份时是将T t进行备份,实体类中字段上声明的注解的备份配置不会有任何效果
    2. 推荐使用注解的备份配置而不是全局配置,只在需要使用原始数据时才对数据进行备份,避免不必要的开销
    3. 备份数据是存储于线程中的,如果你的线程是长时间存在不会自动关闭的,可以使用TransformUtils相关的方法删除数据,防止出现内存溢出问题

后记:

​ 非常感谢你能看到这里,希望这个小组件对你有所帮助.非常期待您的评论与反馈

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

基于Spring Aop实现的脱敏组件,支持自定义脱敏策略 展开 收起
Java
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/silwings/quick-transform.git
git@gitee.com:silwings/quick-transform.git
silwings
quick-transform
quick-transform
master

搜索帮助