转载 CharacterEncodingFilter类的学习

 我的第一篇正式BLOG就写点简单的东西吧，记录一下CharacterEncodingFilter这个类的使用和作用。

        很简单很实用的一个过滤器，当前台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>
15.         <filter-mapping>
16.                 <filter-name>encodingFilter</filter-name>
17.                 <url-pattern>/*</url-pattern>
18.        </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 {
3.          ...........
4.          ...........
5.       String alreadyFilteredAttributeName = getAlreadyFilteredAttributeName();
6.       if (request.getAttribute(alreadyFilteredAttributeName) != null || shouldNotFilter(httpRequest)) {
7.            filterChain.doFilter(request, response);
8.       }
9.       else {
10.            request.setAttribute(alreadyFilteredAttributeName, Boolean.TRUE);
11.        try {
12.             doFilterInternal(httpRequest, httpResponse, filterChain);
13.            }
14.        finally {
15.             request.removeAttribute(alreadyFilteredAttributeName);
16.            }
17.       }
18.  }
19. 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 {
3.          if (this.encoding != null && (this.forceEncoding || request.getCharacterEncoding() == null)) {
4.                 request.setCharacterEncoding(this.encoding);
5.                if (this.forceEncoding && responseSetCharacterEncodingAvailable) {
6.                     response.setCharacterEncoding(this.encoding);
7.                    }
8.               }
9.               filterChain.doFilter(request, response);
10.   }
11. private final static boolean responseSetCharacterEncodingAvailable = ClassUtils.hasMethod(
12.    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 {
3.          if (this.forceEncoding || request.getCharacterEncoding() == null) {
4.                    request.setCharacterEncoding(this.encoding);
5.               }
6.               filterChain.doFilter(request, response);
7.   }

参数forceEncoding的作用很明显了吧！以前只是对request字符编码起作用，现在如果将forceEncoding设为true也会影响到response中的字符编码，通常这个是我们不希望的。

总结：

1.  OncePerRequestFilter这个抽象过滤器很好的实现了对每个request只执行一次过滤操作，如果有类似的需求可以继承该类并实现doFilterInternal方法来完成。

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

说明：所写内容纯属个人理解和认识，如有理解偏差希望有热心的朋友可以指出，如有描述有含糊不清的地方希望可以和你得到沟通和交流！