但是不想写重复代码#xff0c;我们可以提供一个通用starter#xff0c;提…1.

在我们日常的Java开发中免不了和其他系统的业务交互或者微服务之间的接口调用

但是不想写重复代码我们可以提供一个通用starter提供通用加密解密功能

前置知识

hutool-crypto提供了很多加密解密工具包括对称加密非对称加密摘要加密等等这不做详细介绍。

2.2

在接口调用链中request的请求流只能调用一次处理之后如果之后还需要用到请求流获取数据就会发现数据为空。

比如使用了filter或者aop在接口处理之前获取了request中的数据对参数进行了校验那么之后就不能在获取request请求流了。

2.2.2

继承HttpServletRequestWrapper将请求中的流copy一份复写getInputStream和getReader方法供外部使用。

每次调用后的getInputStream方法都是从复制出来的二进制数组中进行获取这个二进制数组在对象存在期间一致存在。

使用Filter过滤器在一开始替换request为自己定义的可以多次读取流的request。

InputStreamHttpServletRequestWrapper

package

xyz.hlh.cryptotest.utils;import

org.apache.commons.io.IOUtils;import

import

javax.servlet.ServletInputStream;

import

javax.servlet.http.HttpServletRequest;

import

javax.servlet.http.HttpServletRequestWrapper;

import

InputStreamHttpServletRequestWrapper

extends

InputStreamHttpServletRequestWrapper(HttpServletRequest

request)

{super(request);}Overridepublic

ServletInputStream

CachedServletInputStream(cachedBytes.toByteArray());}Overridepublic

BufferedReader

InputStreamReader(getInputStream()));}/***

首次获取流时将流放入

ByteArrayOutputStream();IOUtils.copy(super.getInputStream(),

cachedBytes);}/***

CachedServletInputStream(byte[]

buf)

ByteArrayInputStream(buf);}Overridepublic

boolean

HttpServletRequestInputStreamFilter

package

xyz.hlh.cryptotest.filter;import

org.springframework.core.annotation.Order;

import

org.springframework.stereotype.Component;

import

xyz.hlh.cryptotest.utils.InputStreamHttpServletRequestWrapper;import

import

javax.servlet.ServletException;

import

javax.servlet.http.HttpServletRequest;

import

org.springframework.core.Ordered.HIGHEST_PRECEDENCE;/***

author

HttpServletRequestInputStreamFilter

implements

转换为可以多次获取流的requestHttpServletRequest

httpServletRequest

request;InputStreamHttpServletRequestWrapper

inputStreamHttpServletRequestWrapper

new

InputStreamHttpServletRequestWrapper(httpServletRequest);//

放行chain.doFilter(inputStreamHttpServletRequestWrapper,

response);}

SpringBoot-validation提供了优雅的参数校验入参都是实体类在实体类字段上加上对应注解就可以在进入方法之前进行参数校验如果参数错误会抛出错误BindException是不会进入方法的。

这种方法必须要求在接口参数上加注解Validated或者是Valid

但是很多清空下我们希望在代码中调用某个实体类的校验功能所以需要如下工具类。

ParamException

xyz.hlh.cryptotest.exception;import

lombok.Getter;import

xyz.hlh.cryptotest.utils;import

xyz.hlh.cryptotest.exception.CustomizeException;

import

xyz.hlh.cryptotest.exception.ParamException;import

javax.validation.ConstraintViolation;

import

Validation.buildDefaultValidatorFactory().getValidator();/***

验证数据*

验证结果异常throwParamException(validate);}/***

验证数据(分组)*

验证结果异常throwParamException(validate);}/***

param

VALIDATOR.validateProperty(object,

propertyName);//

验证结果异常throwParamException(validate);}/***

param

VALIDATOR.validateProperty(object,

propertyName,

验证结果异常throwParamException(validate);}/***

验证结果异常*

throwParamException(SetConstraintViolationObject

validate)

{fieldList.add(next.getPropertyPath().toString());msgList.add(next.getMessage());}throw

new

声明自动配置类把需要对外提供的对象创建好通过配置类统一向外暴露

在resource目录下准备一个名为spring/spring.factories的文件以org.springframework.boot.autoconfigure.EnableAutoConfiguration为key自动配置类为value列表进行注册

2.6

RequestBodyAdvice和ResponseBodyAdvice

RequestBodyAdvice是对请求的json串进行处理

ResponseBodyAdvice是对请求相应的jsoin传进行处理一般用于相应结果的加密

功能介绍

接口入参的时候接收的是解密之后的数据但是在进入接口之前会自动解密取得对应的数据

功能细节

加密解密使用对称加密的AES算法使用hutool-crypto模块进行实现

所有的实体类提取一个公共父类包含属性时间戳用于加密数据返回之后的实效性如果超过60分钟那么其他接口将不进行处理。

如果接口加了加密注解EncryptionAnnotation并且返回统一的json数据Result类则自动对数据进行加密。

如果是继承了统一父类RequestBase的数据自动注入时间戳确保数据的时效性

如果接口加了解密注解DecryptionAnnotation并且参数使用RequestBody注解标注传入json使用统一格式RequestData类并且内容是继承了包含时间长的父类RequestBase则自动解密并且转为对应的数据类型

代码实现

org.springframework.boot.autoconfigure.EnableAutoConfiguration\

xyz.hlh.crypto.config.AppConfig

CryptConfig

org.springframework.boot.context.properties.ConfigurationProperties;

import

org.springframework.context.annotation.Configuration;

import

org.springframework.context.annotation.PropertySource;import

author

PropertySource(classpath:crypto.properties)

Data

cn.hutool.crypto.symmetric.AES;

import

org.springframework.context.annotation.Bean;

import

org.springframework.context.annotation.Configuration;import

import

java.nio.charset.StandardCharsets;/***

author

cryptConfig.getKey().getBytes(StandardCharsets.UTF_8),

cryptConfig.getIv().getBytes(StandardCharsets.UTF_8));}}

请求自动解密

com.fasterxml.jackson.databind.ObjectMapper;

import

org.apache.commons.lang3.StringUtils;

import

org.springframework.beans.factory.annotation.Autowired;

import

org.springframework.core.MethodParameter;

import

org.springframework.http.HttpInputMessage;

import

org.springframework.http.converter.HttpMessageConverter;

import

org.springframework.web.bind.annotation.ControllerAdvice;

import

org.springframework.web.context.request.RequestAttributes;

import

org.springframework.web.context.request.RequestContextHolder;

import

org.springframework.web.context.request.ServletRequestAttributes;

import

org.springframework.web.servlet.mvc.method.annotation.RequestBodyAdvice;

import

xyz.hlh.crypto.annotation.DecryptionAnnotation;

import

xyz.hlh.crypto.common.exception.ParamException;

import

xyz.hlh.crypto.constant.CryptoConstant;

import

xyz.hlh.crypto.entity.RequestBase;

import

xyz.hlh.crypto.entity.RequestData;

import

xyz.hlh.crypto.util.AESUtil;import

javax.servlet.ServletInputStream;

import

javax.servlet.http.HttpServletRequest;

import

方法上有DecryptionAnnotation注解的进入此拦截器*

param

methodParameter.hasMethodAnnotation(DecryptionAnnotation.class);}Overridepublic

HttpInputMessage

beforeBodyRead(HttpInputMessage

inputMessage,

真实的参数*/SneakyThrowsOverridepublic

