springboot 升级过程中踩坑定位分析记录 | 京东云技术团队

2025-12-13 0 236

1. 背景

俗话说:为了修复一个小 bug 而引入了一个更大 bug

因所负责的系统使用的 spring 框架版本 5.1.5.RELEASE 在线上出过一个偶发的小事故,最后定位为 spring-context 中的一个 bug 导致的。

为了修复此 bug 进行了 spring 版本的升级,最终定的版本为收银台团队使用的版本 5.2.12.RELEASE,对应的 springboot 版本为 2.2.12.RELEASE。

选择这个版本的原因是:

1. 有团队经过了长时间的线上验证

2. 修复了 5.1.5.RELEASE 对应的 bug

2. 升级上线

升级相关版本后在预发环境进行了验证,暂未遇到关于框架的问题。本以为安全升级完成,在上线过程中发现在 APP 中无法访问,此时还未挂载流量。

日志中分析是某些参数未解析到,后在 nginx 日志中查到相关请求,使用 postman 模拟请求可以正常使用

3. 分析验证定位原因

1. 临时修复

在代码一致的情况下,唯一的可能就只能是线上与预发配置不同,经对比分析得出是某个过滤器的顺序在线上未配置,按照预发的配置后可正常使用。我们暂且称修改的这两个过滤器为 M A,

其中默认情况下执行顺序为 M->A,顺序修改为 A->M 后正常,其两者作用大致为:

M:通用过滤器,解析 url 中的参数至 parameterMap 中,并初始化读取了 body 中的 inputstream 进行了 byte 数组的缓存,用于解决重复读取流问题A:特定处理器,先是查询 parameter 中的参数,然后逻辑处理后再设置一些特殊参数。

2. 为何需要改过滤器顺序

经查未升级前过滤器的顺序与升级后过滤器顺序一致,为何升级 spring 框架后需要修改配置。此时猜测可能是 spring 在升级过程中修改了一部分代码,

但未有头绪,只能先调转方向分析为什么 postman 和浏览器中的 swagger 可以正常使用

3. 分析 nginx 日志

前端请求与 postman 请求的 nginx 日志进行了分析得出了原因,对比日志如下:

postmanPOST /shop/bpaas/floor?client&clientVersion&ip=111.202.149.19&gfid=getShopMainFloor&body=前端:POST /shop/bpaas/floor HTTP/1.0\” 200 634 \”-\” \”api\” \”0.94\” 0.008 0.007 client&clientVersion&ip=111.202.149.17&gfid=getShopMainFloor&body=

经过以上对比发现虽然 postman 使用了 post 请求,但数据还是放置在 url 中,在经过系统的一个内置过滤器 M 时将 url 中的参数解析到了 parameterMap 中,后续过滤器可以使用

request.getParameter 获取到,注意此方法是解决问题的关键,此时还未意识到。

4. 升级前后框架是否有大的修改

因升级的版本是升级了一个小版本号,所以不好对比升级的 buglist,只能慢慢进行分析,后在分析过滤器时发现升级 spring 后过滤器个数由 11 个减少到了 10 个,减少了那一个为:org.springframework.web.filter.HiddenHttpMethodFilter

此过虑器的作用是在浏览器不支持 PUT、DELETE、PATCH 等 method 时,可以在 form 表单中使用隐藏的_method 参数支持这几种 method。好像跟参数解析没有任何关系,

继续分析升级版本中 (由 2.1.3.RELEASE->2.2.12.RELEASE)是否修改了此过滤器的一些内容,后在 2.2.0.M5 的 release notes 中发现 HiddenHttpMethodFilter 相关的:

“ Disable auto-configuration of HiddenHttpMethodFilter by default ” github 上对应的版本 release notes: https://github.com/spring-projects/spring-boot/releases/tag/v2.2.0.M5

也就是说升级后 HiddenHttpMethodFilter 默认配置由 enable 修改为了 disable,如果再修改回去是不是可以修复参数解析的问题呢?

5. 添加过滤器 enable 配置

因 bug 修复列表中有对应的 issues,所以找到了此过滤器对应的配置:

-Dspring.mvc.hiddenmethod.filter.enabled=true

添加后可以正常使用,证明是此过滤器中在某种条件下不可缺少。

6. 未升级 spring 版本时 disable 验证

在确认未升级版本的 spring 支持此参数的情况下,添加了以上参数,将默认的启动修改成了禁用,经验证:在不代码修改的情况下,无此过滤器时参数无法解析。证明了上步的猜测。

7. 深入源码分析

此时需要分析 HiddenHttpMethodFilter 过滤器中是否有特殊操作,源码如下:

protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
throws ServletException, IOException {

HttpServletRequest requestToUse = request;

if (\”POST\”.equals(request.getMethod()) && request.getAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE) == null) {
String paramValue = request.getParameter(this.methodParam);
if (StringUtils.hasLength(paramValue)) {
String method = paramValue.toUpperCase(Locale.ENGLISH);
if (ALLOWED_METHODS.contains(method)) {
requestToUse = new HttpMethodRequestWrapper(request, method);
}
}
}
filterChain.doFilter(requestToUse, response);
}

