1. 介紹

在我們?nèi)粘５?a href="http://m.1cnz.cn/v/tag/852/" target="_blank">Java開發(fā)中，免不了和其他系統(tǒng)的業(yè)務(wù)交互，或者微服務(wù)之間的接口調(diào)用

如果我們想保證數(shù)據(jù)傳輸?shù)陌踩瑢?duì)接口出參加密，入?yún)⒔饷堋?/p>

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

基于 Spring Boot + MyBatis Plus + Vue & Element 實(shí)現(xiàn)的后臺(tái)管理系統(tǒng) + 用戶小程序，支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

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

2. 前置知識(shí)

2.1 hutool-crypto加密解密工具

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

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

2.2.1 問題：

在接口調(diào)用鏈中，request的請(qǐng)求流只能調(diào)用一次，處理之后，如果之后還需要用到請(qǐng)求流獲取數(shù)據(jù)，就會(huì)發(fā)現(xiàn)數(shù)據(jù)為空。

比如使用了filter或者aop在接口處理之前，獲取了request中的數(shù)據(jù)，對(duì)參數(shù)進(jìn)行了校驗(yàn)，那么之后就不能在獲取request請(qǐng)求流了

2.2.2 解決辦法

繼承HttpServletRequestWrapper，將請(qǐng)求中的流copy一份，復(fù)寫getInputStream和getReader方法供外部使用。每次調(diào)用后的getInputStream方法都是從復(fù)制出來的二進(jìn)制數(shù)組中進(jìn)行獲取，這個(gè)二進(jìn)制數(shù)組在對(duì)象存在期間一致存在。

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

這樣就實(shí)現(xiàn)了流的重復(fù)獲取

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;

/**
*請(qǐng)求流支持多次獲取
*/
publicclassInputStreamHttpServletRequestWrapperextendsHttpServletRequestWrapper{

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

publicInputStreamHttpServletRequestWrapper(HttpServletRequestrequest){
super(request);
}

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

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

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

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

/**
*讀取緩存的請(qǐng)求正文的輸入流
*

*用于根據(jù)緩存輸入流創(chuàng)建一個(gè)可返回的
*/
publicstaticclassCachedServletInputStreamextendsServletInputStream{

privatefinalByteArrayInputStreaminput;

publicCachedServletInputStream(byte[]buf){
//從緩存的請(qǐng)求正文創(chuàng)建一個(gè)新的輸入流
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:
*請(qǐng)求流轉(zhuǎn)換為多次讀取的請(qǐng)求流過濾器
*@email17703595860@163.com
*@date:Createdin2022/2/49:58
*/
@Component
@Order(HIGHEST_PRECEDENCE+1)//優(yōu)先級(jí)最高
publicclassHttpServletRequestInputStreamFilterimplementsFilter{

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

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

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

2.3 SpringBoot的參數(shù)校驗(yàn)validation

為了減少接口中，業(yè)務(wù)代碼之前的大量冗余的參數(shù)校驗(yàn)代碼

SpringBoot-validation提供了優(yōu)雅的參數(shù)校驗(yàn)，入?yún)⒍际菍?shí)體類，在實(shí)體類字段上加上對(duì)應(yīng)注解，就可以在進(jìn)入方法之前，進(jìn)行參數(shù)校驗(yàn)，如果參數(shù)錯(cuò)誤，會(huì)拋出錯(cuò)誤BindException，是不會(huì)進(jìn)入方法的。

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

但是很多清空下，我們希望在代碼中調(diào)用某個(gè)實(shí)體類的校驗(yàn)功能，所以需要如下工具類

ParamException

packagexyz.hlh.cryptotest.exception;

importlombok.Getter;

importjava.util.List;

/**
*@authorHLH
*@description自定義參數(shù)異常
*@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驗(yàn)證工具類
*@email17703595860@163.com
*@dateCreatedin2021/8/10下午10:56
*/
publicclassValidationUtils{

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

/**
*驗(yàn)證數(shù)據(jù)
*@paramobject數(shù)據(jù)
*/
publicstaticvoidvalidate(Objectobject)throwsCustomizeException{

Set>validate=VALIDATOR.validate(object);

//驗(yàn)證結(jié)果異常
throwParamException(validate);
}

/**
*驗(yàn)證數(shù)據(jù)(分組)
*@paramobject數(shù)據(jù)
*@paramgroups所在組
*/
publicstaticvoidvalidate(Objectobject,Class...groups)throwsCustomizeException{

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

//驗(yàn)證結(jié)果異常
throwParamException(validate);
}

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

//驗(yàn)證結(jié)果異常
throwParamException(validate);

}

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

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

//驗(yàn)證結(jié)果異常
throwParamException(validate);

}

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