Object

RequestContextHolder.getRequestAttributes();ServletRequestAttributes

requestAttributes;if

ParamException(request错误);}HttpServletRequest

request

servletRequestAttributes.getRequest();//

inputStream

request.getInputStream();RequestData

requestData

objectMapper.readValue(inputStream,

(requestData

StringUtils.isBlank(requestData.getText()))

{throw

放入解密之前的数据request.setAttribute(CryptoConstant.INPUT_ORIGINAL_DATA,

text);//

(StringUtils.isBlank(decryptText))

{throw

放入解密之后的数据request.setAttribute(CryptoConstant.INPUT_DECRYPT_DATA,

decryptText);//

objectMapper.readValue(decryptText,

body.getClass());//

result).getCurrentTimeMillis();//

有效期

ParamException(String.format(请求参数类型%s

未继承%s,

RequestBase.class.getName()));}}/***

如果body为空转为空对象*

真实的参数*/SneakyThrowsOverridepublic

Object

targetType.getTypeName();Class?

bodyClass

com.fasterxml.jackson.databind.ObjectMapper;

import

org.apache.commons.lang3.StringUtils;

import

org.springframework.beans.factory.annotation.Autowired;

import

org.springframework.core.MethodParameter;

import

org.springframework.http.MediaType;

import

org.springframework.http.ResponseEntity;

import

org.springframework.http.converter.HttpMessageConverter;

import

org.springframework.http.server.ServerHttpRequest;

import

org.springframework.http.server.ServerHttpResponse;

import

org.springframework.web.bind.annotation.ControllerAdvice;

import

org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import

sun.reflect.generics.reflectiveObjects.ParameterizedTypeImpl;

import

xyz.hlh.crypto.annotation.EncryptionAnnotation;

import

xyz.hlh.crypto.common.entity.Result;

import

xyz.hlh.crypto.common.exception.CryptoException;

import

xyz.hlh.crypto.entity.RequestBase;

import

xyz.hlh.crypto.util.AESUtil;import

author

(ParameterizedTypeImpl)returnType.getGenericParameterType();//

(genericParameterType.getRawType()

Result.class

returnType.hasMethodAnnotation(EncryptionAnnotation.class))

{return

(genericParameterType.getRawType()

{return

genericParameterType.getActualTypeArguments())

{if

returnType.hasMethodAnnotation(EncryptionAnnotation.class))

{return

false;}SneakyThrowsOverridepublic

Result?

{((RequestBase)data).setCurrentTimeMillis(System.currentTimeMillis());}String

dataText

(StringUtils.isBlank(dataText))

{return

CryptoException(加密失败数据小于16位);}String

encryptText

AESUtil.encryptHex(dataText);return

Result.builder().status(body.getStatus()).data(encryptText).message(body.getMessage()).build();}

5.4

org.hibernate.validator.constraints.Range;import

javax.validation.constraints.NotBlank;

import

javax.validation.constraints.NotNull;

import

Teacher实体类使用SpringBoot的validation校验*

email

xyz.hlh.crypto.controller;import

org.springframework.http.ResponseEntity;

import

org.springframework.validation.annotation.Validated;

import

org.springframework.web.bind.annotation.PostMapping;

import

org.springframework.web.bind.annotation.RequestBody;

import

org.springframework.web.bind.annotation.RestController;

import

xyz.hlh.crypto.annotation.DecryptionAnnotation;

import

xyz.hlh.crypto.annotation.EncryptionAnnotation;

import

xyz.hlh.crypto.common.entity.Result;

import

xyz.hlh.crypto.common.entity.ResultBuilder;

import

xyz.hlh.crypto.entity.Teacher;/***

author

不加密的对象*/PostMapping(/get)public

get(Validated

ResponseBodyResult格式*/PostMapping(/encrypt)EncryptionAnnotationpublic

encrypt(Validated

Result格式*/PostMapping(/encrypt1)EncryptionAnnotationpublic

Result?

success(teacher).getBody();}/***

param

返回解密后的数据*/PostMapping(/decrypt)DecryptionAnnotationpublic

decrypt(Validated