Java web Filter 简介和工作原理

Filter(过滤器)简介
Filter 的基本功能是对 Servlet 容器调用 Servlet 的过程进行拦截，从而在 Servlet 进行响应处理的前后实现一些特殊的功能。
在 Servlet API 中定义了三个接口类来开供开发人员编写 Filter 程序：Filter, FilterChain, FilterConfig
Filter 程序是一个实现了 Filter 接口的 Java 类，与 Servlet 程序相似，它由 Servlet 容器进行调用和执行
Filter 程序需要在 web.xml 文件中进行注册和设置它所能拦截的资源：Filter 程序可以拦截 Jsp, Servlet, 静态图片文件和静态 html 文件

Filter 的基本工作原理
当在 web.xml 中注册了一个 Filter 来对某个 Servlet 程序进行拦截处理时，这个 Filter 就成了 Servlet 容器与该 Servlet 程序的通信线路上的一道关卡，该 Filter 可以对 Servlet 容器发送给 Servlet 程序的请求和 Servlet 程序回送给 Servlet 容器的相应进行拦截，可以决定是否将请求继续传递给 Servlet 程序，以及对请求和相应信息是否进行修改
在一个 web 应用程序中可以注册多个 Filter 程序，每个 Filter 程序都可以对一个或一组 Servlet 程序进行拦截。
若有多个 Filter 程序对某个 Servlet 程序的访问过程进行拦截，当针对该 Servlet 的访问请求到达时，web 容器将把这多个 Filter 程序组合成一个 Filter 链(过滤器链)。Filter 链中各个 Filter 的拦截顺序与它们在应用程序的 web.xml 中映射的顺序一致


Filter 接口
init(FilterConfig filterConfig)throws ServletException：在 web 应用程序启动时，web 服务器将根据 web.xml 文件中的配置信息来创建每个注册的 Filter 实例对象，并将其保存在服务器的内存中。Web容器创建 Filter 对象实例后，将立即调用该 Filter 对象的 init 方法。Init 方法在 Filter 生命周期中仅执行一次，web 容器在调用 init 方法时，会传递一个包含 Filter 的配置和运行环境的 FilterConfig 对象(FilterConfig的用法和ServletConfig类似)。利用FilterConfig对象可以得到ServletContext对象，以及部署描述符中配置的过滤器的初始化参数。在这个方法中，可以抛出ServletException异常，通知容器该过滤器不能正常工作。
destroy()： 在Web容器卸载 Filter 对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源。
与开发Servlet不同的是，Filter接口并没有相应的实现类可供继承，要开发过滤器，只能直接实现Filter接口。
doFilter(ServletRequest request,ServletResponse response,
  FilterChain chain)throws java.io.IOException,ServletException：
doFilter()方法类似于Servlet接口的service()方法。当客户端请求目标资源的时候，容器就会调用与这个目标资源相关联的过滤器的 doFilter()方法。其中参数 request, response 为 web 容器或 Filter 链的上一个 Filter 传递过来的请求和相应对象；参数 chain 为代表当前 Filter 链的对象，在特定的操作完成后，可以在当前 Filter 对象的 doFilter 方法内部需要调用 FilterChain 对象的 chain.doFilter(request,response)方法才能把请求交付给 Filter 链中的下一个 Filter 或者目标 Servlet 程序去处理，也可以直接向客户端返回响应信息，或者利用RequestDispatcher的forward()和include()方法，以及 HttpServletResponse的sendRedirect()方法将请求转向到其他资源。这个方法的请求和响应参数的类型是 ServletRequest和ServletResponse，也就是说，过滤器的使用并不依赖于具体的协议。


