1. 介紹

在我們日常的Java開發中，免不了和其他系統的業務交互，或者微服務之間的接口調用

如果我們想保證數據傳輸的安全，對接口出參加密，入參解密。

但是不想寫重復代碼，我們可以提供一個通用starter，提供通用加密解密功能

基于 Spring Boot + MyBatis Plus + Vue & Element 實現的后臺管理系統 + 用戶小程序，支持 RBAC 動態權限、多租戶、數據權限、工作流、三方登錄、支付、短信、商城等功能

• 項目地址：https://github.com/YunaiV/ruoyi-vue-pro
• 視頻教程：https://doc.iocoder.cn/video/

2. 前置知識

2.1 hutool-crypto加密解密工具

hutool-crypto提供了很多加密解密工具，包括對稱加密，非對稱加密，摘要加密等等，這不做詳細介紹。

2.2 request流只能讀取一次的問題

2.2.1 問題：

在接口調用鏈中，request的請求流只能調用一次，處理之后，如果之后還需要用到請求流獲取數據，就會發現數據為空。

比如使用了filter或者aop在接口處理之前，獲取了request中的數據，對參數進行了校驗，那么之后就不能在獲取request請求流了

2.2.2 解決辦法

繼承HttpServletRequestWrapper，將請求中的流copy一份，復寫getInputStream和getReader方法供外部使用。每次調用后的getInputStream方法都是從復制出來的二進制數組中進行獲取，這個二進制數組在對象存在期間一致存在。

使用Filter過濾器，在一開始，替換request為自己定義的可以多次讀取流的request。

這樣就實現了流的重復獲取

InputStreamHttpServletRequestWrapper

packagexyz.hlh.cryptotest.utils;

importorg.apache.commons.io.IOUtils;

importjavax.servlet.ReadListener;
importjavax.servlet.ServletInputStream;
importjavax.servlet.http.HttpServletRequest;
importjavax.servlet.http.HttpServletRequestWrapper;
importjava.io.BufferedReader;
importjava.io.ByteArrayInputStream;
importjava.io.ByteArrayOutputStream;
importjava.io.IOException;
importjava.io.InputStreamReader;

/**
*請求流支持多次獲取
*/
publicclassInputStreamHttpServletRequestWrapperextendsHttpServletRequestWrapper{

/**
*用于緩存輸入流
*/
privateByteArrayOutputStreamcachedBytes;

publicInputStreamHttpServletRequestWrapper(HttpServletRequestrequest){
super(request);
}

@Override
publicServletInputStreamgetInputStream()throwsIOException{
if(cachedBytes==null){
//首次獲取流時，將流放入緩存輸入流中
cacheInputStream();
}

//從緩存輸入流中獲取流并返回
returnnewCachedServletInputStream(cachedBytes.toByteArray());
}

@Override
publicBufferedReadergetReader()throwsIOException{
returnnewBufferedReader(newInputStreamReader(getInputStream()));
}

/**
*首次獲取流時，將流放入緩存輸入流中
*/
privatevoidcacheInputStream()throwsIOException{
//緩存輸入流以便多次讀取。為了方便, 我使用 org.apache.commons IOUtils
cachedBytes=newByteArrayOutputStream();
IOUtils.copy(super.getInputStream(),cachedBytes);
}

/**
*讀取緩存的請求正文的輸入流
*

*用于根據緩存輸入流創建一個可返回的
*/
publicstaticclassCachedServletInputStreamextendsServletInputStream{

privatefinalByteArrayInputStreaminput;

publicCachedServletInputStream(byte[]buf){
//從緩存的請求正文創建一個新的輸入流
input=newByteArrayInputStream(buf);
}

@Override
publicbooleanisFinished(){
returnfalse;
}

@Override
publicbooleanisReady(){
returnfalse;
}

@Override
publicvoidsetReadListener(ReadListenerlistener){

}

@Override
publicintread()throwsIOException{
returninput.read();
}
}

}

HttpServletRequestInputStreamFilter

packagexyz.hlh.cryptotest.filter;

importorg.springframework.core.annotation.Order;
importorg.springframework.stereotype.Component;
importxyz.hlh.cryptotest.utils.InputStreamHttpServletRequestWrapper;

