org.springframework.web.filter.CharacterEncodingFilter

感谢：http://blog.csdn.net/heidan2006/article/details/3075730

很简单很实用的一个过滤器，当前台JSP页面和JAVA代码中使用了不一样的字符集进行编码的时候就会出现表单提交的数据或者上传/下载中文名称文件出现乱码的问题，那这个类就能够出场了。

        从名字就能够看出来它是个过滤器了，因此就要想配置普经过滤器那样配置到web.xml中去了，配置方式以下：

1.         <filter>
2.                 <filter-name>encodingFilter</filter-name>
3.                     <filter-class>
4. org.springframework.web.filter.CharacterEncodingFilter
5.                     </filter-class>
6.                 <init-param>
7.                     <param-name>encoding</param-name>
8.                     <param-value>UTF-8</param-value>
9.                 </init-param>
10. <init-param>
11.                     <param-name>forceEncoding</param-name>
12.                     <param-value>false</param-value>
13.                </init-param>
14.         </filter>
16.         <filter-mapping>
17.                 <filter-name>encodingFilter</filter-name>
18.                 <url-pattern>/*</url-pattern>
19.        </filter-mapping>

        和普经过滤器配置没什么区别，就是多了两个初始化参数，两个参数的做用分别是：

    encoding----->用来指定一个具体的字符集

    forceEncoding------->Spring的早期版本这个参数做用很单一，当request中已经被指定了一个字符集的时候是否再将用endcoding对应的字符集设置到request中去。举个例子来讲明，假如说过滤器就像上面那样被配置到web.xml了，当请求被提交以后，过滤器会判断request.getCharacterEncoding()是否为null，若是是null那么就会进行request.setCharacterEncoding("UTF-8")的操做，若是不是null那么过滤器什么也不会作。

    不过Spring目前得版本这个类的代码已经被重构了，代码更加“漂亮”了，这个参数的做用也发生了细微的改变。

    为了加深印象从源码来分析一下这个参数的变化。

    首先，说明 一下CharacterEncodingFilter是继承OncePerRequestFilter抽象类而来的，OncePerRequestFilter实现了doFilter方法：

1. public final void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain)
2.    throws ServletException, IOException {
4.          ...........
6.          ...........
8.       String alreadyFilteredAttributeName = getAlreadyFilteredAttributeName();
9. if (request.getAttribute(alreadyFilteredAttributeName) != null || shouldNotFilter(httpRequest)) {
11.            filterChain.doFilter(request, response);
12.       }
13. else {
14.            request.setAttribute(alreadyFilteredAttributeName, Boolean.TRUE);
15. try {
16.             doFilterInternal(httpRequest, httpResponse, filterChain);
17.            }
18. finally {
20.             request.removeAttribute(alreadyFilteredAttributeName);
21.            }
22.       }
23. }
25. public static final String ALREADY_FILTERED_SUFFIX = ".FILTERED";（在OncePerRequestFilter中定义的常量）

说明：

1. getAlreadyFilteredAttributeName()方法返回的字符串是="咱们给filter配置的名字+ALREADY_FILTERED_SUFFIX"，因此request请求第一次到达过滤器的时候request.getAttribute(alreadyFilteredAttributeName) 值必定是null ，shouldNotFilter(httpRequest)方法默认实现始终返回false（这个方法也能够在子类中进行扩展）；

2. 当request.setAttribute(alreadyFilteredAttributeName, Boolean.TRUE)以后就会执行doFilterInternal(httpRequest, httpResponse, filterChain);方法了，doFilterInternal这里是个抽象方法，它是在子类CharacterEncodingFilter中被实现的，实现以下：

1. protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
2.    throws ServletException, IOException {
4. if (this.encoding != null && (this.forceEncoding || request.getCharacterEncoding() == null)) {
5.                 request.setCharacterEncoding(this.encoding);
6. if (this.forceEncoding && responseSetCharacterEncodingAvailable) {
7.                     response.setCharacterEncoding(this.encoding);
8.                    }
9.               }
10.               filterChain.doFilter(request, response);
11.   }
13. private final static boolean responseSetCharacterEncodingAvailable = ClassUtils.hasMethod(
14.    HttpServletResponse.class, "setCharacterEncoding", new Class[] {String.class});

说明：

1. 静态常量responseSetCharacterEncodingAvailable 是经过反射来判断response是否有setCharacterEncoding方法，返回值应该都是true.

2. this.encoding != null ：当encoding初始化参数被指定时条件知足。

3. （this.forceEncoding || request.getCharacterEncoding() == null ）==true：当forceEncoding初始化参数设置为true或者request已经被指定了一个字符编码的时候条件知足。

若是没记得错，Spring早期版本这个方法得实现应该是：

1. protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
2.    throws ServletException, IOException {
4. if (this.forceEncoding || request.getCharacterEncoding() == null) {
5.                    request.setCharacterEncoding(this.encoding);
6.               }
7.               filterChain.doFilter(request, response);
8.   }

参数forceEncoding的做用很明显了吧！之前只是对request字符编码起做用，如今若是将forceEncoding设为true也会影响到response中的字符编码，一般这个是咱们不但愿的。

总结：

1.  OncePerRequestFilter这个抽象过滤器很好的实现了对每一个request只执行一次过滤操做，若是有相似的需求能够继承该类并实现doFilterInternal方法来完成。

2.  CharacterEncodingFilter类能够经过简单配置来帮咱们实现字符集转换的功能。另外多说一句，若是采用Struts2.0的MVC框架我我的感受中文问题已经不是问题了，能够经过配置struts.i18n.encoding常量来实现统一字符编码。