经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » Java相关 » Spring Boot » 查看文章
SpringBoot中如何实现接口数据的加解密功能？
来源：cnblogs　　作者：java_lover　　时间：2019/10/28 11:28:49　　对本文有异议

数据是企业的第四张名片，企业级开发中少不了数据的加密传输，所以本文介绍下SpringBoot中接口数据加密、解密的方式。

一、加密方案介绍

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

自定义消息转换器

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

使用spring提供的接口RequestBodyAdvice和ResponseBodyAdvice

优势：可以按照请求的Referrer、Header或url进行判断，按照特定需要进行加密解密。

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

二、实现原理

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

RequestBodyAdvice处理请求的过程：

RequestBodyAdvice源码如下：

  1.  public interface RequestBodyAdvice {
  2.  
  3.     boolean supports(MethodParameter methodParameter, Type targetType,
  4.             Class<? extends HttpMessageConverter<?>> converterType);
  5.  
  6.  
  7.     HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter,
  8.             Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException;
  9.  
  10.  
  11.     Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter,
  12.             Type targetType, Class<? extends HttpMessageConverter<?>> converterType);
  13.  
  14.  
  15.     @Nullable
  16.     Object handleEmptyBody(@Nullable Object body, HttpInputMessage inputMessage, MethodParameter parameter,
  17.             Type targetType, Class<? extends HttpMessageConverter<?>> converterType);
  18.  
  19.  
  20. }

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

  1.       for (HttpMessageConverter<?> converter : this.messageConverters) {
  2.                 Class<HttpMessageConverter<?>> converterType = (Class<HttpMessageConverter<?>>) converter.getClass();
  3.                 GenericHttpMessageConverter<?> genericConverter =
  4.                         (converter instanceof GenericHttpMessageConverter ? (GenericHttpMessageConverter<?>) converter : null);
  5.                 if (genericConverter != null ? genericConverter.canRead(targetType, contextClass, contentType) :
  6.                         (targetClass != null && converter.canRead(targetClass, contentType))) {
  7.                     if (logger.isDebugEnabled()) {
  8.                         logger.debug("Read [" + targetType + "] as \"" + contentType + "\" with [" + converter + "]");
  9.                     }
  10.                     if (message.hasBody()) {
  11.                         HttpInputMessage msgToUse =
  12.                                 getAdvice().beforeBodyRead(message, parameter, targetType, converterType);
  13.                         body = (genericConverter != null ? genericConverter.read(targetType, contextClass, msgToUse) :
  14.                                 ((HttpMessageConverter<T>) converter).read(targetClass, msgToUse));
  15.                         body = getAdvice().afterBodyRead(body, msgToUse, parameter, targetType, converterType);
  16.                     }
  17.                     else {
  18.                         body = getAdvice().handleEmptyBody(null, message, parameter, targetType, converterType);
  19.                     }
  20.                     break;
  21.                 }
  22.             }
  23.         }
  24.         catch (IOException ex) {
  25.             throw new HttpMessageNotReadableException("I/O error while reading input message", ex);
  26.         }
  27.  
  28.         if (body == NO_VALUE) {
  29.             if (httpMethod == null || !SUPPORTED_METHODS.contains(httpMethod) ||
  30.                     (noContentType && !message.hasBody())) {
  31.                 return null;
  32.             }
  33.             throw new HttpMediaTypeNotSupportedException(contentType, this.allSupportedMediaTypes);
  34.         }
  35.  
  36.         return body;
  37.     }

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

ResponseBodyAdvice处理响应的过程：

ResponseBodyAdvice源码如下：

  1. public interface ResponseBodyAdvice<T> {
  2.  
  3.  
  4.     boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType);
  5.  
  6.  
  7.     @Nullable
  8.     T beforeBodyWrite(@Nullable T body, MethodParameter returnType, MediaType selectedContentType,
  9.             Class<? extends HttpMessageConverter<?>> selectedConverterType,
  10.             ServerHttpRequest request, ServerHttpResponse response);
  11.  
  12. }

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

  1. if (selectedMediaType != null) {
  2.             selectedMediaType = selectedMediaType.removeQualityValue();
  3.             for (HttpMessageConverter<?> converter : this.messageConverters) {
  4.                 GenericHttpMessageConverter genericConverter =
  5.                         (converter instanceof GenericHttpMessageConverter ? (GenericHttpMessageConverter<?>) converter : null);
  6.                 if (genericConverter != null ?
  7.                         ((GenericHttpMessageConverter) converter).canWrite(declaredType, valueType, selectedMediaType) :
  8.                         converter.canWrite(valueType, selectedMediaType)) {
  9.                     outputValue = (T) getAdvice().beforeBodyWrite(outputValue, returnType, selectedMediaType,
  10.                             (Class<? extends HttpMessageConverter<?>>) converter.getClass(),
  11.                             inputMessage, outputMessage);
  12.                     if (outputValue != null) {
  13.                         addContentDispositionHeader(inputMessage, outputMessage);
  14.                         if (genericConverter != null) {
  15.                             genericConverter.write(outputValue, declaredType, selectedMediaType, outputMessage);
  16.                         }
  17.                         else {
  18.                             ((HttpMessageConverter) converter).write(outputValue, selectedMediaType, outputMessage);
  19.                         }
  20.                         if (logger.isDebugEnabled()) {
  21.                             logger.debug("Written [" + outputValue + "] as \"" + selectedMediaType +
  22.                                     "\" using [" + converter + "]");
  23.                         }
  24.                     }
  25.                     return;
  26.                 }
  27.             }
  28.         }

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

