Spring MVC的Post請求引數中文亂碼的原因&處理

一、專案配置：

1. Spring 4.4.1-RELEASE
2. Jetty 9.3.5
3. JDK 1.8
4. Servlet 3.1.0
5. web.xml檔案中沒有配置編解碼Filter

二、實際遇到的問題：
客戶端(比如java)傳送post請求訪問介面，資料放在body裡面，每個引數utf-8編碼。
從body裡面取出的中文引數是亂碼。

---

下面是傳送請求的程式碼和服務端接收請求的程式碼。

• 客戶端程式碼。
  這是一個真實的第三方訪問API的案例，這段程式碼請求到PHP系統正常，請求到java系統就會出現亂碼。
  但是中文引數放到URL中解碼正常，放到請求體中就是亂碼。
  通過httpclient4.1傳送Post請求如下：

  public static void postData(String sign, String timestamp) {    // 建立預設的httpClient例項.    
    CloseableHttpClient httpclient=null;   
    String result="";    
    try {        
        httpclient = HttpClients.createDefault();        
        String url = "http://example/api/entry";            
        HttpPost httpPost = new HttpPost(url);        //設定請求和傳輸超時時間        
        RequestConfig requestConfig = RequestConfig.custom().setSocketTimeout(6000).setConnectTimeout(6000).build();        
        httpPost.setConfig(requestConfig);        
        MultipartEntity entity = new MultipartEntity(HttpMultipartMode.BROWSER_COMPATIBLE);        
        entity.addPart("app_id", new StringBody("c5eb3ba8c0e7326559", Charset.forName("utf-8")));        
        entity.addPart("method", new StringBody("kdt.item.add", Charset.forName("utf-8")));        
        entity.addPart("timestamp", new StringBody(timestamp));        
        entity.addPart("format", new StringBody("json", Charset.forName("utf-8")));        
        entity.addPart("v", new StringBody("1.0", Charset.forName("utf-8")));        
        entity.addPart("sign", new StringBody(sign, Charset.forName("utf-8")));        
        entity.addPart("sign_method", new StringBody("md5", Charset.forName("utf-8")));        
        entity.addPart("cid", new StringBody("5000000", Charset.forName("utf-8")));        
        entity.addPart("tag_ids", new StringBody("0", Charset.forName("utf-8")));        
        entity.addPart("price", new StringBody("0.01", Charset.forName("utf-8")));        
        entity.addPart("title", new StringBody("測試", Charset.forName("utf-8")));        
        entity.addPart("desc", new StringBody("test1", Charset.forName("utf-8")));        //是否是虛擬商品。0為否，1為是。目前不支援虛擬商品        
        entity.addPart("is_virtual", new StringBody("0", Charset.forName("utf-8")));        
        entity.addPart("post_fee", new StringBody("0.0", Charset.forName("utf-8")));        //Sku的屬性串。格式：pText:vText;pText:vText，多個sku之間用逗號分隔，如：顏色:黃色;尺寸:M,顏色:黃色;尺寸:S。pText和vText文字中不可以存在冒號和分號以及逗號        
        entity.addPart("sku_properties", new StringBody("color:white", Charset.forName("utf-8")));        
        entity.addPart("sku_quantities", new StringBody("998,999", Charset.forName("utf-8")));        
        entity.addPart("sku_prices", new StringBody("0.01,0.02", Charset.forName("utf-8")));        
        entity.addPart("sku_outer_ids", new StringBody("null,null", Charset.forName("utf-8")));        //該商品的外部購買地址。當使用者購買環境不支援微信或微博支付時會跳轉到此地址        
        entity.addPart("buy_url", new StringBody("http://img.cdn.sb.hongware.com/1461836641703511.gif", Charset.forName("utf-8")));        
        entity.addPart("quantity", new StringBody("1998", Charset.forName("utf-8")));        //寶貝修改的時候需要這個引數        
        httpPost.setEntity(entity);        
        CloseableHttpResponse response = httpclient.execute(httpPost);       
        try {            
              HttpEntity httpEntity = response.getEntity();            
              System.out.println(httpEntity.getContent());            
              InputStream content = httpEntity.getContent();            
              BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(content));            
              String line;            
              while ( (line=bufferedReader.readLine()) != null) {                
                  System.out.println(line);            
              }        
        } catch (Exception e) {            
              e.printStackTrace();        
        } finally {            
              response.close();        
        }    
    } catch (Exception e) {        
        e.printStackTrace();    
    } finally {        
        try {            
            httpclient.close();        
        } catch (Exception e) {            
            // TODO Auto-generated catch block            
            e.printStackTrace();        
        }    
    }
  }

