溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
我們與客戶端的接口交互中，為了更高的安全性，我們可能需要對接口加密（請求參數加密，服務端解密）、返回信息加密（服務端加密，客戶端解密），但是也不是所有的接口都這樣，有些接口可能不需要，我們可以使用注解來輕松達到此要求。
將接口參數的加密解密和返回信息的加密解密分開，分別定義注解，利用Controller的ControllerAdvice來攔截所有的請求，在其中判斷是否需要加密解密，即可達到要求。
使用方法：使用 DecryptRequest 和 EncryptResponse 注解即可,可以放在Controller的類和方法上,其中一個為false就不執行了。像這樣：
@RestController
@RequestMapping("/test")
//@DecryptRequest
@EncryptResponse
public class TestController {
@Autowired
@Qualifier("rrCrypto")
private Crypto crypto;
@DecryptRequest(false)
@EncryptResponse(false)
@RequestMapping(value = "/enc" , method = RequestMethod.POST)
public String enc(@RequestBody String body){
return crypto.encrypt(body);
}
}
定義參數解密的注解，DecryptRequest。
/**
* 解密注解
*
* <p>加了此注解的接口(true)將進行數據解密操作(post的body) 可
* 以放在類上，可以放在方法上 </p>
* @author xiongshiyan
*/
@Target({ElementType.METHOD , ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DecryptRequest {
/**
* 是否對body進行解密
*/
boolean value() default true;
}
定義返回信息加密的注解，EncryptResponse。
/**
* 加密注解
*
* <p>加了此注解的接口(true)將進行數據加密操作
* 可以放在類上，可以放在方法上 </p>
* @author 熊詩言
*/
@Target({ElementType.METHOD , ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface EncryptResponse {
/**
* 是否對結果加密
*/
boolean value() default true;
}
這兩個注解可以放在類和方法上，遵循一樣的邏輯，即：類上的注解 && 方法上的注解，一方沒有即為true，都為false為false。邏輯主要在 NeedCrypto 中。
/**
* 判斷是否需要加解密
* @author xiongshiyan at 2018/8/30 , contact me with email yanshixiong@126.com or phone 15208384257
*/
class NeedCrypto {
private NeedCrypto(){}
/**
* 是否需要對結果加密
* 1.類上標注或者方法上標注,并且都為true
* 2.有一個標注為false就不需要加密
*/
static boolean needEncrypt(MethodParameter returnType) {
boolean encrypt = false;
boolean classPresentAnno = returnType.getContainingClass().isAnnotationPresent(EncryptResponse.class);
boolean methodPresentAnno = returnType.getMethod().isAnnotationPresent(EncryptResponse.class);
if(classPresentAnno){
//類上標注的是否需要加密
encrypt = returnType.getContainingClass().getAnnotation(EncryptResponse.class).value();
//類不加密，所有都不加密
if(!encrypt){
return false;
}
}
if(methodPresentAnno){
//方法上標注的是否需要加密
encrypt = returnType.getMethod().getAnnotation(EncryptResponse.class).value();
}
return encrypt;
}
/**
* 是否需要參數解密
* 1.類上標注或者方法上標注,并且都為true
* 2.有一個標注為false就不需要解密
*/
static boolean needDecrypt(MethodParameter parameter) {
boolean encrypt = false;
boolean classPresentAnno = parameter.getContainingClass().isAnnotationPresent(DecryptRequest.class);
boolean methodPresentAnno = parameter.getMethod().isAnnotationPresent(DecryptRequest.class);
if(classPresentAnno){
//類上標注的是否需要解密
encrypt = parameter.getContainingClass().getAnnotation(DecryptRequest.class).value();
//類不加密，所有都不加密
if(!encrypt){
return false;
}
}
if(methodPresentAnno){
//方法上標注的是否需要解密
encrypt = parameter.getMethod().getAnnotation(DecryptRequest.class).value();
}
return encrypt;
}
}
然后定義ControllerAdvice，對于請求解密的，定義 DecryptRequestBodyAdvice ，實現 RequestBodyAdvice 。
/**
* 請求數據接收處理類<br>
*
* 對加了@Decrypt的方法的數據進行解密操作<br>
*
* 只對 @RequestBody 參數有效
* @author xiongshiyan
*/
@ControllerAdvice
@ConditionalOnProperty(prefix = "spring.crypto.request.decrypt", name = "enabled" , havingValue = "true", matchIfMissing = true)
public class DecryptRequestBodyAdvice implements RequestBodyAdvice {
@Value("${spring.crypto.request.decrypt.charset:UTF-8}")
private String charset = "UTF-8";
@Autowired
@Qualifier("rrCrypto")
private Crypto crypto;
@Override
public boolean supports(MethodParameter methodParameter, Type targetType,
Class<? extends HttpMessageConverter<?>> converterType) {
return true;
}
@Override
public Object handleEmptyBody(Object body, HttpInputMessage inputMessage, MethodParameter parameter,
Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
return body;
}
@Override
public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType,
Class<? extends HttpMessageConverter<?>> converterType) throws IOException {
if( NeedCrypto.needDecrypt(parameter) ){
return new DecryptHttpInputMessage(inputMessage , charset , crypto);
}
return inputMessage;
}
@Override
public Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType,
Class<? extends HttpMessageConverter<?>> converterType) {
return body;
}
}
標上注解 ConditionalOnProperty 表示只有條件為true的時候才開啟解密功能，一個配置即可打開或者關閉解密功能。真正的解密邏輯留給 DecryptHttpInputMessage ， 它又委托給 Crypto。
/**
*
* @author xiongshiyan
*/
public class DecryptHttpInputMessage implements HttpInputMessage {
private HttpInputMessage inputMessage;
private String charset;
private Crypto crypto;
public DecryptHttpInputMessage(HttpInputMessage inputMessage, String charset , Crypto crypto) {
this.inputMessage = inputMessage;
this.charset = charset;
this.crypto = crypto;
}
@Override
public InputStream getBody() throws IOException {
String content = IoUtil.read(inputMessage.getBody() , charset);
String decryptBody = crypto.decrypt(content, charset);
return new ByteArrayInputStream(decryptBody.getBytes(charset));
}
@Override
public HttpHeaders getHeaders() {
return inputMessage.getHeaders();
}
}
對于返回值加密，定義 EncryptResponseBodyAdvice，實現 ResponseBodyAdvice。
/**
* 請求響應處理類<br>
*
* 對加了@Encrypt的方法的數據進行加密操作
*
* @author 熊詩言
*
*/
@ControllerAdvice
@ConditionalOnProperty(prefix = "spring.crypto.response.encrypt", name = "enabled" , havingValue = "true", matchIfMissing = true)
public class EncryptResponseBodyAdvice implements ResponseBodyAdvice<Object> {
@Value("${spring.crypto.request.decrypt.charset:UTF-8}")
private String charset = "UTF-8";
@Autowired
@Qualifier("rrCrypto")
private Crypto crypto;
@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
return true;
}
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
boolean encrypt = NeedCrypto.needEncrypt(returnType);
if( !encrypt ){
return body;
}
if(!(body instanceof ResponseMsg)){
return body;
}
//只針對ResponseMsg的data進行加密
ResponseMsg responseMsg = (ResponseMsg) body;
Object data = responseMsg.getData();
if(null == data){
return body;
}
String xx;
Class<?> dataClass = data.getClass();
if(dataClass.isPrimitive() || (data instanceof String)){
xx = String.valueOf(data);
}else {
//JavaBean、Map、List等先序列化
if(List.class.isAssignableFrom(dataClass)){
xx = JsonUtil.serializeList((List<Object>) data);
}else if(Map.class.isAssignableFrom(dataClass)){
xx = JsonUtil.serializeMap((Map<String, Object>) data);
}else {
xx = JsonUtil.serializeJavaBean(data);
}
}
responseMsg.setData(crypto.encrypt(xx, charset));
return responseMsg;
}
}
真正的加密邏輯委托給 Crypto ，這是一個加密解密的接口，有很多實現類，參見：鏈接
/**
* Request-Response加解密體系的加解密方式
* @author xiongshiyan at 2018/8/14 , contact me with email yanshixiong@126.com or phone 15208384257
*/
@Configuration
public class RRCryptoConfig {
/**
* 加密解密方式使用一樣的
*/
@Bean("rrCrypto")
public Crypto rrCrypto(){
return new AesCrypto("密鑰key");
}
}
至此，一個完美的對接口的加密解密就實現了。
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