分析以上源码可以发现,有且只有一种可能,就是 request.getParameter 可能是解决问题的是关键。

8. 大胆猜测

分析后源码猜测,第一步中的修改顺序有可能是 A 中有调用 getParameter,所以顺序调整为 A->M 后,相当于间接使用了 HiddenHttpMethodFilter。

9. 开始验证

在不使用 HiddenHttpMethodFilter 的情况下,如果在过滤器原有顺序不修改的情况下,只要在 M 执行前调用了 request.getParameter,理论上可以正常为使用。所以在 debug 情况下

利用工具在 M 过滤器调用前先行执行 request.getParameter,发现的确可以正常使用。

10. 分析过滤器

先前简述了 M 的功能,主要是包装了 request,后读源码时发现,如果是 post 请求,读取 body 体中的数据后并未解析 body 中的参数至 parameterMap 中,而代码中的其它过滤器都是

通过 request.getParameter 获取的数据,重写后的代码:

public String getParameter(String name) {
if ( this.parameterMap.containsKey(name) )
return this.parameterMap.get(name);
else {
return super.getParameter(name);
}
}

在经过 request 包装后,先是从 paremeterMap 中获取数据,此时 map 肯定是没有数据,只能从父类获取,而父类获取时会解析 parameter,解析时使用到了 inputStream,但 M 过滤器

的在初始化时解析了输入流,此时 tomcat 内部使用内部的 request 获取 stream 时将获取到空数据,即无法从 parameter 中获取到 body 体中的数据。

而如果在调用 M 前调用了 request.getParameter,tomcat 内部将提前于 M 解析 parameter,可以保证后续可获取到相关参数。

4. 修复方案

既然得出了结论,那么升级 spring 版本后修复此 bug 可选择的方案就比较多了,主要有:

1. 启用 HiddenHttpMethodFilter,添加对应的参数,保证升级前后过滤器个数与顺序一致

2. 调整理过滤器 A 与 M 的顺序,保证 M 在 A 之前执行即可。

3. 修改过滤器 M 内部的逻辑,不在初始化的时候解析 body,或是在解析 body 后将参数重新放置到 parameterMap 中。

此文是笔者按照分析流程进行简单验证,分析验证过程中难免有遗漏之处,如有错误遗漏还烦请各位指出共同进步。

收藏 (0) 打赏

感谢您的支持,我会继续努力的!

打开微信/支付宝扫一扫,即可进行扫码打赏哦,分享从这里开始,精彩与您同在
点赞 (0)

申明:本文由第三方发布,内容仅代表作者观点,与本网站无关。对本文以及其中全部或者部分内容的真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。本网发布或转载文章出于传递更多信息之目的,并不意味着赞同其观点或证实其描述,也不代表本网对其真实性负责。

左子网 编程相关 springboot 升级过程中踩坑定位分析记录 | 京东云技术团队 https://www.zuozi.net/36210.html

常见问题
  • 1、自动:拍下后,点击(下载)链接即可下载;2、手动:拍下后,联系卖家发放即可或者联系官方找开发者发货。
查看详情
  • 1、源码默认交易周期:手动发货商品为1-3天,并且用户付款金额将会进入平台担保直到交易完成或者3-7天即可发放,如遇纠纷无限期延长收款金额直至纠纷解决或者退款!;
查看详情
  • 1、描述:源码描述(含标题)与实际源码不一致的(例:货不对板); 2、演示:有演示站时,与实际源码小于95%一致的(但描述中有”不保证完全一样、有变化的可能性”类似显著声明的除外); 3、发货:不发货可无理由退款; 4、安装:免费提供安装服务的源码但卖家不履行的; 5、收费:价格虚标,额外收取其他费用的(但描述中有显著声明或双方交易前有商定的除外); 6、其他:如质量方面的硬性常规问题BUG等。 注:经核实符合上述任一,均支持退款,但卖家予以积极解决问题则除外。
查看详情
  • 1、左子会对双方交易的过程及交易商品的快照进行永久存档,以确保交易的真实、有效、安全! 2、左子无法对如“永久包更新”、“永久技术支持”等类似交易之后的商家承诺做担保,请买家自行鉴别; 3、在源码同时有网站演示与图片演示,且站演与图演不一致时,默认按图演作为纠纷评判依据(特别声明或有商定除外); 4、在没有”无任何正当退款依据”的前提下,商品写有”一旦售出,概不支持退款”等类似的声明,视为无效声明; 5、在未拍下前,双方在QQ上所商定的交易内容,亦可成为纠纷评判依据(商定与描述冲突时,商定为准); 6、因聊天记录可作为纠纷评判依据,故双方联系时,只与对方在左子上所留的QQ、手机号沟通,以防对方不承认自我承诺。 7、虽然交易产生纠纷的几率很小,但一定要保留如聊天记录、手机短信等这样的重要信息,以防产生纠纷时便于左子介入快速处理。
查看详情

相关文章

猜你喜欢
发表评论
暂无评论
官方客服团队

为您解决烦忧 - 24小时在线 专业服务