javaweb之Java过滤器与包装设计模式的实用案例

在filter中可以得到代表用户请求和响应的request、response对象，因此在编程中可以使用Decorator(装饰器)模式对request、response对象进行包装，再把包装对象传给目标资源，从而实现一些特殊需求。

一、Decorator设计模式

1.1、Decorator设计模式介绍

当某个对象的方法不适应业务需求时，通常有2种方式可以对方法进行增强：

编写子类，覆盖需增强的方法。
使用Decorator设计模式对方法进行增强。

在阎宏博士的《JAVA与模式》一书中开头是这样描述装饰（Decorator）模式的：装饰模式又名包装(Wrapper)模式。装饰模式以对客户端透明的方式扩展对象的功能，是继承关系的一个替代方案。装饰模式是在不必改变原类文件和使用继承的情况下，动态的扩展一个对象的功能。它是通过创建一个包装对象，也就是装饰来包裹真实的对象。

那么在实际应用中遇到需增强对象的方法时，到底选用哪种方式比较好呢？这个没有具体的定式，只能是根据具体的需求来采用具体的方式，不过有一种情况下，必须使用Decorator设计模式：即被增强的对象，开发人员只能得到它的对象，无法得到它的class文件。比如request、response对象，开发人员之所以在servlet中能通过sun公司定义的HttpServletRequest\response接口去操作这些对象，是因为Tomcat服务器厂商编写了request、response接口的实现类。web服务器在调用servlet时，会用这些接口的实现类创建出对象，然后传递给servlet程序。此种情况下，由于开发人员根本不知道服务器厂商编写的request、response接口的实现类是哪个？在程序中只能拿到服务器厂商提供的对象，因此就只能采用Decorator设计模式对这些对象进行增强。

1.2、Decorator设计模式的实现

1.首先看需要被增强对象继承了什么接口或父类，编写一个类也去继承这些接口或父类。
2.在类中定义一个变量，变量类型即需增强对象的类型。
3.在类中定义一个构造函数，接收需增强的对象。
4.覆盖需增强的方法，编写增强的代码。

二、使用Decorator设计模式增强request对象

Servlet API 中提供了一个request对象的Decorator设计模式的默认实现类HttpServletRequestWrapper，HttpServletRequestWrapper 类实现了request 接口中的所有方法，但这些方法的内部实现都是仅仅调用了一下所包装的的 request 对象的对应方法，以避免用户在对request对象进行增强时需要实现request接口中的所有方法。

2.1、使用Decorator模式包装request对象解决get和post请求方式下的中文乱码问题

编写一个用于处理中文乱码的过滤器CharacterEncodingFilter，代码如下：

 1  
 2 public class CharacterEncodingFilter implements Filter {
   
 3 
 4     private FilterConfig filterConfig = null;
 5     //设置默认的字符编码
 6     private String defaultCharset = "UTF-8";
 7 
 8     public void doFilter(ServletRequest req, ServletResponse resp,
 9             FilterChain chain) throws IOException, ServletException {
   
10         
11         HttpServletRequest request = (HttpServletRequest) req;
12         HttpServletResponse response = (HttpServletResponse) resp;
13         //得到在web.xml中配置的字符编码
14         String charset = filterConfig.getInitParameter("charset");
15         if(charset==null){
   
16             charset = defaultCharset;
17         }
18         request.setCharacterEncoding(charset);
19         response.setCharacterEncoding(charset);
20         response.setContentType("text/html;charset="+charset);
21         
22         MyCharacterEncodingRequest requestWrapper = new MyCharacterEncodingRequest(request);
23         chain.doFilter(requestWrapper, response);
24     }
25 
26     public void init(FilterConfig filterConfig) throws ServletException {
   
27         //得到过滤器的初始化配置信息
28         this.filterConfig = filterConfig;
29     }
30     
31     public void destroy() {
   
32 
33     }
34 }
35 
36 /**
37 * @Description: Servlet API中提供了一个request对象的Decorator设计模式的默认实现类HttpServletRequestWrapper,
38 * (HttpServletRequestWrapper类实现了request接口中的所有方法，但这些方法的内部实现都是仅仅调用了一下所包装的的 request对象的对应方法)
39 * 以避免用户在对request对象进行增强时需要实现request接口中的所有方法。
40 * 所以当需要增强request对象时，只需要写一个类继承HttpServletRequestWrapper类，然后在重写需要增强的方法即可
41 *   1.实现与被增强对象相同的接口 
42     2、定义一个变量记住被增强对象
43     3、定义一个构造函数，接收被增强对象
44     4、覆盖需要增强的方法
45     5、对于不想增强的方法，直接调用被增强对象（目标对象）的方法
46 */ 
47 class MyCharacterEncodingRequest extends HttpServletRequestWrapper{
   
48     //定义一个变量记住被增强对象(request对象是需要被增强的对象)
49     private HttpServletRequest request;
50     //定义一个构造函数，接收被增强对象
51     public MyCharacterEncodingRequest(HttpServletRequest request) {
   
52         super(request);
53         this.request = request;
54     }
55     /* 覆盖需要增强的getParameter方法
56      * @see javax.servlet.ServletRequestWrapper#getParameter(java.lang.String)
57      */
58     @Override
59     public String getParameter(String name) {
   
60         try{
   
61             //获取参数的值
62             String value= this.request.getParameter(name);
63             if(value==null){
   
64                 return null;
65             }
66             //如果不是以get方式提交数据的，就直接返回获取到的值
67             if(!this.request.getMethod().equalsIgnoreCase("get")) {
   
68                 return value;
69             }else{
   
70                 //如果是以get方式提交数据的，就对获取到的值进行转码处理
71                 value = new String(value.getBytes("ISO8859-1"),this.request.getCharacterEncoding());
72                 return value;
73             }
74         }catch (Exception e) {
   
75             throw new RuntimeException(e);
76         }
77     }
78 }

