针对struts2配置了字符过滤器还是乱码的深入研究

  1. 前几天在论坛上看到一篇帖子,是关于Struts2.0中文乱码的,楼主采用的是spring的字符编码过滤器
  2. (CharacterEncodingFilter)统一编码为GBK,前台提交表单数据到Action,但是在Action中得到的中文全部是乱码,前
  3. 台的页面编码都是GBK没有问题。这是为什么呢?下面我们就通过阅读FilterDispatcher和CharacterEncodingFilter
  4. 这两个过滤器的源代码,了解其实现细节,最终得出为什么中文还是乱码!


测试环境及其前置知识

  • Struts2.0.14
  • Spring2.5.6
  • Eclipse3.4
  • Filter的相关知识,尤其要知道Filter的执行顺序是按照web.xml中配置的filter-mapping顺序执行的。

web.xml定义文件
这里直接采用那篇帖子的web配置
Xml代码  [url=] [/url]

  • <!-- spring字符集过滤器 -->  
  •   <filter>  
  •   <filter-name>CharacterEncoding</filter-name>  
  •   <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>  
  •   <init-param>  
  •   <param-name>encoding</param-name>  
  •   <param-value>GBK</param-value>  
  •   </init-param>  
  •   <init-param>  
  •   <param-name>forceEncoding</param-name>  
  •   <param-value>true</param-value>  
  •   </init-param>  
  •   </filter>  
  •   <filter>  
  •      <filter-name>Struts2</filter-name>  
  •      <filter-class>org.apache.struts2.dispatcher.FilterDispatcher</filter-class>  
  •   </filter>  
  •   <filter-mapping>  
  •       <filter-name>CharacterEncoding</filter-name>  
  •       <url-pattern>*.action</url-pattern>  
  •   </filter-mapping>  
  •   <filter-mapping>  
  •      <filter-name>Struts2</filter-name>  
  •      <url-pattern>*.action</url-pattern>  
  •   </filter-mapping>   


分析过滤器源代码,找出为什么
根据filter的执行顺序知,会先执行CharacterEncoding过滤器,再执行Struts2过滤器。
CharacterEncodingFilter的核心doFilterInternal方法如下:
Java代码  [url=] [/url]

  • 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 && responseSetCharacterEncodingAvailable) {  
  •                 response.setCharacterEncoding(this.encoding);  
  •             }  
  •         }  
  •         filterChain.doFilter(request, response);//激活下一个过滤器  
  •     }  


很简洁,只要this.encoding != null就会设置request的字符集编码,this.encoding就是web.xml中CharacterEncoding过滤器配置的encoding为GBK。
到这里我们已经执行了一个Filter(CharacterEncoding)已经把request的字符集设置为GBK,然后执行filterChain.doFilter(request, response);//激活下一个过滤器即我们定义的Struts2过滤器。
到这里request的字符集编码还是GBK,但是我们在Action中取得的中文为乱码,使用request.getCharacterEncoding()获取的编码为UTF-8,那么我们可以肯定问题出在FilterDispatcher过滤器上。查看FilterDispatcher的源代码,在其doFilter方法里找到了prepareDispatcherAndWrapRequest方法,看其名字是对request进行预处理和封装的方法。
Java代码  



  • protected HttpServletRequest prepareDispatcherAndWrapRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException {  
  •   
  •         Dispatcher du = Dispatcher.getInstance();  
  •   
  •         if (du == null) {  
  •   
  •             Dispatcher.setInstance(dispatcher);  
  •             dispatcher.prepare(request, response);//设置编码的关键地方  
  •         } else {  
  •             dispatcher = du;  
  •         }  
  •         //省略一些代码  
  •   
  •         return request;  
  •     }  


展开dispatcher.prepare(request, response)发现:
Java代码  



  • public void prepare(HttpServletRequest request, HttpServletResponse response) {  
  •         String encoding = null;  
  •         if (defaultEncoding != null) {  
  •             encoding = defaultEncoding;  
  •         }  
  •   
  •        //省略了一些代码  
  •   
  •         if (encoding != null) {  
  •             try {  
  •                 request.setCharacterEncoding(encoding);//设置了字符集编码  
  •             } catch (Exception e) {  
  •                 LOG.error("Error setting character encoding to '" + encoding + "' - ignoring.", e);  
  •             }  
  •         }  
  •     //省略了一些代码  
  •     }  


