解决Request参数乱码的Filter 标签： filterencodingnullstringwebappjsp 2008-10-26 18:26 1252人阅

本人编写的请求编码过滤器，用于解决Request参数乱码问题，通过在web.xml中配置此Filter可以一劳永逸得解决乱码问题。

 

用法非常简单，在web.xml中配置好这个Filter，使用时无需添加额外代码，按照正常方法取得参数即可。

包括：

<%=request.getParam("text")%>

${param.text}

....

等等，任何取得请求参数的方法。

 

 

web.xml中得配置，如下配置即可。

要注意的是其中得编码一项要和response的编码一致。

例如Jsp中，文件头设置了：

<%@ page language="java" contentType="text/html; charset=GBK" pageEncoding="GBK"%>

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=GBK">

 

那么web.xml中的编码一项就应该修改为GBK


设置中的FilterGetMethod参数将指明是否对Get方法进行编码转换。

这项设置主要是针对Server.xml中的Conector元素的属性“URIEncoding”，

该属性可以修改Get方法的编码，但是有时候我们并不能取得修改server.xml文件的权限，

这时候就可以使用本过滤器的该项功能，将FilterGetMethod的值写为true。

否则将不对Get方法做转换处理。

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
  3.   <display-name>demo</display-name>
  4.   <filter>
  5.     <description>请求编码过滤器</description>
  6.     <display-name>Request Encoding Filter</display-name>
  7.     <filter-name>Request Encoding Filter</filter-name>
  8.     <filter-class>zerofire.servlet.encoding.RequestEncodingFilter</filter-class>
  9.     <init-param>
  10.       <description>是否忽略编码设置</description>
  11.       <param-name>ignore</param-name>
  12.       <param-value>false</param-value>
  13.     </init-param>
  14.     <init-param>
  15.       <description>是否处理Get方法</description>
  16.       <param-name>FilterGetMethod</param-name>
  17.       <param-value>false</param-value>
  18.     </init-param>
  19.     <init-param>
  20.       <description>设置编码</description>
  21.       <param-name>encoding</param-name>
  22.       <param-value>UTF-8</param-value>
  23.     </init-param>
  24.   </filter>
  25.   <filter-mapping>
  26.     <filter-name>Request Encoding Filter</filter-name>
  27.     <url-pattern>/*</url-pattern>
  28.   </filter-mapping>
  29. </web-app>

源码RequestEncodingFilter：

  1. package zerofire.servlet.encoding;
  3. import java.io.IOException;
  4. import java.util.Enumeration;
  6. import javax.servlet.Filter;
  7. import javax.servlet.FilterChain;
  8. import javax.servlet.FilterConfig;
  9. import javax.servlet.ServletException;
  10. import javax.servlet.ServletRequest;
  11. import javax.servlet.ServletResponse;
  12. import javax.servlet.http.HttpServletRequest;
  14. /**
  15.  * 请求编码过滤器，过滤所有请求，将请求参数字符串转换为指定编码，避免乱码出现
  16.  * 使用方法：
  17.  * 在web.xml中配置此Filter过滤所有路径，使用时无需任何额外代码，直接取参数即可
  18.  * 支持Post方法和Get方法得请求。
  19.  * 
  20.  * @author Zero
  21.  * @version 1.2
  22.  * @since 2003, 2008
  23.  *
  24.  */
  25. public class RequestEncodingFilter implements Filter {
  27.     protected FilterConfig config;
  28.     protected String encoding;
  29.     protected boolean ignore;
  30.     protected boolean filterGetMethod;
  32.     public RequestEncodingFilter() {
  33.         config = null;
  34.         encoding = null; // 编码，默认为UTF-8
  35.         ignore = false; // 可选，默认为不忽略
  36.         filterGetMethod = false; // 是否处理Get方法
  37.     }
  39.     @Override
  40.     public void destroy() {
  41.         config = null;
  42.         encoding = null;
  43.     }
  45.     @Override
  46.     public void init(FilterConfig filterConfig) throws ServletException {
  47.         config = filterConfig;
  48.         
  49.         Enumeration names = config.getInitParameterNames();
  50.         while(names.hasMoreElements()) {
  51.             String name = names.nextElement().toString();
  52.             
  53.             if (name.trim().toLowerCase().equals("encoding")) {
  54.                 encoding = filterConfig.getInitParameter(name);
  55.                 if (encoding == null || encoding.trim().length() == 0) {
  56.                     encoding = "utf-8";
  57.                 }
  58.             }
  59.             
  60.             if (name.trim().toLowerCase().equals("ignore")) {
  61.                 String s = config.getInitParameter(name);
  62.                 if (s == null) s = "";
  63.                 s = s.trim().toLowerCase();
  64.                 ignore = (s.equals("true") || s.equals("yes") || s.equals("ignore"));
  65.             }
  66.             
  67.             if (name.trim().toLowerCase().equals("filtergetmethod")) {
  68.                 String s = config.getInitParameter(name);
  69.                 if (s == null) s = "";
  70.                 s = s.trim().toLowerCase();
  71.                 filterGetMethod = (s.equals("true") || s.equals("yes"));
  72.             }
  73.         }
  74.     }
  76.     @Override
  77.     public void doFilter(ServletRequest req, ServletResponse resp,
  78.             FilterChain chain) throws IOException, ServletException {
  80.         HttpServletRequest request = (HttpServletRequest) req;
  82.         if (!ignore) {
  83.             request.setCharacterEncoding(encoding);
  85.             // 对于GET方法需要对QueryString重新编码
  86.             if (filterGetMethod 
  87.                     && "GET".equalsIgnoreCase(request.getMethod())
  88.                     && (request.getQueryString() != null)) {
  89.                 req = new RequestEncodingWrapper(request, encoding);
  90.             }
  91.         }
  93.         chain.doFilter(req, resp);
  94.     }
  95. }


