文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

API数据加密框架monkey-api-encrypt怎么搭建

2023-06-04 08:37

关注

API数据加密框架monkey-api-encrypt怎么搭建,相信很多没有经验的人对此束手无策,为此本文总结了问题出现的原因和解决方法,通过这篇文章希望你能解决这个问题。

下面介绍在Spring Boot中如何对接口的数据进行自动加解密操作,通过注解的方式来指定是否需要加解密。

原理也很简单,通过Spring提供的RequestBodyAdvice和ResponseBodyAdvice就可以对请求响应做处理。

本来也是打算更新一下的,因为在Spring Cloud Zuul中也需要加解密,我的那个封装就用不了。

恰巧上周肥朝大佬跟我聊了下,提供了一些非常有用的建议,于是周六花了一天时间重构了一下加密的框架,不再以Spring Boot Starter的方式提供服务,直接是一个jar包,基于Servlet层面来对数据进行加解密处理。

相比之前的变化:

GitHub地址:https://github.com/yinjihuan/monkey-api-encrypt

示例代码:https://github.com/yinjihuan/monkey-api-encrypt/tree/master/encrypt-springboot-example

monkey-api-encrypt没有发布到Maven中央仓库,只发布到jitpack这个仓库,大家也可以自行下载源码打包传到自己公司的私服上。

自动加解密的好处

传统做法如下:

// 客户端传来的数据就是加密好的字符串public String add(String data) {   // 1. 通过工具类将数据解密,然后序列化成对象使用   // 2. 处理业务逻辑,数据返回的时候用工具类将数据加密返回给客户端}

缺点是在每个业务方法中都要手动的去处理加解密的逻辑。

通过使用monkey-api-encrypt的话可以让开发人员不需要关注加解密的逻辑,比如:

@PostMapping("/save")public UserResult add(@RequestBody User data) {    UserResult  result = new UserResult ();    result.setXXX....    return result;}

上面的代码跟平常写的一模一样,没有加解密的逻辑,需要对数据做加解密逻辑的时候,只需要配置一个过滤器,然后指定哪些URI需要加解密即可。下面来学习下如何使用monkey-api-encrypt。

快速使用

下面以jitpack仓库示列

pom.xml中增加仓库地址

<repositories>  <repository>     <id>jitpack.io</id>     <url>https://jitpack.io</url>  </repository></repositories>

增加项目依赖

<dependency>    <groupId>com.github.yinjihuan</groupId>    <artifactId>monkey-api-encrypt</artifactId>    <version>1.1.1</version></dependency>

配置加解密过滤器(Spring Boot中配置方式)

  1. @Configuration

  2. public class FilterConfig {

  3.    @Bean

  4.    public FilterRegistrationBean<EncryptionFilter> filterRegistration() {

  5.        EncryptionConfig config = new EncryptionConfig();

  6.        config.setKey("abcdef0123456789");

  7.        config.setRequestDecyptUriList(Arrays.asList("/save", "/decryptEntityXml"));

  8.        config.setResponseEncryptUriList(Arrays.asList("/encryptStr", "/encryptEntity", "/save", "/encryptEntityXml", "/decryptEntityXml"));

  9.        FilterRegistrationBean<EncryptionFilter> registration = new FilterRegistrationBean<EncryptionFilter>();

  10.        registration.setFilter(new EncryptionFilter(config));

  11.        registration.addUrlPatterns("

  12.    private String key = "d7b85f6e214abcda";

  13.    

  14.    private List<String> responseEncryptUriList = new ArrayList<String>();

  15.    

  16.    private List<String> requestDecyptUriList = new ArrayList<String>();

  17.    

  18.    private String responseCharset = "UTF-8";

  19.    

  20.    private boolean debug = false;

  21. }

自定义加密算法

内置了AES加密算法对数据进行加解密操作,同时用户可以自定义算法来代替内置的算法。

自定义算法需要实现EncryptAlgorithm接口:

  1. public class RsaEncryptAlgorithm implements EncryptAlgorithm {

  2.    public String encrypt(String content, String encryptKey) throws Exception {

  3.        return RSAUtils.encryptByPublicKey(content);

  4.    }

  5.    public String decrypt(String encryptStr, String decryptKey) throws Exception {

  6.        return RSAUtils.decryptByPrivateKey(encryptStr);

  7.    }

  8. }

注册Filter的时候指定算法:

EncryptionConfig config = new EncryptionConfig();registration.setFilter(new EncryptionFilter(config, new RsaEncryptAlgorithm()));

常见问题

1. Spring Cloud Zuul中如何使用?

使用方式和Spring Boot中一样,没区别。

2. 如果需要所有请求都做加解密处理怎么办?

默认不配置RequestDecyptUriList和ResponseEncryptUriList的情况下,就会对所有请求进行处理(拦截器指定范围内的请求)

3. Swagger测试接口的时候怎么处理?

可以开启调试模式,就不对请求做加解密处理,通过配置debug=true

4. RequestDecyptUriList和ResponseEncryptUriList能否支持/user/*模式匹配?

过滤器本身就有这个功能了,所以框架中是完全匹配相等才可以,可以通过过滤器的 registration.addUrlPatterns("/user/","/order/");来指定需要处理的接口地址。

看完上述内容,你们掌握API数据加密框架monkey-api-encrypt怎么搭建的方法了吗?如果还想学到更多技能或想了解更多相关内容,欢迎关注编程网行业资讯频道,感谢各位的阅读!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     801人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     348人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     311人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     432人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     220人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