Filter 简介

Java 中的 Filter 过滤器 - 图1

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

它主要用于对用户请求进行预处理，也可以对 HttpServletResponse 进行后处理。使用 Filter 的完整流程：Filter 对用户请求进行预处理，接着将请求交给 Servlet 进行处理并生成响应，最后 Filter 再对服务器响应进行后处理。

Filter 功能

在 HttpServletRequest 到达 Servlet 之前，拦截客户的 HttpServletRequest 。根据需要检查 HttpServletRequest，也可以修改 HttpServletRequest 头和数据。

在 HttpServletResponse 到达客户端之前，拦截 HttpServletResponse 。根据需要检查 HttpServletResponse，也可以修改 HttpServletResponse 头和数据。

如何借助 Filter 实现拦截功能

Filter 接口中有一个 doFilter 方法，当开发人员编写好 Filter，并配置对哪个 web 资源进行拦截后，Web 服务器每次在调用 web 资源的 service 方法之前，都会先调用一下 filter 的 doFilter 方法，因此，在该方法内编写代码可达到如下目的：

  1. 调用目标资源之前，让一段代码执行。
  2. 是否调用目标资源（即是否让用户访问web资源）。
  3. web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，
  4. 开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。

Filter 开发两步走

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

web.xml 配置各节点介绍：

  1. <filter>指定一个过滤器。
  2. <filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。
  3. <filter-class>元素用于指定过滤器的完整的限定类名。
  4. <init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。
  5. 在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。
  6. <filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径
  7. <filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字
  8. <url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)
  9. <servlet-name>指定过滤器所拦截的Servlet名称。
  10. <dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。用户可以设置多个<dispatcher>子元素用来指定 Filter 对资源的多种调用方式进行拦截。
  11. <dispatcher>子元素可以设置的值及其意义
  12. REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
  13. INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
  14. FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
  15. ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。

Filter 链

在一个 web 应用中，可以开发编写多个 Filter，这些 Filter 组合起来称之为一个 Filter 链。

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

Filter 的生命周期

  1. public void init(FilterConfig filterConfig) throws ServletException;//初始化
  2. 和我们编写的Servlet程序一样，Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）。开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。
  4. public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException;//拦截请求
  5. 这个方法完成实际的过滤操作。当客户请求访问与过滤器关联的URL的时候，Servlet过滤器将先执行doFilter方法。FilterChain参数用于访问后续过滤器。
  7. public void destroy();//销毁
  8. Filter对象创建后会驻留在内存，当web应用移除或服务器停止时才销毁。在Web容器卸载 Filter 对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源。

FilterConfig 接口

用户在配置 filter 时，可以使用为 filter 配置一些初始化参数，当 web 容器实例化 Filter 对象，调用其 init 方法时，会把封装了 filter 初始化参数的 filterConfig 对象传递进来。因此开发人员在编写 filter 时，通过 filterConfig 对象的方法，就可获得以下内容：

  1. String getFilterName();//得到filter的名称。 
  2. String getInitParameter(String name);//返回在部署描述中指定名称的初始化参数的值。如果不存在返回null. 
  3. Enumeration getInitParameterNames();//返回过滤器的所有初始化参数的名字的枚举集合。 
  4. public ServletContext getServletContext();//返回Servlet上下文对象的引用。

Filter 使用案例

使用 Filter 验证用户登录安全控制

前段时间参与维护一个项目，用户退出系统后，再去地址栏访问历史，根据 url，仍然能够进入系统响应页面。我去检查一下发现对请求未进行过滤验证用户登录。添加一个 filter 搞定问题！

