Ajax 直接發送 PUT 請求，后端無法接收到數據的原因及解決方案

一、問題描述：

    使用 Ajax 直接發送 PUT 請求，但 Spring MVC 封裝的對象中，除過 URI 中帶有的 id 字段被成功封裝，請求體中的數據沒有被封裝到對象中。

    通過測試，前端傳來的請求體中有數據；通過 HttpServletRequest 對象，使用 request.getParameter() 方法卻也獲取不到數據

二、解決方案：

    在 web.xml 中添加 HttpPutFormContentFilter 過濾器，原理向下看：

<filter>
    <filter-name>httpPutFormContentFilter</filter-name>
    <filter-class>org.springframework.web.filter.HttpPutFormContentFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>httpPutFormContentFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

三、原因分析：

1. Tomcat 會將請求體中的數據封裝成一個 Map，調用 request.getParameter() 會從這個 Map 中取值，Spring MVC 封裝 POJO 對象時，對於對象中的每個屬性值也會調用 request.getParameter() 方法去獲取，然后賦值給對象相應的屬性，完成屬性封裝。

2. 但是，對於 PUT 請求，Tomcat 不會封裝請求體中的數據為一個 Map，只會將 POST 請求的請求體中數據封裝成 Map；這樣的話，無論是直接調用 request.getParameter() 方法，還是 Spring MVC 封裝對象，肯定都拿不到屬性值了。

四、源碼分析：

1. 在 Tomcat 源碼中 org.apache.catalina.connector 包的 Request.java 類中 parseParameters() 方法用來解析請求參數，方法先會進行一系列設置和判斷，然后再解析請求參數。其中，下面這段代碼就會判斷請求類型，如果符合 if 條件就會直接返回，也就是判斷 parseBodyMethod 中是不是包含當前的請求方式，如果包含，Tomcat 服務器就繼續處理解析請求體中的參數，封裝到 Map 中；如果不包含，就直接返回，而不再執行下面的方法解析參數，那么 Map 中也就沒有相應的參數了。

if( !getConnector().isParseBodyMethod(getMethod()) ) {
    success = true;
    return;
}

2. getConnector() 方法用來獲取當前連接對象，然后調用 isParseBodyMethod() 方法判斷 parseBodyMethodSet 集合中是不是包含傳進來的 method 的值，這個 method 值就是當前的請求方式。

/**
 * Request.java類中
 * 獲取當前的請求方式
 */
public String getMethod() {
    return coyoteRequest.method().toString();
}

/**
 * Connector.java類中
 */
protected boolean isParseBodyMethod(String method) {
     return parseBodyMethodsSet.contains(method);
}

3. parseBodyMethodSet 集合中一般使用的都是默認值，也就是相當於將 parseBodyMethods 的值賦給了 parseBodyMethodSet，而 parseBodyMethods 的值默認是 post。

/**
  * 調用 setParseBodyMethods 將 getParseBodyMethods() 獲取的 parseBodyMethods 的值賦值給
  * parseBodyMethods
  */
protected void initInternal() throws LifecycleException {

    // ...

    // Make sure parseBodyMethodsSet has a default
    if( null == parseBodyMethodsSet ) {
        setParseBodyMethods(getParseBodyMethods());
    }

    // ...
}

/**
 * 獲取 parseBodyMethods 的值
 */
protected String parseBodyMethods = "POST";

public String getParseBodyMethods() {
    return this.parseBodyMethods;
}

/**
 * 定義連接器的規則，如果連接器允許解析非POST請求的請求體，就傳入規則，默認都是沒有的
 * 所以 parseBodyMethodSet 使用的是默認值
 * 將 methods 的值賦值給 parseBodyMethods
 * 將 methodSet 的值賦值給 parseBodyMethodsSet
 */
public void setParseBodyMethods(String methods) {

    HashSet<String> methodSet = new HashSet<String>();

    if( null != methods ) {
        methodSet.addAll(Arrays.asList(methods.split("\\s*,\\s*")));
    }

    // ...

    this.parseBodyMethods = methods;
    this.parseBodyMethodsSet = methodSet;
}

4. 通過前面幾步分析，parseBodyMethodSet 中默認只有 post，也只有當前請求方式是 post 的時候才會解析參數，因此，不管是直接通過 Request 對象的 getParameter() 還是 Spring MVC 封裝 POJO 對象都不會獲取到參數值。

五、HttpPutFormContentFilter 過濾器原理

/**
 * 封裝請求體數據，重新包裝 Request 對象
 */
protected void doFilterInternal(final HttpServletRequest request, HttpServletResponse 	response, FilterChain filterChain) throws ServletException, IOException {
    // 當是 put 請求或 patch 請求的時候
    if (("PUT".equals(request.getMethod()) || "PATCH".equals(request.getMethod())) && this.isFormContentType(request)) {
        HttpInputMessage inputMessage = new ServletServerHttpRequest(request) {
            // 獲取請求體中的數據流，封裝成HttpInputMessage
            public InputStream getBody() throws IOException {
                return request.getInputStream();
            }
        };

        // 將上一步封裝的 HttpInputMessage 讀取封裝成一個MultiValueMap 對象，
        // 這個對象繼承自 Map
        // 將請求體中的數據封裝成 Map
        MultiValueMap<String, String> formParameters = this.formConverter.read((Class)null, inputMessage);

        // 使用 HttpPutFormContentRequestWrapper 重新包裝 Request 對象
        HttpServletRequest wrapper = new HttpPutFormContentFilter.HttpPutFormContentRequestWrapper(request, formParameters);
        filterChain.doFilter(wrapper, response);
    } else {
        filterChain.doFilter(request, response);
    }
}

/**
 * 包裝 Request 對象具體實現
 * 重寫父類的 getParameter() 等方法，先調用父類的方法
 * 如果能獲取到就是用父類獲取的；
 * 如果獲取不到，就是用當前類獲取的。
 */
private static class HttpPutFormContentRequestWrapper extends 	HttpServletRequestWrapper {
      private MultiValueMap<String, String> formParameters;

      public String getParameter(String name) {
             String queryStringValue = super.getParameter(name);
             String formValue = (String)this.formParameters.getFirst(name);
             return queryStringValue != null ? queryStringValue : formValue;
      }

      // ...
}