三、实战

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

  1. pom.xml中引入jar

  1.   <dependencies>
  2.         <dependency>
  3.             <groupId>org.springframework.boot</groupId>
  4.             <artifactId>spring-boot-starter-web</artifactId>
  5.         </dependency>
  6.  
  7.         <dependency>
  8.             <groupId>org.projectlombok</groupId>
  9.             <artifactId>lombok</artifactId>
  10.             <optional>true</optional>
  11.         </dependency>
  12.         <dependency>
  13.             <groupId>org.springframework.boot</groupId>
  14.             <artifactId>spring-boot-starter-test</artifactId>
  15.             <scope>test</scope>
  16.             <exclusions>
  17.                 <exclusion>
  18.                     <groupId>org.junit.vintage</groupId>
  19.                     <artifactId>junit-vintage-engine</artifactId>
  20.                 </exclusion>
  21.             </exclusions>
  22.         </dependency>
  23.  
  24.         <dependency>
  25.             <groupId>com.alibaba</groupId>
  26.             <artifactId>fastjson</artifactId>
  27.             <version>1.2.60</version>
  28.         </dependency>
  29.     </dependencies>

  1. 请求参数解密拦截类

DecryptRequestBodyAdvice代码如下：

  1. /**
  2.  * 请求参数 解密操作
  3.  *
  4.  * @Author: Java碎碎念
  5.  * @Date: 2019/10/24 21:31
  6.  *
  7.  */
  8. @Component
  9. @ControllerAdvice(basePackages = "com.example.springbootencry.controller")
  10. @Slf4j
  11. public class DecryptRequestBodyAdvice implements RequestBodyAdvice {
  12.  
  13.  
  14.     @Override
  15.     public boolean supports(MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
  16.         return true;
  17.     }
  18.  
  19.     @Override
  20.     public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> selectedConverterType) throws IOException {
  21.         return inputMessage;
  22.     }
  23.  
  24.     @Override
  25.     public Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
  26.         String dealData = null;
  27.         try {
  28.             //解密操作
  29.             Map<String,String> dataMap = (Map)body;
  30.             String srcData = dataMap.get("data");
  31.             dealData = DesUtil.decrypt(srcData);
  32.         } catch (Exception e) {
  33.             log.error("异常！", e);
  34.         }
  35.         return dealData;
  36.     }
  37.  
  38.  
  39.     @Override
  40.     public Object handleEmptyBody(@Nullable Object var1, HttpInputMessage var2, MethodParameter var3, Type var4, Class<? extends HttpMessageConverter<?>> var5) {
  41.         log.info("3333");
  42.         return var1;
  43.     }
  44.  
  45.  
  46. }

  1. 响应参数加密拦截类

EncryResponseBodyAdvice代码如下：

  1. /**
  2.  * 请求参数 解密操作
  3.  *
  4.  * @Author: Java碎碎念
  5.  * @Date: 2019/10/24 21:31
  6.  *
  7.  */
  8. @Component
  9. @ControllerAdvice(basePackages = "com.example.springbootencry.controller")
  10. @Slf4j
  11. public class EncryResponseBodyAdvice implements ResponseBodyAdvice<Object> {
  12.  
  13.  
  14.     @Override
  15.     public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
  16.         return true;
  17.     }
  18.  
  19.     @Override
  20.     public Object beforeBodyWrite(Object obj, MethodParameter returnType, MediaType selectedContentType,
  21.                                   Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest serverHttpRequest,
  22.                                   ServerHttpResponse serverHttpResponse) {
  23.         //通过 ServerHttpRequest的实现类ServletServerHttpRequest 获得HttpServletRequest
  24.         ServletServerHttpRequest sshr = (ServletServerHttpRequest) serverHttpRequest;
  25.         //此处获取到request 是为了取到在拦截器里面设置的一个对象 是我项目需要,可以忽略
  26.         HttpServletRequest request = sshr.getServletRequest();
  27.  
  28.         String returnStr = "";
  29.  
  30.         try {
  31.             //添加encry header，告诉前端数据已加密
  32.             serverHttpResponse.getHeaders().add("encry", "true");
  33.             String srcData = JSON.toJSONString(obj);
  34.             //加密
  35.             returnStr = DesUtil.encrypt(srcData);
  36.             log.info("接口={},原始数据={},加密后数据={}", request.getRequestURI(), srcData, returnStr);
  37.  
  38.         } catch (Exception e) {
  39.             log.error("异常！", e);
  40.         }
  41.         return returnStr;
  42.     }

  1. 新建controller类

