快捷導(dǎo)航

springmvc字符編碼過(guò)濾器CharacterEncodingFilter的使用

更新時(shí)間：2021年08月12日 14:46:35 作者：lianjunzongsiling

這篇文章主要介紹了springmvc字符編碼過(guò)濾器CharacterEncodingFilter的使用，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。

字符編碼過(guò)濾器CharacterEncodingFilter

一、在web.xml中的配置

 <!-- characterEncodingFilter字符編碼過(guò)濾器 -->
 <filter>
  <filter-name>characterEncodingFilter</filter-name>
  <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
  <init-param>
   <!--要使用的字符集，一般我們使用UTF-8(保險(xiǎn)起見UTF-8最好)-->
   <param-name>encoding</param-name>
   <param-value>UTF-8</param-value>
  </init-param>
  <init-param>
   <!--是否強(qiáng)制設(shè)置request的編碼為encoding，默認(rèn)false，不建議更改-->
   <param-name>forceRequestEncoding</param-name>
   <param-value>false</param-value>
  </init-param>
  <init-param>
   <!--是否強(qiáng)制設(shè)置response的編碼為encoding，建議設(shè)置為true，下面有關(guān)于這個(gè)參數(shù)的解釋-->
   <param-name>forceResponseEncoding</param-name>
   <param-value>true</param-value>
  </init-param>
 </filter>
 <filter-mapping>
  <filter-name>characterEncodingFilter</filter-name>
  <!--這里不能留空或者直接寫 ' / ' ，否者不起作用-->
  <url-pattern>/*</url-pattern>
 </filter-mapping>

二、CharacterEncodingFilter過(guò)濾器類淺析

打開該類源碼，可以看到該類有三個(gè)類屬性

private String encoding; //要使用的字符集，一般我們使用UTF-8(保險(xiǎn)起見UTF-8最好)
private boolean forceRequestEncoding = false; //是否強(qiáng)制設(shè)置request的編碼為encoding
private boolean forceResponseEncoding = false; //是否強(qiáng)制設(shè)置response的編碼為encoding

主要方法只有一個(gè)，也就是下面這個(gè)，代碼邏輯很簡(jiǎn)單，如注釋所解釋

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        String encoding = getEncoding();
        if (encoding != null) { //如果設(shè)置了encoding的值，則根據(jù)情況設(shè)置request和response的編碼
         //若設(shè)置request強(qiáng)制編碼或request本身就沒(méi)有設(shè)置編碼
         //則設(shè)置編碼為encoding表示的值
            if (isForceRequestEncoding() || request.getCharacterEncoding() == null) { 
                request.setCharacterEncoding(encoding);
            }
         //若設(shè)置response強(qiáng)制編碼，則設(shè)置編碼為encoding表示的值
            if (isForceResponseEncoding()) { //請(qǐng)注意這行代碼，下面有額外提醒
                response.setCharacterEncoding(encoding);
            }
        }
        filterChain.doFilter(request, response);
    }

# 額外提醒
if (isForceResponseEncoding()) { 
 response.setCharacterEncoding(encoding);
}

是在

filterChain.doFilter(request, response);

之前執(zhí)行的，這也就是說(shuō)這段代碼的作用是設(shè)置response的默認(rèn)編碼方式，在之后的代碼里是可以根據(jù)需求設(shè)置為其他編碼的，即這里設(shè)置的編碼可能不是最終的編碼，網(wǎng)上很多文檔說(shuō)這里設(shè)置的是最終的編碼方式，這是錯(cuò)的。

SpringMVC配置字符編碼過(guò)濾器CharacterEncodingFilter來(lái)解決表單亂碼問(wèn)題

1、GET請(qǐng)求

針對(duì)GET請(qǐng)求，可以配置服務(wù)器Tomcat的conf\server.xml文件，在其第一個(gè)<Connector>標(biāo)簽中，添加URIEncoding="UTF-8"即可，如下所示：

<Connector URIEncoding="UTF-8" port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" />

2、POST請(qǐng)求

但是，針對(duì)POST請(qǐng)求，僅配置Tomcat的server.xml文件中的<Connector標(biāo)簽不足以解決亂碼問(wèn)題，因此，需要利用Spring的字符編碼過(guò)濾器：

org.springframework.web.filter.CharacterEncodingFilter

步驟：配置所開發(fā)項(xiàng)目的web.xml文件，添加以下內(nèi)容至文件開頭處即可：

<!-- ================start 配置spring的字符編碼過(guò)濾器================ -->    
    <filter>
        <!-- 解決post亂碼問(wèn)題需要配置spring編碼過(guò)濾器 -->
        <filter-name>characterEncoding</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>
    </filter>
    <filter-mapping>
        <filter-name>characterEncoding</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
<!-- ================end 配置spring的字符編碼過(guò)濾器================ -->

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: