Cannot call getReader(), getInputStream() already called分析与解决

先说问题产生原因：

翻译一下就是：getInputStream()已经被使用过了，就不能再使用getReader()。

我遇到产生该问题的情况是，在POST请求中参数使用@RequestBody注解了。这个注解就是会去调用getInputStream()的，然后我在其他地方，我这里的业务场景是制作@SysLog时需要获取请求参数，使用下面的语句时出现的：

String body = request.getReader().lines().collect(Collectors.joining(System.lineSeparator()));

经检查发现是request中的getRead() 和 getInputStream()在读取一次后标记为-1，无法再次被读取。

我的解决方法是这样的，当然，这是结合了我的项目结构和业务的解决办法，这里说一下：

第一步：编写工具类获取request中的body参数

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.ServletInputStream;
import javax.servlet.ServletRequest;

import com.alibaba.fastjson.JSON;

import cn.hutool.core.util.StrUtil;

/**
 * 获取request中的body参数
 * @author YunDuan-Clutch
 * @date 2021年11月24日 上午10:46:47
 */
public class HttpHelper {

	/**
	 * 获取body，json字符串的形式
	 * @author YunDuan-Clutch
	 * @param request
	 * @date 2021年11月24日 上午10:46:47
	 * @return String
	 */
	public static String getBodyString(ServletRequest request) {
        StringBuilder sb = new StringBuilder();
        ServletInputStream inputStream = null;
        BufferedReader reader = null;
        try {
            inputStream = request.getInputStream();
            reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.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();
    }

	/**
	 * 获取body，map的形式
	 * @author YunDuan-Clutch
	 * @param request
	 * @date 2021年11月24日 上午10:48:29
	 * @return Map<String,Object>
	 */
    @SuppressWarnings("all")
    public static Map<String, Object> getBodyMap(ServletRequest request) {
        Map<String, Object> params = new HashMap<>();
        String bodyString = getBodyString(request);
        if (StrUtil.isNotEmpty(bodyString)) {
            params = JSON.parseObject(bodyString, Map.class);
        }
        return params;
    }
}

第二步：重写getInputStream()

import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;

import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;

import com.pig4cloud.pigx.common.core.util.HttpHelper;

/**
 * 
 * 定义增强类，集成HttpServletRequestWrapper，重写getInputStream()
 * 
 * @author YunDuan-Clutch
 * @date 2021年11月24日 上午10:46:47
 *
 */
public class BodyReaderHttpServletRequestWrapper extends HttpServletRequestWrapper {

    private byte[] body;

    public BodyReaderHttpServletRequestWrapper(HttpServletRequest request) throws IOException {
        super(request);
        body = HttpHelper.getBodyString(request).getBytes(StandardCharsets.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) {

            }

        };
    }

    public void setInputStream(byte[] body) {
        this.body = body;
    }
	
}

第三步：过滤器包装request

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;

import com.pig4cloud.pigx.common.core.constant.CommonConstants;
import com.pig4cloud.pigx.common.core.wrapper.BodyReaderHttpServletRequestWrapper;

import cn.hutool.core.util.URLUtil;

@WebFilter(filterName = "RequestWrapperFilter", urlPatterns = "/*")
public class RequestWrapperFilter implements Filter {

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

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws ServletException
            , IOException {
    	HttpServletRequest req = (HttpServletRequest) request;
    	String requestUri = URLUtil.getPath(req.getRequestURI());
    	String method = req.getMethod();
        ServletRequest requestWrapper = null;
        if (request instanceof HttpServletRequest 
        		&& !requestUri.contains("/sys-file")// 文件上传时不可以过滤器包装request，会报错Required request part 'file' is not present
        		&& CommonConstants.ALLOWED_METHODS.contains(method) 
        		&& !CommonConstants.ALLOWED_PATHS.contains(requestUri)) {
            requestWrapper = new BodyReaderHttpServletRequestWrapper((HttpServletRequest) request);
        }
        if (null == requestWrapper) {
        	// 过滤器包装request不需要，将返回原来的request
            chain.doFilter(request, response);
        } else {
        	// 过滤器包装request成功
            chain.doFilter(requestWrapper, response);
        }
    }

    @Override
    public void destroy() {

    }

}

这里过滤器包装request的时候有一个判断，这个是根据自己的业务做的，没有可以不加。

生效方法：

中添加RequestWrapperFilter 的完整地址，即报名+类型这个

 

有参考来源：SpringBoot 配置获取request中body的json格式参数_koala、的博客-CSDN博客