SpringBoot v2.2以上重复读取Request Body内容的解决方案

目录
  • SpringBoot v2.2以上重复读取Request Body内容
    • 一、需求
    • 二、解决方案
    • 三、遇到问题
    • 四、问题排查
    • 解决方案
  • SpringBoot 读取Request参数的坑
    • 后端拿参数相关
    • 关于流

SpringBoot v2.2以上重复读取Request Body内容

一、需求

项目有两个场景会用到从Request的Body中读取内容。

  • 打印请求日志
  • 提供Api接口,在api方法执行前,从Request Body中读取参数进行验签,验签通过后在执行api方法

二、解决方案

2.1 自定义RequestWrapper

public class MyRequestWrapper extends HttpServletRequestWrapper {
 private final String body;
 public MyRequestWrapper(HttpServletRequest request) throws IOException {
  super(request);
  this.body = RequestReadUtils.read(request);
 }
 public String getBody() {
  return body;
 }
 @Override
 public ServletInputStream getInputStream() throws IOException {
  final ByteArrayInputStream bais = new ByteArrayInputStream(body.getBytes());
  return new ServletInputStream() {
   ...略
  };
 }
 @Override
 public BufferedReader getReader() throws IOException {
  return new BufferedReader(new InputStreamReader(this.getInputStream()));
 }
}

RequestReadUtils(网上抄的)

private static final int BUFFER_SIZE = 1024 * 8;

    public static String read(HttpServletRequest request) throws IOException {
        BufferedReader bufferedReader = request.getReader();
        for (Enumeration<String> iterator = request.getHeaderNames(); iterator.hasMoreElements();) {
         String type = iterator.nextElement();
   System.out.println(type+" = "+request.getHeader(type));
  }
        System.out.println();
        StringWriter writer = new StringWriter();
        write(bufferedReader,writer);
        return writer.getBuffer().toString();
    }

    public static long write(Reader reader,Writer writer) throws IOException {
        return write(reader, writer, BUFFER_SIZE);
    }

    public static long write(Reader reader, Writer writer, int bufferSize) throws IOException
    {
        int read;
        long total = 0;
        char[] buf = new char[bufferSize];
        while( ( read = reader.read(buf) ) != -1 ) {
            writer.write(buf, 0, read);
            total += read;
        }
        return total;
    }

2.2 定义Filter

@WebFilter
public class TestFilter implements Filter{
 @Override
 public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain chain){
  HttpServletRequest request = (HttpServletRequest) servletRequest;
  HttpServletResponse response = (HttpServletResponse) servletResponse;

  MyRequestWrapper wrapper = WebUtils.getNativeRequest(request, MyRequestWrapper.class);
  chain.doFilter(wrapper == null ? new MyRequestWrapper(request) :wrapper,servletRequest);
 }
}

三、遇到问题

使用的SpringBoot v2.1.x版本

  • Form提交无问题
  • 获取RequestBody无问题

使用SpringBoot v2.2.0以上版本(包括v2.3.x)

  • Form提交无法获取参数
  • 获取RequestBody无问题

四、问题排查

经过排查,v2.2.x对比v2.1.x的不同在于一下代码差异:

BufferedReader bufferedReader = request.getReader();
-----------------
char[] buf = new char[bufferSize];
while( ( read = reader.read(buf) ) != -1 ) {
    writer.write(buf, 0, read);
    total += read;
}

当表单提交时

  • v2.1.x无法read到内容,读取结果为-1
  • v2.2.x、v2.3.x能够读取到内容

当表单提交时(x-www-form-urlencoded),inputStream读取一次后后续不会触发wrapper的getInputStream操作,所以Controller无法获取到参数。

解决方案

MyRequestWrapper改造

public class MyRequestWrapper extends HttpServletRequestWrapper {
 private final String body;
 public MyRequestWrapper(HttpServletRequest request) throws IOException {
  super(request);
  this.body = getBodyString(request);
 }
 public String getBody() {
  return body;
 }