RequestEncodingWrapper

 

  1. package zerofire.servlet.encoding;
  3. import java.io.UnsupportedEncodingException;
  4. import java.util.Iterator;
  5. import java.util.Map;
  7. import javax.servlet.http.HttpServletRequest;
  8. import javax.servlet.http.HttpServletRequestWrapper;
  10. /**
  11.  * 供RequestEncodingFilter使用。
  12.  * 作用是转换一个HttpServletRequest，转换其取得参数的函数，避免出现乱码
  13.  * @author Zero
  14.  * 
  15.  */
  16. public class RequestEncodingWrapper extends HttpServletRequestWrapper {
  18.     private String encoding;
  20.     /**
  21.      * @param request
  22.      */
  23.     public RequestEncodingWrapper(HttpServletRequest request) {
  24.         this(request, "utf-8");
  25.     }
  27.     public RequestEncodingWrapper(HttpServletRequest request, String enc) {
  28.         super(request);
  29.         encoding = enc;
  30.     }
  32.     private static String getEncodedString(String value, String enc)
  33.             throws UnsupportedEncodingException {
  34.         return new String(value.getBytes("ISO-8859-1"), enc);
  35.     }
  37.     @Override
  38.     public String getParameter(String key) {
  39.         String ret = super.getParameter(key);
  40.         if (ret != null) {
  41.             try {
  42.                 ret = getEncodedString(ret, encoding);
  43.             } catch (UnsupportedEncodingException ex) {
  44.                 ex.printStackTrace();
  45.             }
  46.         }
  47.         return ret;
  48.     }
  50.     @SuppressWarnings("unchecked")
  51.     @Override
  52.     public Map getParameterMap() {
  54.         Map map = super.getParameterMap();
  56.         if (map != null) {
  58.             Iterator it = map.keySet().iterator();
  60.             while (it.hasNext()) {
  61.                 Object obj = map.get(it.next());
  62.                 if (obj != null) {
  63.                     try {
  64.                         obj = getEncodedString((String) obj, encoding);
  65.                     } catch (UnsupportedEncodingException ex) {
  66.                         ex.printStackTrace();
  67.                     }
  68.                 } // if (obj != null)
  69.             } // while (it.hasNext)
  70.         } // if (map != null)
  71.         return map;
  72.     }
  74.     @Override
  75.     public String[] getParameterValues(String key) {
  77.         String[] ret = super.getParameterValues(key);
  79.         if (ret != null) {
  80.             for (int i = 0; i < ret.length; i++) {
  81.                 try {
  82.                     ret[i] = getEncodedString(ret[i], encoding);
  83.                 } catch (UnsupportedEncodingException ex) {
  84.                     ex.printStackTrace();
  85.                 }
  86.     
  87.             }
  88.         }
  90.         return ret;
  91.     }
  93. }

 

posted @ 2008-10-26 18:26  炽火  阅读(213)  评论(0)  编辑  收藏  举报