importjavax.servlet.Filter;
importjavax.servlet.FilterChain;
importjavax.servlet.ServletException;
importjavax.servlet.ServletRequest;
importjavax.servlet.ServletResponse;
importjavax.servlet.http.HttpServletRequest;
importjava.io.IOException;

importstaticorg.springframework.core.Ordered.HIGHEST_PRECEDENCE;

/**
*@authorHLH
*@description:
*請求流轉換為多次讀取的請求流過濾器
*@email17703595860@163.com
*@date:Createdin2022/2/49:58
*/
@Component
@Order(HIGHEST_PRECEDENCE+1)//優先級最高
publicclassHttpServletRequestInputStreamFilterimplementsFilter{

@Override
publicvoiddoFilter(ServletRequestrequest,ServletResponseresponse,FilterChainchain)throwsIOException,ServletException{

//轉換為可以多次獲取流的request
HttpServletRequesthttpServletRequest=(HttpServletRequest)request;
InputStreamHttpServletRequestWrapperinputStreamHttpServletRequestWrapper=newInputStreamHttpServletRequestWrapper(httpServletRequest);

//放行
chain.doFilter(inputStreamHttpServletRequestWrapper,response);
}
}

2.3 SpringBoot的參數校驗validation

為了減少接口中，業務代碼之前的大量冗余的參數校驗代碼

SpringBoot-validation提供了優雅的參數校驗，入參都是實體類，在實體類字段上加上對應注解，就可以在進入方法之前，進行參數校驗，如果參數錯誤，會拋出錯誤BindException，是不會進入方法的。

這種方法，必須要求在接口參數上加注解@Validated或者是@Valid

但是很多清空下，我們希望在代碼中調用某個實體類的校驗功能，所以需要如下工具類

ParamException

packagexyz.hlh.cryptotest.exception;

importlombok.Getter;

importjava.util.List;

/**
*@authorHLH
*@description自定義參數異常
*@email17703595860@163.com
*@dateCreatedin2021/8/10下午10:56
*/
@Getter
publicclassParamExceptionextendsException{

privatefinalListfieldList;
privatefinalListmsgList;

publicParamException(ListfieldList,ListmsgList){
this.fieldList=fieldList;
this.msgList=msgList;
}
}

ValidationUtils

packagexyz.hlh.cryptotest.utils;

importxyz.hlh.cryptotest.exception.CustomizeException;
importxyz.hlh.cryptotest.exception.ParamException;

importjavax.validation.ConstraintViolation;
importjavax.validation.Validation;
importjavax.validation.Validator;
importjava.util.LinkedList;
importjava.util.List;
importjava.util.Set;

/**
*@authorHLH
*@description驗證工具類
*@email17703595860@163.com
*@dateCreatedin2021/8/10下午10:56
*/
publicclassValidationUtils{

privatestaticfinalValidatorVALIDATOR=Validation.buildDefaultValidatorFactory().getValidator();

/**
*驗證數據
*@paramobject數據
*/
publicstaticvoidvalidate(Objectobject)throwsCustomizeException{

Set>validate=VALIDATOR.validate(object);

//驗證結果異常
throwParamException(validate);
}

/**
*驗證數據(分組)
*@paramobject數據
*@paramgroups所在組
*/
publicstaticvoidvalidate(Objectobject,Class...groups)throwsCustomizeException{

Set>validate=VALIDATOR.validate(object,groups);

//驗證結果異常
throwParamException(validate);
}

/**
*驗證數據中的某個字段(分組)
*@paramobject數據
*@parampropertyName字段名稱
*/
publicstaticvoidvalidate(Objectobject,StringpropertyName)throwsCustomizeException{
Set>validate=VALIDATOR.validateProperty(object,propertyName);

//驗證結果異常
throwParamException(validate);

}

/**
*驗證數據中的某個字段(分組)
*@paramobject數據
*@parampropertyName字段名稱
*@paramgroups所在組
*/
publicstaticvoidvalidate(Objectobject,StringpropertyName,Class...groups)throwsCustomizeException{

Set>validate=VALIDATOR.validateProperty(object,propertyName,groups);

//驗證結果異常
throwParamException(validate);

}

/**
*驗證結果異常
*@paramvalidate驗證結果
*/
privatestaticvoidthrowParamException(Set>validate)throwsCustomizeException{
if(validate.size()>0){
ListfieldList=newLinkedList<>();
ListmsgList=newLinkedList<>();
for(ConstraintViolation