 public String getBodyString(final HttpServletRequest request) throws IOException {
     String contentType = request.getContentType();
     String bodyString = "";
     StringBuilder sb = new StringBuilder();
     if (StringUtils.isNotBlank(contentType) && (contentType.contains("multipart/form-data") || contentType.contains("x-www-form-urlencoded"))) {
         Map<String, String[]> parameterMap = request.getParameterMap();
         for (Map.Entry<String, String[]> next : parameterMap.entrySet()) {
             String[] values = next.getValue();
             String value = null;
             if (values != null) {
                 if (values.length == 1) {
                     value = values[0];
                 } else {
                     value = Arrays.toString(values);
                 }
             }
             sb.append(next.getKey()).append("=").append(value).append("&");
         }
         if (sb.length() > 0) {
             bodyString = sb.toString().substring(0, sb.toString().length() - 1);
         }
         return bodyString;
     } else {
         return IOUtils.toString(request.getInputStream());
     }
 }
 @Override
 public ServletInputStream getInputStream() throws IOException {
  final ByteArrayInputStream bais = new ByteArrayInputStream(body.getBytes());

  return new ServletInputStream() {
   @Override
   public boolean isFinished() {
    return false;
   }
   @Override
   public boolean isReady() {
    return false;
   }
   @Override
   public int read() {
    return bais.read();
   }
   @Override
   public void setReadListener(ReadListener readListener) {
   }
  };
 }
 @Override
 public BufferedReader getReader() throws IOException {
  return new BufferedReader(new InputStreamReader(this.getInputStream()));
 }
}

SpringBoot 读取Request参数的坑

后端拿参数相关

默认配置时,

getInputStream()和getReader()一起使用会报错

使用两遍getInputStream(),第二遍会为空

当存在@RequestBody等注解时,springMVC已读取过一遍流,默认单独使用getInputStream()或getReader()都为空。

解决:写filter继承HttpServletRequestWrapper,缓存InputStream,覆盖getInputStream()和getReader()方法,使用ByteArrayInputStream is = new ByteArrayInputStream(body.getBytes());读取InputStream。

注意:springboot中,过滤器只需@Component即可生效,另外可在FilterRegistrationBean中配置路径和优先级。

对于拦截器,必须在InterceptorRegistry中调用addInterceptor方法。(路径可链式添加)

关于流

只能读一遍,类似管子。

只承担传输职责,而与处理和存储无关。

对于byte流而言,进行重复读取易于实现,但指针不重置,应是为了与InputStream接口定义保持一致。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持我们。

(0)

相关推荐

  • springboot接口如何多次获取request中的body内容

    1. 概述 在使用springboot开发接口时,会将参数转化为Bean,用来进行参数的自动校验.同时也想获取request中原始body报文进行验签(防止报文传输过程中被篡改). 因为通过将bean再转化为字符串后,body里面的报文格式.字段顺序会发生改变,就会导致验签失败.因此只能通过request来获取body里面的内容. 既想接口自动实现参数校验,同时又想获取request中的原始报文,因此我们可以通过在controller中的restful方法中,写入两个参数,获取多次request

  • 完美解决request请求流只能读取一次的问题

    解决request请求流只能读取一次的问题 实际开发碰到的问题 解决request请求流中的数据二次或多次使用问题 实际开发碰到的问题 springboot项目中,为了防止sql注入,采用Filter拦截器对所有请求流中的json数据进行校验,请求数据没问题则继续向下执行,在后边的代码中应用到请求参数值时,发现request中的json数据为空: 除上边描述的情况,尝试过两次从request中获取json数据,第二次同样是获取不到的. 解决request请求流中的数据二次或多次使用问题 继承Ht

  • Springboot拦截器如何获取@RequestBody参数

    Springboot拦截器获取@RequestBody参数 HttpContextUtils import javax.servlet.ServletRequest; import javax.servlet.http.HttpServletRequest; import java.io.BufferedReader; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader;

  • Spring boot @RequestBody数据传递过程详解

    这篇文章主要介绍了Spring boot @RequestBody数据传递过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 @RequestBody需要接的参数是一个string化的json @RequestBody,要读取的数据在请求体里,所以要发post请求,还要将Content-Type设置为application/json java的api 参数为JSONObject,获取到的参数处理 @PostMapping("/combine

  • SpringBoot v2.2以上重复读取Request Body内容的解决方案

    目录 SpringBoot v2.2以上重复读取Request Body内容 一.需求 二.解决方案 三.遇到问题 四.问题排查 解决方案 SpringBoot 读取Request参数的坑 后端拿参数相关 关于流 SpringBoot v2.2以上重复读取Request Body内容 一.需求 项目有两个场景会用到从Request的Body中读取内容. 打印请求日志 提供Api接口,在api方法执行前,从Request Body中读取参数进行验签,验签通过后在执行api方法 二.解决方案 2.1

  • Springboot如何设置过滤器及重复读取request里的body

    目录 HttpServletRequest的输入流只能读取一次的原因 重复读取body中数据的方法 springboot的过滤器 上面的getBody的代码 需求: request的content-type为applciation/json,进入controller之前需要把body中的参数取出来做一次处理,然后和hearder中的另一个参数做对比. 思路: 加一个过滤器,在过滤器中取出参数做处理,然后比较 注意: body里的数据用流来读取,只能读取一次 HttpServletRequest的

  • 如何构建可重复读取inputStream的request

    目录 构建可重复读取inputStream的request request中inputStream多次读取 原因 解决方法(缓存读取到的数据) 代码 构建可重复读取inputStream的request 我们知道,request的inputStream只能被读取一次,多次读取将报错,那么如何才能重复读取呢?答案之一是:增加缓冲,记录已读取的内容. 代码如下所示: import lombok.extern.log4j.Log4j2; import org.springframework.mock.

  • ASP.NET Core读取Request.Body的正确方法

    前言 相信大家在使用ASP.NET Core进行开发的时候,肯定会涉及到读取Request.Body的场景,毕竟我们大部分的POST请求都是将数据存放到Http的Body当中.因为笔者日常开发所使用的主要也是ASP.NET Core所以笔者也遇到这这种场景,关于本篇文章所套路的内容,来自于在开发过程中我遇到的关于Request.Body的读取问题.在之前的使用的时候,基本上都是借助搜索引擎搜索的答案,并没有太关注这个,发现自己理解的和正确的使用之间存在很大的误区.故有感而发,便写下此文,以作记录

  • SpringCloud Gateway读取Request Body方式

    目录 Gateway读取RequestBody 分析ReadBodyPredicateFactory 配置ReadBodyPredicateFactory 编写自定义GatewayFilterFactory 完整的yml配置 Gateway自定义filter获取body的数据为空 首先创建一个全局过滤器把body中的数据缓存起来 在自定义的过滤器中尝试获取body中的数据 解析body的工具类 Gateway读取Request Body 我们使用SpringCloud Gateway做微服务网关

  • SpringBoot + Redis如何解决重复提交问题(幂等)

    目录 幂等: 解决方案: 一.搭建Redis服务 二.自定义注解 三.Token创建和校验 四.拦截器配置 五.正常Sevice类 六.Controller类 七.测试 在开发中,一个对外暴露的接口可能会面临瞬间的大量重复请求,如果想过滤掉重复请求造成对业务的伤害,那就需要实现幂等 幂等: 任意多次执行所产生的影响均与一次执行的影响相同.最终的含义就是 对数据库的影响只能是一次性的,不能重复处理. 解决方案: 数据库建立唯一性索引,可以保证最终插入数据库的只有一条数据 token机制,每次接口请

  • Springboot整合Spring Cloud Kubernetes读取ConfigMap支持自动刷新配置的教程

    1 前言 欢迎访问南瓜慢说 www.pkslow.com获取更多精彩文章! Docker & Kubernetes相关文章:容器技术 之前介绍了Spring Cloud Config的用法,但对于Kubernetes应用,可能会需要读取ConfigMap的配置,我们看看Springboot是如何方便地读取ConfigMap和Secret. 2 整合Spring Cloud Kubenetes Spring Cloud Kubernetes提供了Spring Cloud应用与Kubernetes服

  • Gateway网关自定义拦截器的不可重复读取数据问题

    目录 Gateway网关自定义拦截器的不可重复读取数据 统一网关Gateway 一.为什么需要网关 二.搭建网关服务 三.路由断言工厂 四.路由过滤器 五.跨域问题处理 Gateway网关自定义拦截器的不可重复读取数据 最近在开发gateway网关时,通过自定义拦截器对某些接口的数据进行处理,发现,无法读取到数据.经过查询,发现在Spring5的webflux编程或者普通web编程中,只能从request中获取body一次,后面无法再获取. 参考网上的方法先通过全局过滤器把body先缓存起来.

  • Java使用ByteArrayOutputStream 和 ByteArrayInputStream 避免重复读取配置文件的方法

    ByteArrayOutputStream类是在创建它的实例时,程序内部创建一个byte型别数组的缓冲区,然后利用ByteArrayOutputStream和ByteArrayInputStream的实例向数组中写入或读出byte型数据.在网络传输中我们往往要传输很多变量,我们可以利用ByteArrayOutputStream把所有的变量收集到一起,然后一次性把数据发送出去.具体用法如下: ByteArrayOutputStream:    可以捕获内存缓冲区的数据,转换成字节数组. ByteA

随机推荐