Spring字符集过滤器CharacterEncodingFilter

Spring中的字符集过滤器可以很方便的为我们解决项目中出现的中文乱码问题，而且使用方法也很简单，只需要在web.xml文件中配置一下该过滤器，设置两个重要的参数（encoding和forceEncoding）即可：

 

 

 

 

<!-- 配置请求过滤器 ，编码格式设为UTF-8，避免中文乱码-->

    <filter>

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

    </filter>

    <filter-mapping>

       <filter-name>springUtf8Encoding</filter-name>

       <url-pattern>/*</url-pattern>

 </filter-mapping>

 

 以下是

Spring字符集过滤器的源码：

 

 

 

public class CharacterEncodingFilter extends OncePerRequestFilter {

 

    private String encoding;

 

    private boolean forceEncoding = false;

 

 

    /**

     * Set the encoding to use for requests. This encoding will be passed into a

     * {@link javax.servlet.http.HttpServletRequest#setCharacterEncoding} call.

     * <p>Whether this encoding will override existing request encodings

     * (and whether it will be applied as default response encoding as well)

     * depends on the {@link #setForceEncoding "forceEncoding"} flag.

     */

    public void setEncoding(String encoding) {

       this.encoding = encoding;

    }

 

    /**

     * Set whether the configured {@link #setEncoding encoding} of this filter

     * is supposed to override existing request and response encodings.

     * <p>Default is "false", i.e. do not modify the encoding if

     * {@link javax.servlet.http.HttpServletRequest#getCharacterEncoding()}

     * returns a non-null value. Switch this to "true" to enforce the specified

     * encoding in any case, applying it as default response encoding as well.

     * <p>Note that the response encoding will only be set on Servlet 2.4+

     * containers, since Servlet 2.3 did not provide a facility for setting

     * a default response encoding.

     */

    public void setForceEncoding(boolean forceEncoding) {

       this.forceEncoding = forceEncoding;

    }

 

 

    @Override

    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和forceEncoding，这两个参数分别有什么作用呢？

 

 

以下是参考文档的介绍： 

lsetEncoding

public void setEncoding(java.lang.String encoding)

Set the encoding to use for requests. This encoding will be passed into a ServletRequest.setCharacterEncoding(java.lang.String) call.

 

lsetForceEncoding

public void setForceEncoding(boolean forceEncoding)

Set whether the configured encoding of this filter is supposed to override existing request and response encodings.

通过参考文档，我们可以知道：

l  第一个方法setEncoding()相当于：ServletRequest.setCharacterEncoding(java.lang.String)

l  第二个方法setForceEncoding()的作用是：

强制ServletResponse的编码格式和ServletRequest的编码格式一样。

也就是说，无论是request还是response，encoding设置了两者的编码格式，只不过forceEncoding默认值为false，此时就只是设置了request的编码格式，即在Servlet中：

 

request.setCharacterEncoding("XXXX");  

 

 

 

如果设置forceEncoding的值为true时，相当于Servlet中：

 

request.setCharacterEncoding("XXXX");

response.setCharacterEncoding(“XXXX”);  

 

现在我们回过头来看看最初给大家看的web.xml中那部分过滤器的配置，相信大家都明白了，配置的作用相当于Servlet中的：

@RequestMapping(value="XXXXX")
public void XXXXMethod(User user,HttpServletRequest req,HttpServletResponse resp) throws UnsupportedEncodingException
{
		resp.setCharacterEncoding("UTF-8");
		req.setCharacterEncoding("UTF-8");
......
}

 

 

    因此，在请求处理的过程中我们可以不用考虑编码方面的问题，上面两句代码可以省略，编码统一交给Spring过滤器去处理，我们可以专心处理我们的业务逻辑代码，这就是Spring字符集过滤器的方便之处。