可以发现FilterDispatcher过滤器设置了request的字符编码,值来自defaultEncoding(看上面的代码),而defaultEncoding则是通过struts的配置文件取得的,即struts.i18n.encoding的属性值。Java代码  [url=] [/url]

  • @Inject(StrutsConstants.STRUTS_I18N_ENCODING)  
  •    public static void setDefaultEncoding(String val) {  
  •        defaultEncoding = val;  
  •    }  


如果没有配置struts.i18n.encoding的值,默认是UTF-8.现在我们明白为什么中文是乱码了,也明白了为什么在Action中获取的编码是UTF-8啦。解决方法也很简单,在struts.xml文件中配置好struts.i18n.encoding的值为GBK即可,可以选择是否去掉spring的编码过滤器。
Xml代码  [url=] [/url]

  • <constant name="struts.i18n.encoding" value="gbk"></constant>  


延伸--过滤器的其他一些思考
到了这里按说我们已经解决了问题,应该没有什么疑问了,但是前面说了,过滤器是按顺序执行的,那么我们把spring的字符过滤器放在struts的过滤器后面行不行呢,想想是可以的,因为先执行struts的过滤器,设置编码为UTF-8,然后执行spring的过滤器设置成GBK。但是实际上不是那么回事,在实际调试过程中spring的过滤器压根就没有执行,为什么呢?接着看FilterDispatcher的doFilter方法Java代码  [url=] [/url]

  • public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {  
  •   
  •   
  •         HttpServletRequest request = (HttpServletRequest) req;  
  •         HttpServletResponse response = (HttpServletResponse) res;  
  •         ServletContext servletContext = getServletContext();  
  •   
  •         String timerKey = "FilterDispatcher_doFilter: ";  
  •         try {  
  •             UtilTimerStack.push(timerKey);  
  •             request = prepareDispatcherAndWrapRequest(request, response);  
  •             ActionMapping mapping;  
  •             try {  
  •                 mapping = actionMapper.getMapping(request, dispatcher.getConfigurationManager());//关键,获取Action的映射配置  
  •             } catch (Exception ex) {  
  •                 LOG.error("error getting ActionMapping", ex);  
  •                 dispatcher.sendError(request, response, servletContext, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, ex);  
  •                 return;  
  •             }  
  •   
  •             if (mapping == null) {  
  •                //走到这里说明请求的不是一个action  
  •                 String resourcePath = RequestUtils.getServletPath(request);  
  •   
  •                 if ("".equals(resourcePath) && null != request.getPathInfo()) {  
  •                     resourcePath = request.getPathInfo();  
  •                 }  
  •   
  •                 if (serveStatic && resourcePath.startsWith("/struts")) {  
  •                     findStaticResource(resourcePath, findAndCheckResources(resourcePath), request, response);  
  •                 } else {//很普通的一个request(非Action,非struts的静态资源)  
  •                     chain.doFilter(request, response);//激活下一个过滤器  
  •                 }  
  •                 // The framework did its job here  
  •                 return;  
  •             }  
  •             //调用action  
  •             dispatcher.serviceAction(request, response, servletContext, mapping);  
  •   
  •         } finally {  
  •             try {  
  •                 ActionContextCleanUp.cleanUp(req);  
  •             } finally {  
  •                 UtilTimerStack.pop(timerKey);  
  •             }  
  •         }  
  •     }  


看上面的代码mapping=actionMapper.getMapping(request,dispatcher.getConfigurationManager());这个是得到当前请求Action的信息,比如Action的名字,命名空间,result值等,只要这个mapping不为null,过滤器就会直接执行action而不会激活下一个过滤器,这就会使得spring的那个过滤器起不了作用。那么什么时候才会激活下一个过滤器呢?答案是一个很普通的请求,多么普通呢?
  • 不能是一个存在action。
  • serveStatic(struts.serve.static配置项值)为true时,不能是一个相对路径以"/struts"开头的请求,如(/struts.html,/struts/index.html),
    因为这样过滤器会认为你在找struts内部的静态资源,谈后它会去诸如struts的模板文件夹下去找这些静态资源。
  • 必须是一个类似于/index.html,/news/index.html这样的请求或者serveStatic为false时请求一个不存在的action。

当满足以上条件时才会激活下一个过滤器。看来这限制还挺多的,所以这就提出来一个注意事项了, 当你在web.xml配置多个过滤器的时候,一定要把struts的过滤器放到最后,这样可以防止过滤器链被中断,导致你配置的其他过滤器不起作用
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值