【SpringBootStarter】自定义全局加解密组件

【SpringBootStarter】

目的

  1. 了解SpringBoot Starter相关概念以及开发流程
  2. 实现自定义SpringBoot Starter(全局加解密)
  3. 了解测试流程
  4. 优化

最终引用的效果:

<dependency><groupId>com.xbhog</groupId><artifactId>globalValidation-spring-boot-starter</artifactId><version>1.0.0</version>
</dependency>

【开源地址】https://gitee.com/xbhog/encry-adecry-spring-boot-starter;欢迎star

了解SpringBoot Starter相关概念以及开发流程

SpringBoot Starter

SpringBoot Starter作用将一组相关的依赖打包,简化项目的配置和初始化过程,通过特定的Starter开发者可以快速的实现特定功能模块的开发和扩展。

自定义Starter能够促进团队内部资源的复用,保持项目间的一致性,提升协作效率并且有助于构建稳定、高效的大型系统。

开发流程

注入SpringBoot的方式

在刚开始开发Starter的时候,首先考虑的是怎么能注入到SpringBoot中

这部分涉及到部分SpringBoot的自动装配原理,不太清楚的朋友可以补习下;

注入SpringBoot需要配置文件,在项目中的resources资源目录中创建该目录和文件。

demo-spring-boot-starter
└── src└── main└── java└── com.xbhog├── DemoBean.java└── DemoBeanConfig.java└── resources└── META-INF└── spring.factories

spring.factories中我们指定一下自动装配的配置类,格式如下:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.xbhog.DemoBeanConfig
/*** @author xbhog* @describe:*/
@Slf4j
@Configuration
public class DemoBeanConfig {@Beanpublic DemoBean getDemo() {log.info("已经触发了配置类,正在初始化DemoBean...");return new DemoBean();}
}
@Slf4j
public class DemoBean {public void getDemo(){log.info("方法调用成功");}
}

这样就可以将设置的包扫描路径下的相关操作打包到SpringBoot 中。

SpringBoot主类启动器:初始化的操作,感兴趣的朋友可以研究下

完成后,我们可以打包该项目,然后在测试工程红进行Maven的引入、测试。

测试

新建Spring 测试工程,引入依赖:

<dependency><groupId>com.xbhog</groupId><artifactId>demo-spring-boot-starter</artifactId><version>1.0</version>
</dependency>
@RestController
public class BasicController implements ApplicationContextAware {private ApplicationContext applicationContext;/**两种引入方式都可以@Autowiredprivate DemoBean demoBean;*/@GetMapping("/configTest")public void configTest() {DemoBean demoBean = applicationContext.getBean(DemoBean.class);demoBean.getDemo();}@Overridepublic void setApplicationContext(ApplicationContext applicationContext) throws BeansException {this.applicationContext = applicationContext;}
}

请求地址后,可以观察控制台,如下日志表示SpringBoot Starter可以使用了。

到此,一个简单的Starter开发完成了,后续可以围绕工程,根据需求和业务,对通用功能(接口操作日志、异常、加解密、白名单等)进行封装,最后打到Maven仓库中进行使用。

自定义SpringBoot Starter(全局加解密)

来源

在之前金融系统开发中,需要对接多个第三方的服务且数据安全性要求比较高;在接口评审阶段需要双方在数据传输的时候进行接口加解密;起初在第一个服务对接的时候,将相关的加解密操作写到工具类中;随着后续服务的增多,代码的侵入越来越严重。

封装

选择通过Starter进行功能的封装;好处:引用方便,开发迭代方便,团队复用度高且对业务没有侵入。

开发

