servlet过滤器

Filter简介

Filter也称之为过滤器，它是Servlet技术中最激动人心的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能

Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截

Filter是如何实现拦截的？

Filter接口中有一个doFilter方法，当开发人员编写好Filter，并配置对哪个web资源进行拦截后，WEB服务器每次在调用web资源的service方法之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：
1、调用目标资源之前，让一段代码执行
2、是否调用目标资源（即是否让用户访问web资源）。
3、web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。

Filter开发分为二个步骤：

编写java类实现Filter接口，并实现其doFilter方法。
在 web.xml 文件中使用和元素对编写的filter类进行注册，并设置它所能拦截的资源。

Filter链

在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。
web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中，开发人员如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如果没有，则调用目标资源。

Filter的生命周期

init(FilterConfig filterConfig) throws ServletException：
和我们编写的Servlet程序一样，Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（注：filter对象只会创建一次，init方法也只会执行一次。示例 ）
开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。(filterConfig对象见下页PPT)

destroy()：
在Web容器卸载 Filter 对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源

FilterConfig接口

用户在配置filter时，可以使用为filter配置一些初始化参数，当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时，通过filterConfig对象的方法，就可获得：
String getFilterName()：得到filter的名称。
String getInitParameter(String name)： 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.
Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。
public ServletContext getServletContext()：返回Servlet上下文对象的引用。

Filter的部署

注册Filter

<filter>
          <filter-name>testFitlerfilter-name>
         <filter-class>org.test.TestFiterfilter-class>
         <init-param>
         <param-name>word_fileparam-name>    
         <param-value>/WEB-INF/word.txtparam-value>
         init-param>
filter>

用于为过滤器指定一个名字，该元素的内容不能为空。
元素用于指定过滤器的完整的限定类名。
元素用于为过滤器指定初始化参数，它的子元素指定参数的名字，指定参数的值。在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。

映射Filter

<filter-mapping>
     <filter-name>testFilterfilter-name>
    <url-pattern>/test.jspurl-pattern>
filter-mapping>
<filter-mapping>
    <filter-name>testFilterfilter-name>
   <url-pattern>/index.jspurl-pattern>
   <dispatcher>REQUESTdispatcher>
   <dispatcher>FORWARDdispatcher>
filter-mapping>

元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径
子元素用于设置filter的注册名称。该值必须是在元素中声明过的过滤器的名字
设置 filter 所拦截的请求路径(过滤器关联的URL样式)
指定过滤器所拦截的Servlet名称。
指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。用户可以设置多个 子元素用来指定 Filter 对资源的多种调用方式进行拦截。

子元素可以设置的值及其意义：
　　REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
　　INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
　　FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
　　ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。

filter实例-统一全站字符编码的过滤器

1、新建一个类webFilter 并实现接口 Filter

 1 package fnz.filter;
 2 import java.io.IOException;
 3 import java.lang.reflect.InvocationHandler;
 4 import java.lang.reflect.Method;
 5 import java.lang.reflect.Proxy;
 6 
 7 import javax.servlet.Filter;
 8 import javax.servlet.FilterChain;
 9 import javax.servlet.FilterConfig;
10 import javax.servlet.ServletException;
11 import javax.servlet.ServletRequest;
12 import javax.servlet.ServletResponse;
13 import javax.servlet.http.HttpServletRequest;
14 import javax.servlet.http.HttpServletResponse;
15 public class webFilter implements Filter {
16 
17     public void init(FilterConfig filterConfig) throws ServletException {
18         
19     }
20 　　
21     public void doFilter(ServletRequest req, ServletResponse res,
22             FilterChain chain) throws IOException, ServletException {
23         final HttpServletRequest request = (HttpServletRequest)req;
24         HttpServletResponse response = (HttpServletResponse)res;
25         request.setCharacterEncoding("utf-8");
26         response.setContentType("text/html;charset=utf-8");
27         //使用代理来扩展request对象的getParameter方法
28         HttpServletRequest _request = (HttpServletRequest)Proxy.newProxyInstance(request.getClass().getClassLoader()
29                 , new Class[]{HttpServletRequest.class}, new InvocationHandler() {
30                     
31                     public Object invoke(Object proxy, Method method, Object[] args)
32                             throws Throwable {
33                         String methodName = method.getName();
34                         if("getParameter".equals(methodName)){
35                             //request中的getParameter方法，当get提交时，需要对编码进行处理
36                             if("GET".equals(request.getMethod())){
37                                 String content = (String)method.invoke(request, args[0].toString());//request.getParameter(args[0].toString());
38                                 return new String(content.getBytes("ISO8859-1"),"utf-8");
39                             }
40                         }
41                         return method.invoke(request, args);
42                     }
43                 });
44         
45         chain.doFilter(_request, response);//放行
46         request.getRequestDispatcher("index.jsp").forward(request, response);
47     }
48 
49     public void destroy() {
50         
51     }
52 
53 
54 }

2、在web.xml中配置好过滤器的映射关系

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <web-app version="2.5" 
 3     xmlns="http://java.sun.com/xml/ns/javaee" 
 4     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 5     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
 6     http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
 7     
 8     <filter>
 9         <filter-name>LoginFilterfilter-name>
10         <filter-class>fnz.filter.webFilterfilter-class>
11     filter>
12     <filter-mapping>
13         <filter-name>LoginFilterfilter-name>
14         <url-pattern>/*url-pattern>
15     filter-mapping>
16     
17   <display-name>display-name>
18   <servlet>
19     <description>This is the description of my J2EE componentdescription>
20     <display-name>This is the display name of my J2EE componentdisplay-name>
21     <servlet-name>LoginServletservlet-name>
22     <servlet-class>fnz.servlet.LoginServletservlet-class>
23   servlet>
24 
25   <servlet-mapping>
26     <servlet-name>LoginServletservlet-name>
27     <url-pattern>/LoginServleturl-pattern>
28   servlet-mapping>    
29   <welcome-file-list>
30     <welcome-file>index.jspwelcome-file>
31   welcome-file-list>
32 web-app>

3、最后编写一个servlet（LoginServlet.java）及前台页面（index.jsp），用于测试Filter

LoginServlet.java

 1 package fnz.servlet;
 2 
 3 import java.io.IOException;
 4 import java.io.PrintWriter;
 5 
 6 import javax.servlet.ServletException;
 7 import javax.servlet.http.HttpServlet;
 8 import javax.servlet.http.HttpServletRequest;
 9 import javax.servlet.http.HttpServletResponse;
10 
11 public class LoginServlet extends HttpServlet {
12     
13     public void doGet(HttpServletRequest request, HttpServletResponse response)
14             throws ServletException, IOException {
15         
16         System.out.println(request.getParameter("name"));
17     }
18     
19     public void doPost(HttpServletRequest request, HttpServletResponse response)
20             throws ServletException, IOException {
21         this.doGet(request, response);
22     }
23 }

index.jsp

 1 <%@ page language="java" import="java.util.*" pageEncoding="utf-8"%>
 2 
 3 DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 4 <html>
 5   <head>
 6     <title>My JSP 'index.jsp' starting pagetitle>
 7   head>
 8   <body>
 9     <form action="${pageContext.request.contextPath}/LoginServlet" method="post">
10         <input type="text" name="name"/>
11         <input type="submit" value="POST提交"/>
12     form>
13     <form action="${pageContext.request.contextPath}/LoginServlet" method="get">
14         <input type="text" name="name"/>
15         <input type="submit" value="GET提交"/>
16     form>
17   body>
18 html>

此案例目录结构：

end