SpringBoot過濾器獲取POST請(qǐng)求的JSON參數(shù)

項(xiàng)目中需要將每個(gè)請(qǐng)求的路徑和請(qǐng)求參數(shù)以及響應(yīng)結(jié)果，都記錄在日志中，這樣在出現(xiàn)問題時(shí)可以快速定位是哪里出現(xiàn)了問題。

想到了使用過濾器來實(shí)現(xiàn)這個(gè)功能

當(dāng)請(qǐng)求來到過濾器時(shí)，會(huì)有一個(gè)Request參數(shù)，通過該參數(shù)就能獲取到請(qǐng)求路徑和請(qǐng)求參數(shù)，以及相關(guān)內(nèi)容

parameterMap = httpRequest.getParameterMap();
String requestMethod = httpRequest.getMethod();
String remoteAddr = httpRequest.getRemoteAddr();
int remotePort = httpRequest.getRemotePort();

上面的getParameterMap()，只能夠獲取到GET請(qǐng)求的參數(shù)，如果是POST方法傳的JSON那就沒法獲取到，那如何獲取呢，POST的請(qǐng)求是在請(qǐng)求體body中，而POST請(qǐng)求中的body參數(shù)是已流形式存在的

所以我們可以通過獲取到輸入流來獲取body

ServletInputStream inputStream = httpRequest.getInputStream();
InputStreamReader reader = new InputStreamReader(inputStream,StandardCharsets.UTF_8);
BufferedReader bfReader = new BufferedReader(reader);
StringBuilder sb = new StringBuilder();
String line;
while ((line = bfReader.readLine()) != null){
sb.append(line);
}
System.out.println(sb.toString());

通過上面的方法，我們確實(shí)能在過濾器中獲取到POST的JSON參數(shù)了，但是按照上面的方法實(shí)現(xiàn)的過濾器，我們會(huì)發(fā)現(xiàn)，當(dāng)請(qǐng)求經(jīng)過過濾器來到Controller的時(shí)候，請(qǐng)求參數(shù)不見了

可以看到，過濾器確實(shí)拿到JSON參數(shù)，但是接著報(bào)了一個(gè)request body missing的異常，也就是請(qǐng)求來到Controller時(shí)，參數(shù)沒有了，這是為啥呢？我們先去源碼看看，Controller平時(shí)是怎么拿到請(qǐng)求參數(shù)的吧

根據(jù)DeBug，可以看到SpringBoot處理請(qǐng)求的最主要的兩個(gè)方法是上圖紅框的doService和doDisparch方法，上面就是通過反射去獲取參數(shù)名去匹配等

來到invokeForRequest方法，這里面的getMethodArgumentValues，就是SpringBoot獲取請(qǐng)求參數(shù)的入口，進(jìn)入入口后

再經(jīng)過上面的紅框，就能看到SpringBoot獲取POST請(qǐng)求JSON的參數(shù)的真面目了

從源碼我們可以看到

SpringBoot也是通過獲取request的輸入流來獲取參數(shù)，這樣上面的疑問就能解開了，為什么經(jīng)過過濾器來到Controller請(qǐng)求參數(shù)就沒了，這是因?yàn)?InputStream read方法內(nèi)部有一個(gè)，postion，標(biāo)志當(dāng)前流讀取到的位置，每讀取一次，位置就會(huì)移動(dòng)一次，如果讀到最后，InputStream.read方法會(huì)返回-1，標(biāo)志已經(jīng)讀取完了，如果想再次讀取，可以調(diào)用inputstream.reset方法，position就會(huì)移動(dòng)到上次調(diào)用mark的位置，mark默認(rèn)是0，所以就能從頭再讀了。但是呢 是否能reset又是由markSupported決定的，為true能reset，為false就不能reset，從源碼可以看到，markSupported是為false的，而且一調(diào)用reset就是直接異常

所以這也就代表，InputStream只能被讀取一次，后面就讀取不到了。因此我們?cè)谶^濾器的時(shí)候，已經(jīng)將InputStream讀取過了一次，當(dāng)來到Controller，SpringBoot讀取InputStream的時(shí)候自然是什么都讀取不到了

既然InputStream只能讀取一次，那我們可以把InputStream給保存下來，然后完整的傳下去SpringBoot就可以讀取到了，這里就需要用到HttpServletRequest的包裝類HttpServletRequestWrapper了，該類可以自定義一些方法

我們創(chuàng)建一個(gè)類并繼承這個(gè)包裝類

public class RequestWrapper extends HttpServletRequestWrapper {
    private final byte[] body;
    public RequestWrapper(HttpServletRequest request) throws IOException {
        super(request);
        //保存一份InputStream，將其轉(zhuǎn)換為字節(jié)數(shù)組
        body = StreamUtils.copyToByteArray(request.getInputStream());
    }
	//轉(zhuǎn)換成String
    public String getBodyString(){
        return new String(body,StandardCharsets.UTF_8);
    }
    @Override
    public BufferedReader getReader() throws IOException {
        return new BufferedReader(new InputStreamReader(getInputStream()));
    }
	//把保存好的InputStream，傳下去
    @Override
    public ServletInputStream getInputStream() throws IOException {
        final ByteArrayInputStream bais = new ByteArrayInputStream(body);
        return new ServletInputStream() {
            @Override
            public int read() throws IOException {
                return bais.read();
            }
            @Override
            public boolean isFinished() {
                return false;
            }
            @Override
            public boolean isReady() {
                return false;
            }
            @Override
            public void setReadListener(ReadListener readListener) {
            }
        };
    }
}

通過保存一份流，就可實(shí)現(xiàn)在過濾器中能拿到JSON參數(shù)，同時(shí)Controller也不會(huì)丟失參數(shù)

有一點(diǎn)需要注意的

在過濾器放行的時(shí)候，放行的是包裝類和而不是原來的Request

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論