• 服務端程式碼如下
  為了簡化演示，我把引數提取程式碼Map<String, String[]> parameterMap = request.getParameterMap()冗餘在這個入口函式中，以便說明問題：

  @RequestMapping(value = "/api/entry", produces = "application/json;charset=utf-8")
  public DeferredResult<Object> sign(HttpServletRequest request,HttpServletResponse response) {    
      DeferredResult<Object> deferredResult = new DeferredResult<>();    
      Map<String, String[]> parameterMap = request.getParameterMap();  
      String method = request.getParameter("method");    
      if (StringUtils.isEmpty(method)) {        
        ResponseEntity<String> responseEntity = new ResponseEntity<String>(                String.format(Constants.ERROR_RESPONSE, 50000, "service or method is null"),                HttpStatus.valueOf(200));        
        deferredResult.setResult(responseEntity);        
        return deferredResult;    
      }    
      int lastIndex = method.lastIndexOf(".");    
      String service = method.substring(0, lastIndex);    
      method = method.substring(lastIndex + 1);    
      event.setService(service);    
      event.setMethod(method);    
      event.setResult(deferredResult);    
      proxy.doAction(request,response,event);    
      return deferredResult;
  }

服務端通過Map<String, String[]> parameterMap = request.getParameterMap()取出所有引數，傳進來title引數是亂碼！！

三、根本原因
Servlet 3.0規範中有關請求資料編碼的解釋如下：

當前很多瀏覽器並不傳送帶Content-Type頭部的字元編碼識別符號，它會把字元編碼的決定留在讀取HTTP請求的時候。如果客戶端沒有指明編碼，容器用來建立請求讀和解析POST資料的預設編碼必須是"ISO-8859-1"。然而，為了提示開發者客戶端沒有成功傳送一個字元編碼，容器中getCharacterEncoding方法會返回null。
如果客戶端沒有設定字元編碼，並且請求資料使用了不同編碼而不是上述的預設編碼，程式將會出現中斷。為了糾正這種狀態，一個新的方法setCharacterEncoding(String enc) 被新增到ServletRequest介面。開發者呼叫這個方法能重寫容器提供的字元編碼。這個方法必須在解析request中任何post資料或者讀任何輸入之前呼叫。一旦資料已經被讀取，呼叫這個方法不會影響它的編碼。

另外一種相同的解釋:

網路上同樣含義的解釋

四、3種解決方法

1. 在web.xml中配置編解碼Filter

    <filter>    
      <filter-name>encodingFilter</filter-name>    
      <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>    
       <init-param>        
          <param-name>encoding</param-name>        
          <param-value>UTF-8</param-value>    
       </init-param>    
       <init-param>        
          <param-name>forceEncoding</param-name>        
          <param-value>true</param-value>    
       </init-param>    
       <async-supported>true</async-supported>
    </filter>
    <filter-mapping>    
        <filter-name>encodingFilter</filter-name>    
        <url-pattern>/*</url-pattern>
    </filter-mapping>

   關於這段配置需要強調兩點：
   • web.xml中，這段配置要放在所有filter的最前面，否則會不生效，根本原因請見上述第三點的解釋。
   • 兩個初始化引數的作用，其實看這個Filter的原始碼就一目瞭然，這兩個引數是用來決定是否要設定request和response中的編碼。原始碼很簡潔：

      public class CharacterEncodingFilter extends OncePerRequestFilter {    
          private String encoding;    
          private boolean forceEncoding = false;    
          public CharacterEncodingFilter() { }    
          public void setEncoding(String encoding) {        
              this.encoding = encoding;    
          }    
          public void setForceEncoding(boolean forceEncoding) {        
              this.forceEncoding = forceEncoding;    
          }    
          protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {        
              if(this.encoding != null && (this.forceEncoding || request.getCharacterEncoding() == null)) {            
                  request.setCharacterEncoding(this.encoding);            
                  if(this.forceEncoding) {                
                      response.setCharacterEncoding(this.encoding);            
                  }        
               }        
               filterChain.doFilter(request, response);    
          }
      }

2. 設定Content-Type
   如果post請求方式是x-www-form-urlencoded，那麼設定如下：
   Content-Type=application/x-www-form-urlencoded;charset=utf-8
   這樣通過request物件取body體裡面的中文是正常的。
   這種方式有一點需要注意： 如果請求方式是multipart/form-data，如上設定會導致request取不到引數。Content-Type要與傳遞資料匹配（本文data）
3. 手動編解碼
   比如引數title="測試"，這樣取出來就是"測試"。

    String str = new String(request.getParameter("title").getBytes("iso-8859-1"), "utf-8");

綜上所有，最優雅的方式是第一種解決方案--通過框架的Filter去處理。
你僅專注於業務程式碼就好。

參考資料

1. ajax post data獲取不到資料
2. Servlet 3.0規範
3. HTTP Content-Type常用對照表
4. Spring官網--Consumable Media Types章節
5. ISO-8859-1
6. ISO-8859-1為何能顯示中文
7. 字元編碼
8. Media Type