ServletRequest中getReader()和getInputStream()只能调用一次的解决办法

2015年9月8日 1 条评论

最近使用spring mvc做项目，数据格式是json，有一个功能是实现记录请求的参数，而请求的参数是整个RequestBody，Controller里是用过@RequestBody获取的。实现方法是通过一个Filter读取整个RequestBody并记录。但是这时就遇到一个问题，ServletRequest的getReader()和getInputStream()两个方法只能被调用一次，而且不能两个都调用。那么如果Filter中调用了一次，在Controller里面就不能再调用了。查看了下ServletRequest的说明，如下：

Java代码
  1. /**
  2.  * Retrieves the body of the request as binary data using
  3.  * a {@link ServletInputStream}.  Either this method or 
  4.  * {@link #getReader} may be called to read the body, not both.
  5.  *
  6.  * @return          a {@link ServletInputStream} object containing
  7.  *              the body of the request
  8.  *
  9.  * @exception IllegalStateException  if the {@link #getReader} method
  10.  *                   has already been called for this request
  11.  *
  12.  * @exception IOException       if an input or output exception occurred
  13.  *
  14.  */
  16. public ServletInputStream getInputStream() throws IOException;
  18. /**
  19.  * Retrieves the body of the request as character data using
  20.  * a <code>BufferedReader</code>.  The reader translates the character
  21.  * data according to the character encoding used on the body.
  22.  * Either this method or {@link #getInputStream} may be called to read the
  23.  * body, not both.
  24.  * 
  25.  *
  26.  * @return                  a <code>BufferedReader</code>
  27.  *                      containing the body of the request  
  28.  *
  29.  * @exception UnsupportedEncodingException  if the character set encoding
  30.  *                      used is not supported and the 
  31.  *                      text cannot be decoded
  32.  *
  33.  * @exception IllegalStateException     if {@link #getInputStream} method
  34.  *                      has been called on this request
  35.  *
  36.  * @exception IOException           if an input or output exception occurred
  37.  *
  38.  * @see                     #getInputStream
  39.  *
  40.  */
  42. public BufferedReader getReader() throws IOException;

两个方法都注明方法只能被调用一次，由于RequestBody是流的形式读取，那么流读了一次就没有了，所以只能被调用一次。既然是因为流只能读一次的原因，那么只要将流的内容保存下来，就可以实现反复读取了。

实现方法：先将RequestBody保存为一个byte数组，然后通过Servlet自带的HttpServletRequestWrapper类覆盖getReader()和getInputStream()方法，使流从保存的byte数组读取。然后再Filter中将ServletRequest替换为ServletRequestWrapper。代码如下：

BodyReaderHttpServletRequestWrapper类包装ServletRequest，将流保存为byte[]，然后将getReader()和getInputStream()方法的流的读取指向byte[]

Java代码
  1. import java.io.BufferedReader;
  2. import java.io.ByteArrayInputStream;
  3. import java.io.IOException;
  4. import java.io.InputStreamReader;
  6. import javax.servlet.ServletInputStream;
  7. import javax.servlet.http.HttpServletRequest;
  8. import javax.servlet.http.HttpServletRequestWrapper;
  10. import jodd.JoddDefault;
  11. import jodd.io.StreamUtil;
  13. public class BodyReaderHttpServletRequestWrapper extends HttpServletRequestWrapper {
  15.     private final byte[] body;
  17.     public BodyReaderHttpServletRequestWrapper(HttpServletRequest request)
  18. throws IOException {
  19.         super(request);
  20.         body = StreamUtil.readBytes(request.getReader(), JoddDefault.encoding);
  21.     }
  23.     @Override
  24.     public BufferedReader getReader() throws IOException {
  25.         return new BufferedReader(new InputStreamReader(getInputStream()));
  26.     }
  28.     @Override
  29.     public ServletInputStream getInputStream() throws IOException {
  30.         final ByteArrayInputStream bais = new ByteArrayInputStream(body);
  31.         return new ServletInputStream() {
  33.             @Override
  34.             public int read() throws IOException {
  35.                 return bais.read();
  36.             }
  37.         };
  38.     }
  40. }

在Filter中将ServletRequest替换为ServletRequestWrapper

Java代码
  1. public class HttpServletRequestReplacedFilter implements Filter {
  3.     @Override
  4.     public void init(FilterConfig filterConfig) throws ServletException {
  5.         //Do nothing
  6.     }
  8.     @Override
  9.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
  10.         ServletRequest requestWrapper = null;
  11.         if(request instanceof HttpServletRequest) {
  12.             requestWrapper = new BodyReaderHttpServletRequestWrapper((HttpServletRequest) request);
  13.         }
  14.         if(null == requestWrapper) {
  15.             chain.doFilter(request, response);
  16.         } else {
  17.             chain.doFilter(requestWrapper, response);
  18.         }
  20.     }
  22.     @Override
  23.     public void destroy() {
  24.         //Do nothing
  25.     }
  27. }

（文/liwx2000）

本文来源：http://liwx2000.iteye.com/blog/1542431


如果给你带来帮助，欢迎微信或支付宝扫一扫，赞一下。
 

关于 “ServletRequest中getReader()和getInputStream()只能调用一次的解决办法” 的 1 个意见

  1. 从流中获取消息体的方法：
    public static String getBodyString(ServletRequest request) {
            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();
        }
     

评论关闭。