先在 web.xml 配置

  1. <filter>
  2. <filter-name>SessionFilter</filter-name>
  3. <filter-class>com.action.login.SessionFilter</filter-class>
  4. <init-param>
  5. <param-name>logonStrings</param-name><!-- 对登录页面不进行过滤 -->
  6. <param-value>/project/index.jsp;login.do</param-value>
  7. </init-param>
  8. <init-param>
  9. <param-name>includeStrings</param-name><!-- 只对指定过滤参数后缀进行过滤 -->
  10. <param-value>.do;.jsp</param-value>
  11. </init-param>
  12. <init-param>
  13. <param-name>redirectPath</param-name><!-- 未通过跳转到登录界面 -->
  14. <param-value>/index.jsp</param-value>
  15. </init-param>
  16. <init-param>
  17. <param-name>disabletestfilter</param-name><!-- Y:过滤无效 -->
  18. <param-value>N</param-value>
  19. </init-param>
  20. </filter>
  21. <filter-mapping>
  22. <filter-name>SessionFilter</filter-name>
  23. <url-pattern>/*</url-pattern>
  24. </filter-mapping>

接着编写 FilterServlet

  1. package com.action.login;
  3. import java.io.IOException;
  5. import javax.servlet.Filter;
  6. import javax.servlet.FilterChain;
  7. import javax.servlet.FilterConfig;
  8. import javax.servlet.ServletException;
  9. import javax.servlet.ServletRequest;
  10. import javax.servlet.ServletResponse;
  11. import javax.servlet.http.HttpServletRequest;
  12. import javax.servlet.http.HttpServletResponse;
  13. import javax.servlet.http.HttpServletResponseWrapper;
  15. /**
  16. * 判断用户是否登录,未登录则退出系统
  17. */
  18. public class SessionFilter implements Filter {
  20. public FilterConfig config;
  22. public void destroy() {
  23. this.config = null;
  24. }
  26. public static boolean isContains(String container, String[] regx) {
  27. boolean result = false;
  29. for (int i = 0; i < regx.length; i++) {
  30. if (container.indexOf(regx[i]) != -1) {
  31. return true;
  32. }
  33. }
  34. return result;
  35. }
  37. public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
  38. HttpServletRequest hrequest = (HttpServletRequest)request;
  39. HttpServletResponseWrapper wrapper = new HttpServletResponseWrapper((HttpServletResponse) response);
  41. String logonStrings = config.getInitParameter("logonStrings"); // 登录登陆页面
  42. String includeStrings = config.getInitParameter("includeStrings"); // 过滤资源后缀参数
  43. String redirectPath = hrequest.getContextPath() + config.getInitParameter("redirectPath");// 没有登陆转向页面
  44. String disabletestfilter = config.getInitParameter("disabletestfilter");// 过滤器是否有效
  46. if (disabletestfilter.toUpperCase().equals("Y")) { // 过滤无效
  47. chain.doFilter(request, response);
  48. return;
  49. }
  50. String[] logonList = logonStrings.split(";");
  51. String[] includeList = includeStrings.split(";");
  53. if (!this.isContains(hrequest.getRequestURI(), includeList)) {// 只对指定过滤参数后缀进行过滤
  54. chain.doFilter(request, response);
  55. return;
  56. }
  58. if (this.isContains(hrequest.getRequestURI(), logonList)) {// 对登录页面不进行过滤
  59. chain.doFilter(request, response);
  60. return;
  61. }
  63. String user = ( String ) hrequest.getSession().getAttribute("useronly");//判断用户是否登录
  64. if (user == null) {
  65. wrapper.sendRedirect(redirectPath);
  66. return;
  67. }else {
  68. chain.doFilter(request, response);
  69. return;
  70. }
  71. }
  73. public void init(FilterConfig filterConfig) throws ServletException {
  74. config = filterConfig;
  75. }
  76. }

这样既可完成对用户所有请求，均要经过这个 Filter 进行验证用户登录。

防止中文乱码过滤器

项目使用 spring 框架时。当前台 JSP 页面和 Java 代码中使用了不同的字符集进行编码的时候就会出现表单提交的数据或者上传 / 下载中文名称文件出现乱码的问题，那就可以使用这个过滤器。

  1. <filter>
  2. <filter-name>encoding</filter-name>
  3. <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
  4. <init-param>
  5. <param-name>encoding</param-name><!--用来指定一个具体的字符集-->
  6. <param-value>UTF-8</param-value>
  7. </init-param>
  8. <init-param>
  9. <param-name>forceEncoding</param-name><!--true：无论request是否指定了字符集，都是用encoding；false：如果request已指定一个字符集，则不使用encoding-->
  10. <param-value>false</param-value>
  11. </init-param>
  12. </filter>
  13. <filter-mapping>
  14. <filter-name>encoding</filter-name>
  15. <url-pattern>/*</url-pattern>
  16. </filter-mapping>