Java Web亂碼分析 -- 響應亂碼

響應亂碼

請求亂碼是客戶端向伺服器傳送資料時，伺服器解碼錯誤。響應亂碼則是伺服器處理完請求後，輸出到瀏覽器的資料被瀏覽器錯誤解碼造成的顯示亂碼，這類亂碼是最常見也是最直接的。

• 造成這類亂碼大部分情況是：伺服器對Content-Type設定錯誤。

技巧和解決方案

出現亂碼時，定位方式技巧：

• 首先確定瀏覽器實際使用的編碼和ContentType指定值是否一致;
• 如果不一致，則調整Conent-Type值，看是否是瀏覽器不支援或者語法錯誤；
• 如果一致，調整pageEncoding的值一般都可以解決亂碼的。

出現響應出現亂碼的解決方案，修改兩個地方：

• 呼叫Response.setContentType設定MIME和字元編碼;
• 修改頁面的HTML標籤，二者保持一致就可以了；
• 對於靜態頁面要確定檔案儲存時的編碼和HTML標籤指定的編碼要一致；
• 對於JSP檔案還要記得多調整一個pageEncoding。

Tomcat官方給出的建議：

• 整個工程統一使用UTF-8作為字符集，它能在所有situation中都完美的工作，為了能徹底的使用UTF-8，你需要做如下的設定：

 （1）在server.xml的connector中設定URIEncoding=“UTF-8”；
 （2）使用Tomcat提供的CharsetEncodingFilter（和Spring MVC的差不多）；
 （3）在JSP頁面的page指令中設定content-type=”text/html;charset=utf-8”; 或者jsp:directive.page contentType="text/html; charset=UTF-8";
 （4）在所有Servlet中都呼叫setContentType為“text/html;charset=utf-8”或者setCharsetEncoding方法設定Content-Type的編碼為UTF-8;
 （5）設定所有模板技術（比如FreeMarker、Velocity等）使用UTF-8，或明確的指定響應頭的Content-Type為UTF-8；
 （6）在你的字元編碼過濾器工作前，不要讓任何的其他Filter讀取Request的引數。
 

頁面資料亂碼分析

靜態頁面亂碼

靜態頁面：即我們用IDE編寫的頁面（比如.html），作為一個檔案，頁面在編寫的時候就需要指定一個字元編碼； 比如有些IDE預設的編碼格式是ISO-8859-1，此編碼是不支援中文字元的，檔案儲存時候即出現亂碼。

通常情況下，我們會有以下兩點規定：

• 所有檔案統一使用UTF-8儲存檔案（unicode編碼的一種實現）；
• 頁面中設定meta標籤的Content-Type設定為UTF-8編碼就不會出現問題了。

動態頁面亂碼

動態頁面：程式動態輸出的頁面，比如模板技術、JSP、Servlet拼裝的頁面，這類技術一般都會保持一致的編碼，比如java用unicode，所以輸出的中文是沒問題的。

容易出現問題的地方就是我們沒有給瀏覽器設定編碼格式，即忘記設定Content-Type。

JSP頁面引數

使用JSP模板技術，有兩個引數影響編碼:pageEncoding和contentType。

pageEncoding

指定的是頁面編碼，該值編碼影響的是JSP檔案編譯為java和class檔案時，容器讀取JSP檔案內容時使用的編碼；

比如我們的JSP檔案用UTF-8儲存到本地磁碟，但是pageEncoding使用的是ISO-8859-1，JSP被預編譯為class檔案時會出現亂碼，JSP首先被翻譯拼接為Java檔案，讀取時IO流使用ISO-8859-1讀取檔案，發生亂碼；

contentType

指定瀏覽器解析頁面時應該使用的編碼;

這個值是給瀏覽器看的，可以認為是瀏覽器接收到資料後，IO流的讀取格式；

二者關係：

雖然pageEncoding和contentType的關係有點亂，但是一般來說它們的設定是有關聯的：

• 一般二者的設定是聯動的，很多Web容器在設定了一個屬性後，另外一個屬性也會自動設定為一致的編碼值；
• 在JSP中兩個值得預設值都是ISO-8859-1；
• 實際開發時，我們都會把這兩個屬性值設定為一致的，如UTF-8；

Content-Type響應報頭

頁面在服務端構成之後，就要傳輸給瀏覽器了，這個時候伺服器會首先構建響應報頭；

大部分的響應報頭是容器自己處理的，我們無需關係，比如Content-Language、Content-Length等。

作用

Content-Type：告訴客戶端，Http響應包的實體主體是什麼媒體型別（MIME）。

Web瀏覽器通過Content-Type來確定用什麼模組處理響應的主體，同時通過附加的charset引數確定檔案的編碼型別，然後瀏覽器呼叫相應的模組和編碼方案解碼響應主體的檔案。

設定方式

在伺服器端通過呼叫response.setContentType()方法可以設定這個報頭的屬性。

注意，我們這裡討論的是HTTP協議，但是很多Web容器不會只支援HTTP協議，HTTP協議只是它的一種情況，所以會有很多奇怪的API和資料格式；

setContentType、setCharsetEncoding和setLocale 三者之間關係

• setContentType：設定Content-Type值，可以順帶指定charset，順帶設定後，setCharsetEncoding可以不呼叫；
• setCharsetEncoding：設定Content-Type的字元編碼部分，二者是覆蓋關係；
  • setContentType和setCharsetEncoding誰最後設定誰生效；
