快捷導(dǎo)航

解決java攔截器獲取POST入?yún)?dǎo)致@RequestBody參數(shù)丟失問題

更新時(shí)間：2024年11月12日 09:22:32 作者：阿小冰

文章講述了在Java開發(fā)中使用攔截器獲取POST請(qǐng)求入?yún)r(shí),由于流關(guān)閉導(dǎo)致`@RequestBody`參數(shù)丟失的問題,并提出了一種解決方案,解決方案包括自定義方法、防止流丟失、過濾器和攔截器的合理組織和使用,最終確保了參數(shù)的正確傳遞

java攔截器獲取POST入?yún)?dǎo)致@RequestBody參數(shù)丟失

在java開發(fā)中，攔截器的使用還是比較廣泛的，例如：限制ip、接口校驗(yàn)、用戶權(quán)限校驗(yàn)等等，大多首選都是使用攔截器，在正式請(qǐng)求接口之前先做一層校驗(yàn)，保證接口服務(wù)一定程度上的安全和可靠性

但是小冰在使用攔截器獲取json入?yún)⒌臅r(shí)候，遇到一個(gè)問題，那就是攔截器獲取一般都是用流的方式獲取，一般都是能獲取到的，但是會(huì)引發(fā)另外一個(gè)問題：

攔截器相關(guān)校驗(yàn)走完之后，接口層的@RequestBody修飾的對(duì)象參數(shù)都會(huì)失效，并且調(diào)試之后釋放會(huì)報(bào)錯(cuò)

org.springframework.http.converter.HttpMessageNotReadableException: I/O error while reading input message; nested exception is java.io.IOException: Stream closed

因?yàn)樾”昧肆?，并且存在流關(guān)閉，一次請(qǐng)求流關(guān)閉了就只能讀取一次，所以到controller接口層就會(huì)報(bào)錯(cuò)，流的這個(gè)報(bào)錯(cuò)的意思就是：大哥，我都關(guān)門了，你還來找我干嘛，滾！

解決方案

于是找度娘，搜了一波，發(fā)現(xiàn)大多數(shù)處理方案都是相關(guān)報(bào)錯(cuò)，于是總結(jié)了一個(gè)小冰解決了問題的方案，如下：

思路：不管流關(guān)沒關(guān)閉，要把流中的參數(shù)，延伸到后面的接口去用就可以了
需要的組織：過濾器大哥、攔截器大哥、防流失大哥、過濾器Bean大哥還有一個(gè)自定義方法小弟
立馬上車出發(fā)：

首先上車的是：自定義方法小弟(用來獲取參數(shù)-HttpRequestHelper)

/**
 * @description: 獲取流并將想要的結(jié)果通過拼接返回
 **/
public class HttpRequestHelper {
    public static String getBodyString(HttpServletRequest request) throws IOException {
        StringBuilder sb = new StringBuilder();
        InputStream inputStream = null;
        BufferedReader reader = null;
        try {
            inputStream = request.getInputStream();
            reader = new BufferedReader(new InputStreamReader(inputStream, Charset.forName("UTF-8")));
            String line = "";
            while ((line = reader.readLine()) != null) {
                sb.append(line);
            }
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (inputStream != null) {
                try {
                    inputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
            if (reader != null) {
                try {
                    reader.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        return sb.toString();
    }
}

其次是：防流失大哥(防止流讀取完之后就丟失了-MyRequestWrapper)

/**
 * @description: 防止流丟失
 **/
public class MyRequestWrapper extends HttpServletRequestWrapper {
    private final byte[] body;

    public MyRequestWrapper(HttpServletRequest request) throws IOException {
        super(request);
        //返回參數(shù)字節(jié)數(shù)組
        body = HttpRequestHelper.getBodyString(request).getBytes(Charset.forName("UTF-8"));
    }

    @Override
    public BufferedReader getReader() throws IOException {
        return new BufferedReader(new InputStreamReader(getInputStream()));
    }

    @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ù)據(jù)續(xù)傳-HttpServletRequestFilter)

/**
 * @description: 使用過濾器處理流，將當(dāng)前流放到一個(gè)新的request對(duì)象中
 **/
public class HttpServletRequestFilter implements Filter {
    @Override
    public void destroy() {

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
                         FilterChain chain) throws IOException, ServletException {
        ServletRequest requestWrapper = null;
        if (request instanceof HttpServletRequest) {
            requestWrapper = new MyRequestWrapper((HttpServletRequest) request);
        }
        //獲取請(qǐng)求中的流如何，將取出來的字符串，再次轉(zhuǎn)換成流，然后把它放入到新request對(duì)象中。
        // 在chain.doFiler方法中傳遞新的request對(duì)象
        if (requestWrapper == null) {
            chain.doFilter(request, response);
        } else {
            chain.doFilter(requestWrapper, response);
        }
    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {

    }
}

最后是：攔截器大哥(獲取流數(shù)據(jù)讀取入?yún)?只是代碼片段)

//放到繼承HandlerInterceptor的類下的preHandle方法中指定業(yè)務(wù)位置就行啦，這里讀出來的string，
//這里我處理為一個(gè)json(就是入?yún)?duì)象的各個(gè)字段和字段值)，方便操作
//構(gòu)造函數(shù)的httpServletRequest參數(shù)是preHandle方法的request入?yún)?
JSONObject.parseObject(HttpRequestHelper.getBodyString(httpServletRequest));

然后運(yùn)行，由于各位大哥就先走了，發(fā)現(xiàn)還是不對(duì)勁，好像丟了個(gè)司機(jī)，于是一回頭一看，最牛的司機(jī)大哥還沒上車，這是哪位大哥？答：過濾器Bean大哥

司機(jī)大哥：過濾器Bean大哥(將上面的過濾器大哥放在副駕上(在springboot的啟動(dòng)類中注入過濾器))

    @Bean
    public FilterRegistrationBean httpServletRequestReplacedRegistration() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        //把過濾器大哥安放到副駕上
        registration.setFilter(new HttpServletRequestFilter());
        registration.addUrlPatterns("/*");
        registration.addInitParameter("paramName", "paramValue");
        registration.setName("httpServletRequestFilter");
        registration.setOrder(1);
        return registration;
    }

然后運(yùn)行，攔截獲取json參數(shù)，因?yàn)橛羞@幾個(gè)大哥這么組織和坐鎮(zhèn)，一開車，沒問題，超速上高速，shua~