SpringBoot实现接口数据的加解密功能

2023-08-10 06:06:05 312

一、加密方案介绍

对接口的加密解密操作主要有下面两种方式：

自定义消息转换器

优势：仅需实现接口，配置简单。
劣势：仅能对同一类型的MediaType进行加解密操作，不灵活。

使用spring提供的接口RequestBodyAdvice和ResponseBodyAdvice
优势：可以按照请求的Referrer、Header或url进行判断，按照特定需要进行加密解密。

比如在一个项目升级的时候，新开发功能的接口需要加解密，老功能模块走之前的逻辑不加密，这时候就只能选择上面的第二种方式了，下面主要介绍下第二种方式加密、解密的过程。

二、实现原理

RequestBodyAdvice可以理解为在@RequestBody之前需要进行的操作，ResponseBodyAdvice可以理解为在@ResponseBody之后进行的操作，所以当接口需要加解密时，在使用@RequestBody接收前台参数之前可以先在RequestBodyAdvice的实现类中进行参数的解密，当操作结束需要返回数据时，可以在@ResponseBody之后进入ResponseBodyAdvice的实现类中进行参数的加密。

RequestBodyAdvice处理请求的过程：

RequestBodyAdvice源码如下：

publicinterfaceRequestBodyAdvice{
booleansupports(MethodParametermethodParameter,TypetargetType,
Class>converterType);
HttpInputMessagebeforeBodyRead(HttpInputMessageinputMessage,MethodParameterparameter,
TypetargetType,Class>converterType)throwsIOException;
ObjectafterBodyRead(Objectbody,HttpInputMessageinputMessage,MethodParameterparameter,
TypetargetType,Class>converterType);
@Nullable
ObjecthandleEmptyBody(@NullableObjectbody,HttpInputMessageinputMessage,MethodParameterparameter,
TypetargetType,Class>converterType);
}

调用RequestBodyAdvice实现类的部分代码如下：

protectedObjectreadWithMessageConverters(HttpInputMessageinputMessage,MethodParameterparameter,
TypetargetType)throwsIOException,HttpMediaTypeNotSupportedException,HttpMessageNotReadableException{
MediaTypecontentType;
booleannoContentType=false;
try{
contentType=inputMessage.getHeaders().getContentType();
}
catch(InvalidMediaTypeExceptionex){
thrownewHttpMediaTypeNotSupportedException(ex.getMessage());
}
if(contentType==null){
noContentType=true;
contentType=MediaType.APPLICATION_OCTET_STREAM;
}
ClasscontextClass=parameter.getContainingClass();
ClasstargetClass=(targetTypeinstanceofClass?(Class)targetType:null);
if(targetClass==null){
ResolvableTyperesolvableType=ResolvableType.forMethodParameter(parameter);
targetClass=(Class)resolvableType.resolve();
}
HttpMethodhttpMethod=(inputMessageinstanceofHttpRequest?((HttpRequest)inputMessage).getMethod():null);
Objectbody=NO_VALUE;
EmptyBodyCheckingHttpInputMessagemessage;
try{
message=newEmptyBodyCheckingHttpInputMessage(inputMessage);
for(HttpMessageConverterconverter:this.messageConverters){
Class>converterType=(Class>)converter.getClass();
GenericHttpMessageConvertergenericConverter=
(converterinstanceofGenericHttpMessageConverter?(GenericHttpMessageConverter)converter:null);
if(genericConverter!=null?genericConverter.canRead(targetType,contextClass,contentType):
(targetClass!=null&&converter.canRead(targetClass,contentType))){
if(logger.isDebugEnabled()){
logger.debug("Read["+targetType+"]as\""+contentType+"\"with["+converter+"]");
}
if(message.hasBody()){
HttpInputMessagemsgToUse=
getAdvice().beforeBodyRead(message,parameter,targetType,converterType);
body=(genericConverter!=null?genericConverter.read(targetType,contextClass,msgToUse):
((HttpMessageConverter)converter).read(targetClass,msgToUse));
body=getAdvice().afterBodyRead(body,msgToUse,parameter,targetType,converterType);
}
else{
body=getAdvice().handleEmptyBody(null,message,parameter,targetType,converterType);
}
break;
}
}
}
catch(IOExceptionex){
thrownewHttpMessageNotReadableException("I/Oerrorwhilereadinginputmessage",ex);
}
if(body==NO_VALUE){
if(httpMethod==null||!SUPPORTED_METHODS.contains(httpMethod)||
(noContentType&&!message.hasBody())){
returnnull;
}
thrownewHttpMediaTypeNotSupportedException(contentType,this.allSupportedMediaTypes);
}
returnbody;
}

