解決偶現的MissingServletRequestParameterException異常問題

Posted on by

概述

最近遇到一個偶現的問題，在向服務端請求的時候，偶爾會出現異常，在請求中的query String 傳遞瞭參數，卻出現瞭異常MissingServletRequestParameterException

如下所示：

018-02-05 11:29:34.910 ERROR 41469 --- [a626f375-7f79-4fd2-88be-1db10a3811cb-] [nio-8080-exec-7] c.s.s.f.ValidationGlobalExceptionHandler : org.springframework.web.bind.MissingServletRequestParameterException: Required long parameter 'xxx' is not present
    at org.springframework.web.method.annotation.RequestParamMethodArgumentResolver.handleMissingValue(RequestParamMethodArgumentResolver.java:198)
    at org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver.resolveArgument(AbstractNamedValueMethodArgumentResolver.java:109)
    at org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:121)
    at org.springframework.web.method.support.InvocableHandlerMethod.getMethodArgumentValues(InvocableHandlerMethod.java:158)
    at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:128)
    at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:97)
    at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:827)
    at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:738)
    at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:85)
    at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:963)
    at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:897)
    at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:970)
    at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:861)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:635)
    at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:846)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:742)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:231)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:52)

在請求中顯然是帶瞭這個參數的，開始時還以為自己眼花，於是又試瞭一下，結果接口返回又正常瞭。

但是，既然錯誤日志出現瞭，就不能輕易地放過，尤其是這種偶現的錯誤，充滿著風險，極有可能在某個關鍵時刻爆發。因此決定抽出時間排查這個問題。接下來，就是整個排查過程。

排查過程

具體的請求如下所示：

curl -X GET --header "Accept: */*" http://localhost:8080/xxx/api/v3/xxx/getXX?param=123456

其中param在Controller的方法中被聲明為required=true，也就是必傳參數，而在前後端交互裡，這個參數也是一定會傳的。

既然這是一個偶現的問題，就不可能通過手動一次次地調用請求進行問題的重現。在這裡我采用瞭Jmeter作為請求觸發器，進行30次一批的重復請求，結果在跑第一次的時候，就出現瞭一次請求異常。

反復跑瞭兩三次之後，都出現瞭同樣的結果，既然問題已經確認，並且能夠穩定重現，接下來就是如何找到問題的根源並解決這個問題瞭。

因為有具體的異常類，所以我的第一想法就是在這個異常類的構造函數中加斷點，看看為什麼會拋出這個異常。通過調用棧，在RequestParamMethodArgumentResolver(AbstractNamedValueMethodArgumentResolver)中發現如下代碼片段

        Object arg = resolveName(resolvedName.toString(), nestedParameter, webRequest); //在RequestParamMethodArgumentResolver中，直接通過調用request.getParameterValues(name)來獲取普通請求的參數
        if (arg == null) {
            if (namedValueInfo.defaultValue != null) {
                arg = resolveStringValue(namedValueInfo.defaultValue);
            }
            else if (namedValueInfo.required && !nestedParameter.isOptional()) {
                handleMissingValue(namedValueInfo.name, nestedParameter, webRequest); //如果沒有獲取到且沒有默認值，就會在這裡拋出異常。
            }
            arg = handleNullValue(namedValueInfo.name, arg, nestedParameter.getNestedParameterType());
        }
        else if ("".equals(arg) && namedValueInfo.defaultValue != null) {
            arg = resolveStringValue(namedValueInfo.defaultValue);
        }

看到這裡的時候心裡不禁疑惑，難道真的沒傳參數？或者是參數在傳遞的過程丟瞭？或者…被框架吃瞭？！

但疑惑不是我想要的，答案才是我想要的。既然request.getParameterValues裡面沒有得到想要的值，那就應該去找正常請求時，這個值是如何被設置的。

首先想到的是查看Request的類圖結構。以及請求被處理的流程圖

Request類圖

Request處理流程圖

所以，最原始的數據被保存在瞭org.apache.coyote.Request這個類中，深入這個類，我們就能夠更接近答案。於是直接到瞭Http11Processor的service方法中，看具體的處理過程。首先在799行加斷點，看看是處理結果是什麼，由於問題是處在parameter上，直接查看此時request中parameters的各種值。

正常請求：

正常請求

異常請求：

異常請求

對比兩者不難發現，異常請求中的queryMB與正常請求中的是一樣的，也就是說我們請求中帶的參數被傳遞到瞭服務器。但異常請求didQueryParameters被置成瞭true，而從代碼中可以知道，這個代碼實際上是用於判斷query string是否已經被解析過瞭，並且，在請求處理結束的時候，會調用parameter的recycle方法

    public void recycle() {
        parameterCount = 0;
        paramHashValues.clear(); //清空瞭解析後的parameter map
        didQueryParameters=false; //是否被解析過，置成false
        encoding=null;
        decodedQuery.recycle();
        parseFailedReason = null;
    }

由於Tomcat中，Request以及Response對象都是會被循環使用的，因此這個時候也是整個Request被重置的時候。

所以根本原因是，在Parameter被重置瞭之後，didQueryParameters又被置成瞭true，導致新的請求參數沒有被正確解析，就報錯瞭（此時的parameterMap已經被重置，為空）。

而didQueryParameters隻有在一種情況下才會被置為true，也就是handleQueryParameters方法被調用時。

而handleQueryParameters會在多個場景中被調用，其中一個就是getParameterValues，獲取請求參數的值。

到這裡，就可以推斷，應用中可能存在代碼，在請求結束之後，仍然通過Request對象獲取其中的參數值。

全局搜索引用瞭HttpServletRequest的地方。最終發現埋點類中有如下代碼

@Async
    public void buryPoint(long userId, HttpServletRequest request.....) {
        if (request != null) {
           xxx = request.getParameter("xxx");
        }

由於這段邏輯是異步執行的，因此完全有可能在請求結束之後，仍然調用request.getParameter方法，導致下一次的請求參數不被解析。將此段代碼註釋掉，重新使用Jmeter進行請求，錯誤不再出現。

結論

不要將HttpServletRequest傳遞到任何異步方法中！

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：