Spring-web源码解析之Filter-CharacterEncodingFilter

基于4.1.7.RELEASE

在web.xml我们经常看见这么一段

<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>
</filter>

这里注册了一个字符串编码的Filter，下面我们就来看看CharacterEncodingFilter的源码，首先看看类图

CharacterEncodingFilter并不是直接实现Filter接口，而是继承了OncePerRequestFilter，其作用稍后再讲。

CharacterEncodingFilter含有两个属性，一个是在web.xml中经常出现的encoding，它指明了用于设置request的encoding的值

另一个是foreceEncoding，默认为false，如果设置为true它就会使encoding属性强制替换掉request中的encoding值，而不管request获取的encoding是否为空。

下面看其主要的方法

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);
}

上面说过encoding是设置request的编码，而这个方法就是具体实现过程。如果设置了forceEncoding，还会同时将response的默认编码设置为encoding。