如何从零开始捕获body和header

简介: 本文就一项关键技术实现进行深入探讨:如何从超文本传输协议(HTTP)中获取request和response的body和header。

在Java中,HTTP协议的请求/响应模型是由Servlet规范+Servlet容器(如Tomcat)实现的。换句话说,在类Tomcat容器中,一次完整的HTTP请求都是通过实现Servlet规范完成的;Spring、Jesery 等技术栈也是在Servlet规范基础上封装的。因此我们可以借助底层的Servlet规范来获取Java技术栈中HTTP的body和header,即通过拦截用户自定义实现的HttpServlet类中的HttpServletRequest和HttpServletResponse,获取HTTP的body和header。

通过阅读前几篇文章大家知道,调用链模型和架构都是依托UAVStack的中间件增强框架技术实现的。在这篇文章中,我会向大家具体介绍如何从零开始捕获body和header。

一、拦截http请求

想要在尽可能少改动代码的前提下从请求中提取body和header,必须对进入容器的请求进行统一拦截,否则就需要在所有HttpServlet实现类中嵌入代码。这里要再次感谢Servlet规范制定者为我们提供的filter机制。

根据Servlet规范,filter是一个可重用的代码段,可以转换HTTP requests、responses和header信息的内容。过滤器一般不会为一个request创建一个响应,而是会修改或适配一个request和response。filter主要提供四种拦截方式:

  • REQUEST:直接访问目标资源时执行过滤器。包括:在地址栏中直接访问、表单提交、超链接、重定向,只要在地址栏中可以看到目标资源的路径,就是REQUEST;
  • FORWARD:转发访问执行过滤器。包括RequestDispatcher#forward()方法、< jsp:forward>标签都是转发访问;
  • INCLUDE:包含访问执行过滤器。包括RequestDispatcher#include()方法、< jsp:include>标签都是包含访问;
  • ERROR:当目标资源在web.xml中配置为< error-page>中时,并且真的出现了异常,转发到目标资源时,会执行过滤器。

这里我们只需使用REQUEST模式。配置filter以后,我们就可以从filter的doFilter方法中获取到HttpServletRequest和HttpServletResponse(后文简称request和response)了。

二、获取header

上文中我们已经通过filter机制获取了request和response。打开对应源码实现我们可以发现如下API:

规范中已经为我们提供API直接获取header,通过组合使用getHeaderNames()和getHeader(String name)方法我们可以轻松获取到request和response中的header。

三、获取body

request和response获取body的方式大体相同。此处我们先以request为例,后文会对不同之处进行适配。

从request的API中可以发现,body在Java中是以ServletInputStream形式存储的,并且ServletInputStream是继承的InputStream。若直接读取,用户获取到的body将为空(因为InputStream只能被读取一次,除非把指针回执)。这里我们就需要借助Servlet的wrapper机制了。

四、Servlet中的wrapper

这里简单介绍一下requestWrapper和responseWrapper。wrapper是一种装饰模式,在Servlet规范中通过继承HttpServletResponseWrapper和HttpServletRequestWrapper实现,相当于为request和response进行了一次套壳,类似于Java中的代理,这样所有操作request和response的动作都会经过我们的自定义wrapper,使重复获取request和response中的body成为可能。

五、编写自己的wrapper

我们以request为例,解释如何编写自定义wrapper。打开servlet-api源码可见HttpServletRequestWrapper继承了ServletRequestWrapper并且实现了HttpServletRequest接口。

ServletRequestWrapper已经帮我们实现了大部分的方法。

我们只需要将关心的几个方法覆写即可,如:getInputStream和getReader等。

当用户尝试调用getReader或getInputStream时,我们将之替换为自己的流,并且额外提供一个getContent()方法,将提前从StringBuilder或byte[]中读取到的body内容进行提取。

编写完自定义wrapper以后,我们就可以将其放入我们上文定义好的filter中,并将原request进行包装替换,进而将用户的request都变成我们的requestWrapper。

六、优化提取逻辑

上文的方法相当于是将包含body的inputStream提前进行一次读取,将其存储在中间byte[]或StringBuilder当中,当用户在调用getInputStream时,将byte[]或StringBuilder转成inputStream返给用户。如果用户根本不关心本次http请求的body,即用户根本没有使用此次请求的body,那我们将其提前读取出来相当于做了一次无用功(浪费了宝贵的CPU时间和内存资源)。如何保证只有在用户使用时才读取inputStream,并且当用户或后续逻辑多次获取body时都只读一次是我们优化的目标。