• setLocale：設定的是Content-Language，國際化中設定區域，不重要，可以不理它，
  • 如果設定了Content-Type，Content-Language就失效了。

一般的響應頭格式如下：

content-type : text/html;charset=UTF-8

Java HttpServletResponse API

response的API開頭就有如下說明：

The charset for the MIME body response canbe specified explicitly using the setCharacterEncoding(java.lang.String) andsetContentType(java.lang.String) methods, or implicitly using thesetLocale(java.util.Locale) method. Explicit specifications take precedenceover implicit specifications. 

If no charset is specified, ISO-8859-1 will beused. The setCharacterEncoding, setContentType, or setLocale method must becalled before getWriter and before committing the response for the characterencoding to be used. See the Internet RFCs such as RFC 2045 formore information on MIME. Protocols such as SMTP and HTTP define profiles ofMIME, and those standards are still evolving.

翻譯後的大概意思：

影響Response Body的字元編碼的方法有三個，setContentType、setCharsetEncoding以及setLocale。 

Tomcat官方給出的建議：

What canyou recommend to just make everything work? (How to use UTF-8 everywhere). Using UTF-8 asyour character encoding for everything is a safe bet. This should work forpretty much every situation.

In order to completelyswitch to using UTF-8, you need to make the following changes:

1.Set URIEncoding="UTF-8" onyour in server.xml.References: HTTPConnector, AJPConnector.

2.Use a characterencoding filter withthe default encoding set to UTF-8;

3.Change all your JSPs to include charset name in their contentType.

For example, use <%@page contentType="text/html; charset=UTF-8" %> forthe usual JSP pages and forthe pages in XML syntax (aka JSP Documents).

4.Change all your servlets to set the content type for responses and to include charset name in the content type to be UTF-8.Use response.setContentType("text/html;charset=UTF-8") or response.setCharacterEncoding("UTF-8").

5.Change any content-generation libraries you use (Velocity, Freemarker, etc.) to use UTF-8 and to specify UTF-8 in the content type of the responses that they generate.

6.Disable any valves or filtersthat may read request parameters before your character encoding filter or jsppage has a chance to set the encoding to UTF-8. For more information see http://www.mail-archive.com/[email protected]/msg21117.html.

附註——Response的API

response.setContetType

Sets the content type of the response beingsent to the client, if the response has not been committed yet. The givencontent type may include a character encoding specification, for example, text/html;charset=UTF-8.The response's character encoding is only set from the given content type ifthis method is called before getWriter is called.

This method may be called repeatedly tochange content type and character encoding. This method has no effect if calledafter the response has been committed. It does not set the response's characterencoding if it is called after getWriter has been called or after theresponse has been committed.

Containers must communicate the content typeand the character encoding used for the servlet response's writer to the clientif the protocol provides a way for doing so. In the case of HTTP, the Content-Type headeris used.

翻譯： 

如果response還沒有發生，那麼在傳送response給客戶端之前設定response的content type，設定的content type可以包含字元編碼，比如：text/html;charset=UTF-8。如果在getWriter被呼叫之前呼叫了這個方法，那麼response的編碼將會根據給定的content type設定。

這個方法可以被重複的呼叫來改變content type和字元編碼。如果在response提交之後呼叫，這個方法是無效的。如果在getWriter被呼叫之後或response提交之後呼叫這個方法，對response字元編碼的設定也不會起作用。

如果協議提供了和客戶端通訊的content type的方式，那麼容器將使用response的wirter向容器傳送關於content type和字元編碼的資訊。在http協議下使用的是Content-Type報頭。

reqponse.setCharsetEncoding

Sets the character encoding (MIME charset)of the response being sent to the client, for example, to UTF-8. If thecharacter encoding has already been set by setContentType(java.lang.String) or setLocale(java.util.Locale),this method overrides it. Calling setContentType(java.lang.String) withthe String of text/html and calling this method with the String of UTF-8 isequivalent with calling setContentType with the String of text/html;charset=UTF-8.

This method can be called repeatedly tochange the character encoding. This method has no effect if it is called after getWriter hasbeen called or after the response has been committed.

Containers must communicate the characterencoding used for the servlet response's writer to the client if the protocolprovides a way for doing so. In the case of HTTP, the character encoding iscommunicated as part of the Content-Type header for text media types.Note that the character encoding cannot be communicated via HTTP headers if theservlet does not specify a content type; however, it is still used to encodetext written via the servlet response's writer.

翻譯：

在response被髮送給客戶端之前，設定字元編碼型別（MIME的字元),例如，使用“UTF-8”編碼。如果字元編碼已經通過setContentType或者setLocale設定了，這個方法將會覆蓋他們。下面的呼叫是相等的，呼叫setContentType設定content Type為text/html，呼叫setCharsetEncoding設定字元編碼為UTF-8，等同於呼叫setContentType設定content Type為text/html;charset=utf-8

可以重複呼叫這個方法，但是必須在getWriter之前或者response被提交之前。

容器會把字元編碼告訴客戶端，如果協議提供了相應的通訊方式。在HTTP協議下，字元編碼作為Content –Type報頭的一部分提供給客戶端。值得注意的是如果servlet沒有指定content type，那麼字元編碼將不會通過Http協議傳送給客戶端，但是傳送給客戶端的文字仍然會用給定的字符集編碼。