从上面源码可以到当converter.canRead()和message.hasBody()都为true的时候，会调用beforeBodyRead()和afterBodyRead()方法，所以我们在实现类的afterBodyRead()中添加解密代码即可。

ResponseBodyAdvice处理响应的过程：

ResponseBodyAdvice源码如下：

publicinterfaceResponseBodyAdvice{
booleansupports(MethodParameterreturnType,Class>converterType);
@Nullable
TbeforeBodyWrite(@NullableTbody,MethodParameterreturnType,MediaTypeselectedContentType,
Class>selectedConverterType,
ServerHttpRequestrequest,ServerHttpResponseresponse);
}

调用ResponseBodyAdvice实现类的部分代码如下：

if(selectedMediaType!=null){
selectedMediaType=selectedMediaType.removeQualityValue();
for(HttpMessageConverterconverter:this.messageConverters){
GenericHttpMessageConvertergenericConverter=
(converterinstanceofGenericHttpMessageConverter?(GenericHttpMessageConverter)converter:null);
if(genericConverter!=null?
((GenericHttpMessageConverter)converter).canWrite(declaredType,valueType,selectedMediaType):
converter.canWrite(valueType,selectedMediaType)){
outputValue=(T)getAdvice().beforeBodyWrite(outputValue,returnType,selectedMediaType,
(Class>)converter.getClass(),
inputMessage,outputMessage);
if(outputValue!=null){
addContentDispositionHeader(inputMessage,outputMessage);
if(genericConverter!=null){
genericConverter.write(outputValue,declaredType,selectedMediaType,outputMessage);
}
else{
((HttpMessageConverter)converter).write(outputValue,selectedMediaType,outputMessage);
}
if(logger.isDebugEnabled()){
logger.debug("Written["+outputValue+"]as\""+selectedMediaType+
"\"using["+converter+"]");
}
}
return;
}
}
}

从上面源码可以到当converter.canWrite()为true的时候，会调用beforeBodyWrite()方法，所以我们在实现类的beforeBodyWrite()中添加解密代码即可。

三、实战

新建一个springboot项目spring-boot-encry，按照下面步骤操作。

pom.xml中引入jar



org.springframework.boot
spring-boot-starter-web



org.projectlombok
lombok
true


org.springframework.boot
spring-boot-starter-test
test


org.junit.vintage
junit-vintage-engine





com.alibaba
fastjson
1.2.60

请求参数解密拦截类

DecryptRequestBodyAdvice代码如下：

/**
*请求参数解密操作
**@Author:Java碎碎念
*@Date:2019/10/2421:31
*
*/
@Component
@ControllerAdvice(basePackages="com.example.springbootencry.controller")
@Slf4j
publicclassDecryptRequestBodyAdviceimplementsRequestBodyAdvice{
@Override
publicbooleansupports(MethodParametermethodParameter,TypetargetType,Class>converterType){
returntrue;
}
@Override
publicHttpInputMessagebeforeBodyRead(HttpInputMessageinputMessage,MethodParametermethodParameter,TypetargetType,Class>selectedConverterType)throwsIOException{
returninputMessage;
}
@Override
publicObjectafterBodyRead(Objectbody,HttpInputMessageinputMessage,MethodParameterparameter,TypetargetType,Class>converterType){
StringdealData=null;
try{
//解密操作
MapdataMap=(Map)body;
StringsrcData=dataMap.get("data");
dealData=DesUtil.decrypt(srcData);
}catch(Exceptione){
log.error("异常！",e);
}
returndealData;
}
@Override
publicObjecthandleEmptyBody(@NullableObjectvar1,HttpInputMessagevar2,MethodParametervar3,Typevar4,Class>var5){
log.info("3333");
returnvar1;
}
}

响应参数加密拦截类

EncryResponseBodyAdvice代码如下：

/**
*请求参数解密操作
*
*@Author:Java碎碎念
*@Date:2019/10/2421:31
*
*/
@Component
@ControllerAdvice(basePackages="com.example.springbootencry.controller")
@Slf4j
publicclassEncryResponseBodyAdviceimplementsResponseBodyAdvice

SpringBoot实现接口数据的加解密功能

一、加密方案介绍

二、实现原理

三、实战

四、测试

五、踩到的坑

随机推荐

SpringBoot实现接口数据的加解密功能

一、加密方案介绍

二、实现原理

三、实战

四、测试

五、踩到的坑

热门推荐

随机推荐