答案还是继续从源码中寻找。既然我们的数据在inputStream中,那我们可以跟进源码,看看inputStream是如何被读取到的。在Servlet规范中,inputStream被封装成了ServletInputStream,而ServletInputStream又提供了一个readLine方法。仔细观察可以发现,他们都是调用了inputStream中的read方法,如下图:

既然read方法是统一入口,是否只需要自定义实现一个ServletInputStream并覆写其中的read()方法就能修改所有读取方式了呢?答案是肯定的。只要在用户调用read方法时,悄悄复制一份我们关心的内容,就能保证只有在用户使用body时才读取inputStream。

下一个问题就是如何保证在用户多次调用read时只读取一次inputStream。这里需要借助一个AtomicBoolean标志:当已经进行了一次完整读取后,将其置为true;否则为false。最终效果如下:

七、举一反三

这里我们使用Servlet规范中的filter和wrapper机制来获取进入我们容器(Tomcat)中所有Http请求的body和header。这个能力在实际生产中还能进一步拓展,如:传输某些敏感数据时,在Client端进行加密,然后在Server端统一解密,并格式化Client端上送的数据格式等。

读完本文,大家应该能够在不影响原代码的前提下,通过简单代码获取进入容器的所有Http请求的body和header。不过对于特殊技术栈,还需要进行适配。如果项目中使用了Jersey且使用application/x-www-form-urlencoded形式传递参数等信息,而服务端没有使用@FormParam注解来获取参数,那么获取body以后用户将无法获取参数。但至少我们已经验证了这条路是可行的,所以已经成功了一半。希望这份技术分享能够在工作中帮到大家。

开源地址:https://github.com/uavorg/uavstack

作者:李崇

来源:宜信技术学院

相关文章
|
7月前
|
XML JSON API
高效使用 Postman:如何正确传递 Query、Path 和 Body 参数
Postman 作为一个功能强大的工具,极大地简化了 API 测试和调试的过程,提供了发送请求和检查响应的直接方法。本文将着重介绍如何在 Postman 中高效地处理请求参数,以提高 API 测试和开发的便利性。
|
7月前
|
数据可视化 前端开发
HTML基础结构和常用标记的例子
HTML基础结构和常用标记的例子
46 0
|
JSON API 数据格式
Uniapp~动态修改 请求头的content-type 的值
Uniapp~动态修改 请求头的content-type 的值
1335 0
Uniapp~动态修改 请求头的content-type 的值
|
3月前
|
前端开发 JavaScript
html中id和class的相同和不同之处及用法的规范与区别
在HTML中,`id`和`class`都用于标识和选择元素,但存在一些关键差异。
|
7月前
|
JavaScript 前端开发 UED
探究: 为什么JavaScript要在body标签尾部引入?
探究: 为什么JavaScript要在body标签尾部引入?
85 0
|
7月前
|
Serverless Python
在函数计算中,如果云函数的返回结果包含了`Content-Disposition: attachment`头部在函数计算中
在函数计算中,如果云函数的返回结果包含了`Content-Disposition: attachment`头部在函数计算中
306 2
|
JavaScript 前端开发
JavaScript 无法获取响应 header 的 Content-Disposition 字段
JavaScript 无法获取响应 header 的 Content-Disposition 字段
1032 0
JavaScript 无法获取响应 header 的 Content-Disposition 字段
|
数据采集 大数据 应用服务中间件
Lua 获取 Header 与 Body 数据|学习笔记
快速学习 Lua 获取 Header 与 Body 数据
Lua 获取 Header 与 Body 数据|学习笔记
|
前端开发 JavaScript
【前端】【探究】HTML - input类型为file时如何实现自定义文本以更好的美化
【前端】【探究】HTML - input类型为file时如何实现自定义文本以更好的美化
162 0
【前端】【探究】HTML - input类型为file时如何实现自定义文本以更好的美化
|
XML JSON 前端开发
【源码解读】TP5return json_encode ajax自动被加上双引号
在thinkphp5中,return数据才是控制器正确的时候方式,而不是直接echo 然后die 或者exti 因为框架有后置数据的落地处理等等,直接让程序退出并不友好,既然我们选择了框架,就应该遵循框架的设计理念 这样子能让我们避免一些坑爹事件的发生。
290 0