TestController代码如下：

  1. /**
  2.  * @Author: Java碎碎念
  3.  * @Date: 2019/10/24 21:40
  4.  */
  5. @RestController
  6. public class TestController {
  7.  
  8.     Logger log = LoggerFactory.getLogger(getClass());
  9.  
  10.     /**
  11.      * 响应数据 加密
  12.      */
  13.     @RequestMapping(value = "/sendResponseEncryData")
  14.     public Result sendResponseEncryData() {
  15.         Result result = Result.createResult().setSuccess(true);
  16.         result.setDataValue("name", "Java碎碎念");
  17.         result.setDataValue("encry", true);
  18.         return result;
  19.     }
  20.  
  21.     /**
  22.      * 获取 解密后的 请求参数
  23.      */
  24.     @RequestMapping(value = "/getRequestData")
  25.     public Result getRequestData(@RequestBody Object object) {
  26.         log.info("controller接收的参数object={}", object.toString());
  27.         Result result = Result.createResult().setSuccess(true);
  28.         return result;
  29.     }
  30. }

  1. 其他类在源码中，后面有github地址

四、测试

  1. 访问响应数据加密接口

使用postman发请求http://localhost:8888/sendResponseEncryData，可以看到返回数据已加密，请求截图如下：


响应数据加密截图

后台也打印相关的日志，内容如下：

  1. 接口=/sendResponseEncryData
  2.  
  3. 原始数据={"data":{"encry":true,"name":"Java碎碎念"},"success":true}
  4.  
  5. 加密后数据=vJc26g3SQRU9gAJdG7rhnAx6Ky/IhgioAgdwi6aLMMtyynAB4nEbMxvDsKEPNIa5bQaT7ZAImAL7
  6. 3VeicCuSTA==

  1. 访问请求数据解密接口

使用postman发请求http://localhost:8888/getRequestData，可以看到请求数据已解密，请求截图如下：


请求数据解密截图

后台也打印相关的日志，内容如下：

  1. 接收到原始请求数据={"data":"VwLvdE8N6FuSxn/jRrJavATopaBA3M1QEN+9bkuf2jPwC1eSofgahQ=="}
  2.  
  3. 解密后数据={"name":"Java碎碎念","des":"请求参数"}

五、踩到的坑

  1. 测试解密请求参数时候，请求体一定要有数据，否则不会调用实现类触发解密操作。

到此SpringBoot中如何灵活的实现接口数据的加解密功能的功能已经全部实现，有问题欢迎留言沟通哦！

完整源码地址： https://github.com/suisui2019/springboot-study

原文链接：http://www.cnblogs.com/haha12/p/11750533.html

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

Spring Boot热门文章

  • 史上最详 Thymeleaf 使用教程
  • Spring Boot如何通过java -jar启动
  • Spring Boot 2.x（六）：优雅的统一返回值
  • Springboot使用Logback实现日志配置与异常记录
  • 使用SpringBoot+EasyExcel+Vue实现excel表格的导入和导出详解
  • spring boot上传文件超出大小异常无法捕获问题
  • paging组件的用法和意义
  • springboot2.0集成rabbitmq的示例代码
  • Spring MVC学习step1——框架熟悉
  • spring boot ${}占位符不起作用的解决方案

    • Spring Boot推荐文章

  • 3分钟带你搞定Spring Boot中Schedule
  • 不单独部署注册中心，又要具备注册中心的功能，我能上天！
  • 从零开始学Spring Boot系列-集成Spring Security实现用户认证与授权
  • 不单独部署注册中心，又要具备注册中心的功能，咋不让我上天？
  • EasyExcel 无法读取图片？用poi写了一个工具类
  • 【进阶篇】使用 Stream 流对比两个集合的常用操作分享
  • 关于DDD和COLA的一些总结和思考
  • SnakeYaml反序列化分析
  • RestTemplate进行https请求时适配信任证书
  • Kryo反序列化链分析

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号