FilterChain 接口：
FilterChain接口：代表当前 Filter 链的对象。由容器实现，容器将其实例作为参数传入过滤器对象的doFilter()方法中。过滤器对象使用FilterChain对象调用过滤器链中的下一个过滤器，如果该过滤器是链中最后一个过滤器，那么将调用目标资源。
doFilter(ServletRequest request,ServletResponse response)throws java.io.IOException：调用该方法将使过滤器链中的下一个过滤器被调用。如果是最后一个过滤器，会调用目标资源。
在实现一个过滤器后，需要在 web.xml 中进行注册和设置它所能拦截的资源。这可以通过<filter>和<filter-mapping>元素来完成的。

其配置方式和servlet非常类似，下面是具体的配置代码
<filter>
  <filter-name>testFilterConfig</filter-name>
  <filter-class>cn.itcast.filter.TestFilterConfigFilter</filter-class>
  <!-- 配置当前 Filter 的初始化参数 -->
  <init-param>
  <param-name>name</param-name>
  <param-value>Tom</param-value>
  </init-param>
  <init-param>
  <param-name>password</param-name>
  <param-value>123456</param-value>
  </init-param>
</filter>
<filter-mapping>
  <filter-name>testFilterConfig</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>
/* 表示所有的url都需要被这个过滤器所过滤
在同一个 web.xml 文件中可以为同一个 Filter 设置多个映射。若一个 Filter 链中多次出现了同一个 Filter 程序，这个 Filter 程序的拦截处理过程将被多次执行

Filter的典型应用
使浏览器不缓存页面的过滤器：
有 3 个 HTTP 响应头字段都可以禁止浏览器缓存当前页面，它们在 Servlet 中的示例代码如下：
response.setDateHeader("Expires",-1);
response.setHeader("Cache-Control","no-cache");
response.setHeader("Pragma","no-cache");
并不是所有的浏览器都能完全支持上面的三个响应头，因此最好是同时使用上面的三个响应头


典型应用2
字符编码的过滤器
通过配置参数encoding指明使用何种字符编码,以处理Html Form请求参数的中文问题
具体的实例代码如下：
public void doFilter(ServletRequest arg0, ServletResponse arg1,
  FilterChain arg2) throws IOException, ServletException {
  // TODO Auto-generated method stub
  arg0.setCharacterEncoding(“UTF-8”);
  arg2.doFilter(arg0, arg1);
  }



如何在src目下的代码中获得当前web应用下的文件？
答：可以定义一个servlet，这个servlet不需要映射，将其配置为在服务器启动时就启动，在这个 servlet中可以获得 ServletContext对象，利用这个对象就可以获得我们感兴趣的文件的getRealPath（绝对路径），把这个绝对路径保存到我们自定义的一个类的静态变量中就可以了。

如果实现对客户端输入信息的过滤？
答：使用过滤器，但是由于request只能获得页面参数，但是却无法修改页面参数的值并返回给页面（也就是说：只有getParameter方法，但是没有setParameter方法），这个时候我们只能通过继承的方式重写request对象的getParameter方法来实现。这个时候我们提供两种比较常见的方法来实现。
方案1.
继承 javax.servlet.http.HttpServletRequestWrapper这个类
这个类实际上是对request对象的装饰，通过构造方法获得一个request对象，其内部所有HttpServletRequest接口中的方法都是实际调用这个request对象来实现的。
使用这个类，传入request对象，我们就只需要对我们感兴趣的方法进行重写，而其他方法则使用request的默认实现
比如这里我们对其中的 getParameter方法进行重写
@Override
  public String getParameter(String name) {
  String value = super.getParameter(name);
  if(value != null&&value.contains("bad")){
  value = value.replaceAll("bad", "=======");
  }
  return value;
  }
方案2：
使用动态代理，传入一个request对象作为需要被代理的对象，利用动态代理的invoke方法遍历其内部的每个方法，如果发现有名为“getParameter”，就进行覆盖，其他方法则直接调用其最初的实现。

1. 区别几个用语：
假设工程为filter
2.web站点的根目录（路径）
web站点的根目录: http://localhost:8080/
3.、web应用的的根目录、
http://localhost:8080/filter/
4. 当前目录
当前目录（同一目录下的不同文件）: http://localhost:8080/filter/mydir/

2."/" 的意义：(工程为filter)
  一、在-form-表单的action属性中代表web站点的根目录
  action="/loginservlet" 代表http://localhost:8080/loginservlet 服务器会去当前web应用根目录的外面去，这肯定会出错！
action="loginservlet" 代表http://localhost:8080/filter/loginservlet 这是我们一般映射Servlet的路径(要求表单与loginservlet在同一级目录下)

  二、在--重定向--操作中代表web站点的根目录
  在LoginServlet.java中：
response.sendRedirect("/hello.jsp"); 代表http://localhost:8080/hello.jsp 不存在，会报错response.sendRedirect("hello.jsp"); 代表hello.jsp与loginservlet在同一目录下，否则会报错

  三、在--转发--操作中代表当前web应用的的根目录
  在LoginServlet.java中：
  request.getRequestDispatcher("/hello.jsp") 代表http://localhost:8080/filter/hello.jsp
  request.getRequestDispatcher("hello.jsp") 代表hello.jsp与loginservlet在同一目录下
  四、在--映射路径--操作中代表当前web应用的的根目录
  在web.xml文件中：
<url-pattern>/loginservlet</url-pattern> 代表将LoginServlet映射成：http://localhost:8080/filter/LoginServlet



  五、无"/"则代表当前目录
  要求发送请求的对象与接受请求的对象在同一目录下，否则就会报错

  请测试一个例子：
  在LonginServlet.java中
  request.getRequestDispatcher(servletContext.getContextPath()+"/login.jsp") 是转发到的url为:http://localhost:8080/filter/login.jsp 吗？
答：这个是错误的，转发的时候，“/login.jsp”中的“/” 已经代表当前web应用的根了，如果再加上 servletContext.getContextPath()，最后拼接出来的url是：

/filter/filter /-----，弄出两个filter，肯定出错。


Filter的一些补充

映射 Filter的<dispatcher> 子元素可以设置的值及其意义

REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。

INCLUDE： 如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。

FORWARD： 如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。

ERROR： 如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。


如果不进行配置，默认是只过滤REQUEST。


当同时配置了好几个过滤相同目标的filter的时候，要注意他们的执行顺序，下图反应了这个顺序。





Servlet 监听器

监听器：专门用于对其他对象身上发生的事件或状态改变进行监听和相应处理的对象，当被监视的对象发生情况时，立即采取相应的行动。


Servlet 监听器：Servlet 规范中定义的一种特殊类，它用于监听 web 应用程序中的 ServletContext, HttpSession 和 ServletRequest 等域对象的创建与销毁事件，以及监听这些域对象中的属性发生修改的事件。


ServletContextListener 接口

ServletContextListener 接口用于监听 ServletContext 对象的创建和销毁事件。

当 ServletContext 对象被创建时，激发contextInitialized (ServletContextEvent sce)方法

当 ServletContext 对象被销毁时，激发contextDestroyed(ServletContextEvent sce)方法


HttpSessionListener 接口

HttpSessionListener 接口用于监听HttpSession对象的创建和销毁

创建一个 Session时，激发sessionCreated

(HttpSessionEvent se) 方法

销毁一个Session时，激发sessionDestroyed (HttpSessionEvent se) 方法。


ServletRequestListener 接口

ServletRequestListener 接口用于监听ServletRequest 对象的创建和销毁

创建一个ServletRequest 对象时，激发requestInitialized(ServletRequestEvent sre)方法

销毁一个Session时，激发requestDestroyed(ServletRequestEvent sre)方法。


HttpSessionBindingListener 接口

实现了HttpSessionBindingListener接口的 JavaBean 对象可以感知自己被绑定到 Session 中和从 Session 中删除的事件

当对象被绑定到 HttpSession 对象中时，web 服务器调用该对象的 void valueBound(HttpSessionBindingEvent event) 方法

当对象从 HttpSession 对象中解除绑定时，web 服务器调用该对象的 void valueUnbound(HttpSessionBindingEvent event)方法