思路:通过配置文件初始化,让配置类注解@ComponentScan扫描到的Bean等注入到SpringBoot中,通过自定义注解和``RequestBodyAdvice/ResponseBodyAdvice组合拦截请求,在BeforBodyRead/beforeBodyWrite`中进行数据的前置处理,解密后映射到接口接收的字段或对象。

接口上的操作有两种方式:

  1. 注解+AOP实现
  2. 注解+RequestBodyAdvice/ResponseBodyAdvice

这里我选择的第二种的RequestBodyAdvice/ResponseBodyAdvice,抛砖引玉一下。

**【注】**第二种存在的局限性是:只能针对POST请求中的Body数据处理,无法针对GET请求进行处理。

项目结构:

encryAdecry-spring-boot-starter
└── src└── main└── java└── com.xbhog├── advice│   ├──ResponseBodyEncryptAdvice.java│   └──RequestBodyDecryptAdvice.java├── annotation│   └──SecuritySupport├── handler│    ├──impl│    │   └──SecurityHandlerImpl.java│    └──SecurityHandler└── holder│    ├──ContextHolder.java│    ├──EncryAdecryHolder.java│    └──SpringContextHolder.java└──GlobalConfig.java└── resources└── META-INF└── spring.factories

项目处理流程图:

核心代码:

@Override
public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException {log.info("进入【RequestBodyDecryptAdvice】beforeBodyRead的操作,方法:{}",parameter.getMethod());SecuritySupport securitySupport = parameter.getMethodAnnotation(SecuritySupport.class);assert securitySupport != null;ContextHolder.setCryptHolder(securitySupport.securityHandler());String original = IOUtils.toString(inputMessage.getBody(), Charset.defaultCharset());//todolog.info("该流水已插入当前请求流水表");String handler = securitySupport.securityHandler();String plainText = original;if(StringUtils.isNotBlank(handler)){SecurityHandler securityHandler = SpringContextHolder.getBean(handler, SecurityHandler.class);plainText = securityHandler.decrypt(original);}return new MappingJacksonInputMessage(IOUtils.toInputStream(plainText, Charset.defaultCharset()), inputMessage.getHeaders());
}
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {log.info("进入【ResponseBodyEncryptAdvice】beforeBodyWrite的操作,方法:{}",returnType.getMethod());String cryptHandler = ContextHolder.getCryptHandler();SecurityHandler securityHandler = SpringContextHolder.getBean(cryptHandler, SecurityHandler.class);assert body != null;return securityHandler.encrypt(body.toString());
}

Starter中的全局加解密默认采用的国密非对称加密SM2,在开发过程中遇到了该问题InvalidCipherTextException: invalid cipher text

【原因】 私钥和公钥值不是成对存在的,每次调用SmUtil.sm2()会生成不同的随机密钥对。

【解决】在该Starter中采用@PostConstruct修饰方法,在项目运行中只会初始化运行一次该方法,保证了SmUtil.sm2()只会调用一次,不会生成不同的随机秘钥对。

ISSUES#1890】详细请看该地址:https://hub.fgit.cf/dromara/hutool/issues/1890

/*** @author xbhog* @date 2024/02/01 13:23**/
@Slf4j
@Component
public class EncryAdecryHolder {public static SM2 sm2 = null;@PostConstructpublic void encryHolder(){KeyPair pair = SecureUtil.generateKeyPair("SM2");byte[] privateKey = pair.getPrivate().getEncoded();byte[] publicKey = pair.getPublic().getEncoded();log.info("生成的公钥:{}",publicKey);log.info("生成的私钥:{}",privateKey);sm2= SmUtil.sm2(privateKey, publicKey);}
}

除了默认的加密方式,还可以通过SecurityHandler接口进行扩展,扩展出来的impl可以在@SecuritySupport(securityHandler="xxxxxx")中指定。

/*** @author xbhog* @describe: 全局加解密注解* @date 2023/6/8*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SecuritySupport {/*securityHandlerImpl*/String securityHandler() default "securityHandlerImpl";String exceptionResponse() default "";}

测试

复用之前的测试项目,引用打包的mavne依赖:

<dependency><groupId>com.xbhog</groupId><artifactId>encryAdecry-spring-boot-starter</artifactId><version>1.0.0</version>
</dependency>

启动项目,初始化公私钥。


测试接口代码如下:

@Slf4j
@RestController
public class BasicController implements ApplicationContextAware {@Resource(name = "demoSecurityHandlerImpl")private SecurityHandler encryAdecry;private ApplicationContext applicationContext;// http://127.0.0.1:8080/hello?name=lisi//@SecuritySupport(securityHandler = "demoSecurityHandlerImpl")@SecuritySupport@PostMapping("/hello")public String hello(@RequestBody String name) {return "Hello " + name;}@GetMapping("/configTest")public String configTest(@RequestParam("name") String name) {/*DemoBean demoBean = applicationContext.getBean(DemoBean.class);demoBean.getDemo();*/return encryAdecry.encrypt(name);//return MD5.create().digestHex16(name);}
}

优化

优化后的项目结构:

encryAdecry-spring-boot-starter
└── src└── main└── java└── com.xbhog├── advice│   ├──ResponseBodyEncryptAdvice.java│   └──RequestBodyDecryptAdvice.java├── annotation│   └──SecuritySupport├── handler│    ├──impl│    │   └──EncryAdecryImpl.java│    └──SecurityHandler└── holder│    ├──ContextHolder.java│    └──SpringContextHolder.java├──GlobalProperties.java└──GlobalConfig.java└── resources└── META-INF└── spring.factories

增加配置类,用于绑定外部配置(propertiesYAML)到Java对象的的一种机制;

@Data
@ConfigurationProperties(GlobalProperties.PREFIX)
public class GlobalProperties {/*** 默认前缀*/public static final String PREFIX = "encryption.type";/*** 加解密算法*/private String algorithmType;/*** 加解密key值*/private String key;
}

注解修改:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SecuritySupport {/*** 项目默认加解密实现类encryAdecryImpl* */String securityHandler() default "encryAdecryImpl";}

重写Starter默认的加解密方式:

@Slf4j
@Component
public class EncryAdecryImpl implements SecurityHandler {@Resourceprivate GlobalProperties globalProperties;private static volatile SM2 sm2;@Overridepublic String encrypt(String original) {log.info("【starter】具体加密的数据{}",original);return sm2.encryptBase64(original, KeyType.PublicKey);}@Overridepublic String decrypt(String original) {String decryptData = StrUtil.utf8Str(sm2.decryptStr(original, KeyType.PrivateKey));log.info("【starter】具体解密的数据:{}",decryptData);return decryptData;}@PostConstruct@Overridepublic void init() {log.info("======>获取映射的加密算法类型:{}",globalProperties.getAlgorithmType());//传的是加密算法KeyPair pair = SecureUtil.generateKeyPair(globalProperties.getAlgorithmType());byte[] privateKey = pair.getPrivate().getEncoded();byte[] publicKey = pair.getPublic().getEncoded();sm2= SmUtil.sm2(privateKey, publicKey);}
}

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/677592.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

[职场] 大厂群面的基本题型 #学习方法#其他

大厂群面的基本题型 大厂群面的基本题型 群面&#xff0c;又叫做“无领导小组面试”。历年来是企业校招时&#xff0c;进行大批量刷人的有效方法。流行于互联网、快消、银行、四大等多个行业。因为难度大、情况复杂、淘汰率高&#xff0c;又被称为“死亡面试”。 无领导小组…

CSP-202012-2-期末预测之最佳阈值

CSP-202012-2-期末预测之最佳阈值 【70分思路】 本题的难点还是时间复杂度&#xff0c;暴力枚举会导致时间超限。对于每一个可能的阈值theta&#xff0c;代码都重新计算了整个predict数组&#xff0c;统计预测正确的数目&#xff0c;因为有两个嵌套的循环&#xff0c;使得时间…

计算机网络之一

目录 1.因特网概述 1.1网络、互连网&#xff08;互联网&#xff09;和因特网 1.2.因特网发展的三个阶段 1.3基于ISP的三层架构的因特网 1.4.因特网的组成 2.三种交换方式 2.1电路交换 2.2分组交换 1.因特网概述 1.1网络、互连网&#xff08;互联网&#xff09;和因特网…

2024 新年快乐!

亲爱的朋友们 新年快乐&#xff01;在这个辞旧迎新的时刻&#xff0c;我想先感谢大家一直以来的支持和鼓励。作为一个刚刚踏入博客写作领域的新人&#xff0c;我深感自己的渺小和不足&#xff0c;但更感激你们一直以来的陪伴。 虽然开通 CSDN 的时间很久&#xff0c;但是主要…

Git分支常用指令

目录 1 git branch 2 git branch xx 3 git checkout xx 4 git checkout -b xx 5 git branch -d xx 6 git branch -D xx 7 git merge xx(含快进模式和冲突解决的讲解) 注意git-log: 1 git branch 作用&#xff1a;查看分支 示例&#xff1a; 2 git branch xx 作用&a…

docker进阶 问题1

如何使用Docker的容器调试和故障排查工具&#xff1f; Docker提供了一系列强大的工具来帮助开发者调试和排查容器中的问题。以下是一些关键步骤和工具的使用方法&#xff1a; 查看容器日志&#xff1a;使用docker logs [容器ID或名称]命令可以轻松查看容器的标准输出和错误。…

二分查找的应用

递增序列的查找 补充&#xff1a;return -1的解释 #include <iostream> using namespace std; int s[1000]; int search(int str[],int left,int right,int num){while(left<right){//要不断循环查找-while:既可判断&#xff0c;又可循环int mid(leftright)/2;if(num…

数据结构——5.5 树与二叉树的应用

5.5 树与二叉树的应用 概念 结点的权&#xff1a;大小可以表示结点的重要性 结点的带权路径长度&#xff1a;从树的根到该结&#xff0c;的路径长度&#xff08;经过的边数&#xff09;与该结点权的乘积 树的带权路径长度&#xff1a;树中所有叶结点的带权路径长度之和(WPL) …

与AI对话:编写高效Prompt的指南

与AI对话&#xff1a;编写高效Prompt的指南 一、明确目标 引导AI提供特定格式或内容答案的策略一、明确需求二、使用示例三、设置参数四、分步询问五、使用关键词 利用关键词引导AI重点关注核心内容的技巧一、确定关键概念二、使用专业术语三、强调重要性四、避免相关术语的混淆…

蜂鸣器播放提示音音乐(天空之城)

目录 蜂鸣器播放提示音 蜂鸣器播放音乐&#xff08;天空之城&#xff09; 准备工作 主程序 中断函数 上一节讲了蜂鸣器驱动原理和乐理基础知识&#xff0c;这一节开始代码演示&#xff01; 蜂鸣器播放提示音 先创建工程&#xff1a;蜂鸣器播放提示音 把我们之前模块化的…

python 爬虫篇(3)---->Beautiful Soup 网页解析库的使用(包含实例代码)

Beautiful Soup 网页解析库的使用 文章目录 Beautiful Soup 网页解析库的使用前言一、安装Beautiful Soup 和 lxml二、Beautiful Soup基本使用方法标签选择器1 .string --获取文本内容2 .name --获取标签本身名称3 .attrs[] --通过属性拿属性的值标准选择器find_all( name , at…

Springboot使用kafka的两种方式

在Spring Boot中使用Apache Kafka主要有两种方式&#xff1a;使用Spring Kafka项目和使用Spring Boot的spring-boot-starter-kafka。以下是这两种方式的简要概述&#xff1a; 使用Spring Kafka项目 Spring Kafka是Spring官方提供的一个用于Apache Kafka的集成库。虽然它不是一…

Sentinel 源码分析

Sentinel源码分析 项目源码 1.Sentinel的基本概念 Sentinel实现限流、隔离、降级、熔断等功能&#xff0c;本质要做的就是两件事情&#xff1a; 统计数据&#xff1a;统计某个资源的访问数据&#xff08;QPS、RT等信息&#xff09;规则判断&#xff1a;判断限流规则、隔离规…

20240210使用剪映识别字幕的时候的GPU占比RX580-RTX4090

20240210使用剪映识别字幕的时候的GPU占比RX580-RTX4090 2024/2/10 17:54 【使用剪映识别不同的封装格式&#xff0c;不同的音视频编码&#xff0c;对GPU的占用率可能会有比较大的不同&#xff01;】 很容易发现在在WIN10下使用剪映的时候&#xff0c;X99RX550组合。 GPU部分&…

【Spring】Bean 的生命周期

一、Bean 的生命周期 Spring 其实就是一个管理 Bean 对象的工厂&#xff0c;它负责对象的创建&#xff0c;对象的销毁等 所谓的生命周期就是&#xff1a;对象从创建开始到最终销毁的整个过程 什么时候创建 Bean 对象&#xff1f;创建 Bean 对象的前后会调用什么方法&#xf…

os模块

os 模块是 Python 中用于与操作系统进行交互的标准库之一。它提供了许多函数来执行文件和目录操作&#xff0c;管理进程以及与操作系统交互的其他功能。 下面是一些 os 模块中常用的函数和功能&#xff1a; 文件和目录操作&#xff1a; os.getcwd(): 返回当前工作目录的路径。…

【Go】三、Go并发编程

并发编程 我们主流的并发编程思路一般有&#xff1a;多进程、多线程 但这两种方式都需要操作系统介入&#xff0c;进入内核态&#xff0c;是十分大的时间开销 由此而来&#xff0c;一个解决该需求的技术出现了&#xff1a;用户级线程&#xff0c;也叫做 绿程、轻量级线程、协…

大厂的供应链域数据中台设计

关注我&#xff0c;紧跟本系列专栏文章&#xff0c;咱们下篇再续&#xff01; 作者简介&#xff1a;魔都技术专家兼架构&#xff0c;多家大厂后端一线研发经验&#xff0c;各大技术社区头部专家博主&#xff0c;编程严选网创始人。具有丰富的引领团队经验&#xff0c;深厚业务架…

庆除夕,比特币两日大涨10%

号外&#xff1a;教链内参2024年1月合订本 今日除夕。昨日今日两天&#xff0c;比特币从43k发力上攻&#xff0c;一度涨超10%至47.7k&#xff0c;以独特的方式给全世界的bitcoiners送去了新春的祝福。 一个新鲜的知识&#xff1a;2023年12月22日&#xff0c;第78届联合国大会协…

JVM 执行引擎

概念 执行class文件中的指令&#xff0c;由解释器编译器组成 补充——Java为什么是半编译半解释型语言 因为Java即有编译器也有解释器&#xff0c;可以用其中一种来运行。 程序执行步骤 解释器与编译器区别 编译器 概念 JIT&#xff08;Just In Time Compiler&#xff09;…