在web.xml文件中配置CharacterEncodingFilter:

 1 <!--配置字符过滤器，解决get、post请求方式下的中文乱码问题-->
 2   <filter>
 3       <filter-name>CharacterEncodingFilter</filter-name>
 4       <filter-class>me.gacl.web.filter.CharacterEncodingFilter</filter-class>
 5   </filter>
 6   
 7   <filter-mapping>
 8       <filter-name>CharacterEncodingFilter</filter-name>
 9       <url-pattern>/*</url-pattern>
10   </filter-mapping>

编写jsp测试页面，如下：

 1 <%@ page language="java" pageEncoding="UTF-8"%>
 2 <%--引入jstl标签库 --%>
 3 <%@taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
 4 <!DOCTYPE HTML>
 5 <html>
 6   <head>
 7     <title>使用字符过滤器解决解决get、post请求方式下的中文乱码问题</title>
 8   </head>
 9   
10   <body>
11        <%--使用c:url标签构建url，构建好的url存储在servletDemo1变量中--%>
12        <c:url value="/servlet/ServletDemo1" scope="page" var="servletDemo1">
13            <%--构建的url的附带的中文参数 ，参数名是：username，值是：孤傲苍狼--%>
14            <c:param name="username" value="孤傲苍狼"></c:param>
15        </c:url>
16       <%--使用get的方式访问 --%>
17        <a href="${servletDemo1}">超链接(get方式请求)</a>
18        <hr/>
19        <%--使用post方式提交表单 --%>
20        <form action="${pageContext.request.contextPath}/servlet/ServletDemo1" method="post">
21            用户名：<input type="text" name="username" value="孤傲苍狼" />
22            <input type="submit" value="post方式提交">
23        </form>
24        
25   </body>
26 </html>

编写处理用户请求的ServletDemo1

 1  class ServletDemo1 extends HttpServlet {
   
 2 
 3     public void doGet(HttpServletRequest request, HttpServletResponse response)
 4             throws ServletException, IOException {
   
 5         //接收参数
 6         String username = request.getParameter("username");
 7         //获取请求方式
 8         String method = request.getMethod();
 9         //获取输出流
10         PrintWriter out = response.getWriter();
11         out.write("请求的方式："+method);
12         out.write("<br/>");
13         out.write("接收到的参数："+username);
14     }
15 
16     public void doPost(HttpServletRequest request, HttpServletResponse response)
17             throws ServletException, IOException {
   
18         doGet(request, response);
19     }
20 
21 }

这样, 无论是get请求方式还是post请求方式，中文乱码问题都可以完美解决了。

2.2、使用Decorator模式包装request对象实现html标签转义功能编写一个html转义过滤器，代码如下：

 1 public class HtmlFilter implements Filter {
   
 2 
 3     public void doFilter(ServletRequest req, ServletResponse resp,
 4             FilterChain chain) throws IOException, ServletException {
   
 5         
 6         HttpServletRequest request = (HttpServletRequest) req;
 7         HttpServletResponse response = (HttpServletResponse) resp;
 8 
 9         MyHtmlRequest myrequest = new MyHtmlRequest(request);
10         chain.doFilter(myrequest, response);
11         
12     }
13 
14     
15     public void destroy() {
   
16         
17     }
18 
19     
20     public void init(FilterConfig filterConfig) throws ServletException {
   
21         
22     }
23 }
24  
25 class MyHtmlRequest extends HttpServletRequestWrapper {
   
26 
27     private HttpServletRequest request;
28 
29     public MyHtmlRequest(HttpServletRequest request) {
   
30         super(request);
31         this.request = request;
32     }
33 
34     /* 覆盖需要增强的getParameter方法
35      * @see javax.servlet.ServletRequestWrapper#getParameter(java.lang.String)
36      */
37     @Override
38     public String getParameter(String name) {
   
39         String value = this.request.getParameter(name);
40         if (value == null) {
   
41             return null;
42         }
43         //调用filter转义value中的html标签
44         return filter(value);
45     }
46 
47     public String filter(String message) {
   
48         if (message == null){
   
49             return null;
50         }
51         char content[] = new char[message.length()];
52         message.getChars(0, message.length(), content, 0);
53         StringBuffer result = new StringBuffer(content.length + 50);
54         for (int i = 0; i < content.length; i++) {
   
55             switch (content[i]) {
   
56             case '<':
57                 result.append("&lt;");
58                 break;
59             case '>':
60                 result.append(