Servlet 编写过滤器

Servlet 过滤器可以动态地拦截请求和响应,以变换或使用包含在请求或响应中的信息。

可以将一个或多个 Servlet 过滤器附加到一个 Servlet 或一组 Servlet。Servlet 过滤器也可以附加到 JavaServer Pages (JSP) 文件和 HTML 页面。调用 Servlet 前调用所有附加的 Servlet 过滤器。

Servlet 过滤器是可用于 Servlet 编程的 Java 类,可以实现以下目的:

  • 在客户端的请求访问后端资源之前,拦截这些请求。
  • 在服务器的响应发送回客户端之前,处理这些响应。

根据规范建议的各种类型的过滤器:

  • 身份验证过滤器(Authentication Filters)。
  • 数据压缩过滤器(Data compression Filters)。
  • 加密过滤器(Encryption Filters)。
  • 触发资源访问事件过滤器。
  • 图像转换过滤器(Image Conversion Filters)。
  • 日志记录和审核过滤器(Logging and Auditing Filters)。
  • MIME-TYPE 链过滤器(MIME-TYPE Chain Filters)。
  • 标记化过滤器(Tokenizing Filters)。
  • XSL/T 过滤器(XSL/T Filters),转换 XML 内容。

过滤器通过 Web 部署描述符(web.xml)中的 XML 标签来声明,然后映射到您的应用程序的部署描述符中的 Servlet 名称或 URL 模式。

当 Web 容器启动 Web 应用程序时,它会为您在部署描述符中声明的每一个过滤器创建一个实例。

Filter的执行顺序与在web.xml配置文件中的配置顺序一致,一般把Filter配置在所有的Servlet之前。

Servlet 过滤器方法

过滤器是一个实现了 javax.servlet.Filter 接口的 Java 类。javax.servlet.Filter 接口定义了三个方法:

序号方法 & 描述
1public void doFilter (ServletRequest, ServletResponse, FilterChain)该方法完成实际的过滤操作,当客户端请求方法与过滤器设置匹配的URL时,Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器。
2public void init(FilterConfig filterConfig)web 应用程序启动时,web 服务器将创建Filter 的实例对象,并调用其init方法,读取web.xml配置,完成对象的初始化功能,从而为后续的用户请求作好拦截的准备工作(filter对象只会创建一次,init方法也只会执行一次)。开发人员通过init方法的参数,可获得代表当前filter配置信息的FilterConfig对象。
3public void destroy()Servlet容器在销毁过滤器实例前调用该方法,在该方法中释放Servlet过滤器占用的资源。

FilterConfig 使用

Filter 的 init 方法中提供了一个 FilterConfig 对象。

如 web.xml 文件配置如下:

  1. <filter>
  2. <filter-name>LogFilter</filter-name>
  3. <filter-class>com.servlet.test.LogFilter</filter-class>
  4. <init-param>
  5. <param-name>Site</param-name>
  6. <param-value>Servlet教程</param-value>
  7. </init-param>
  8. </filter>

在 init 方法使用 FilterConfig 对象获取参数:

  1. public void init(FilterConfig config) throws ServletException {
  2. // 获取初始化参数
  3. String site = config.getInitParameter("Site");
  4. // 输出初始化参数
  5. System.out.println("网站名称: " + site);
  6. }

Servlet 过滤器实例

以下是 Servlet 过滤器的实例,将输出网站名称和地址。本实例让您对 Servlet 过滤器有基本的了解,您可以使用相同的概念编写更复杂的过滤器应用程序:

  1. package com.servlet.test;
  2. //导入必需的 java 库
  3. import javax.servlet.*;
  4. import java.util.*;
  5. //实现 Filter 类
  6. public class LogFilter implements Filter {
  7. public void init(FilterConfig config) throws ServletException {
  8. // 获取初始化参数
  9. String site = config.getInitParameter("Site");
  10. // 输出初始化参数
  11. System.out.println("网站名称: " + site);
  12. }
  13. public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException {
  14. // 输出站点名称
  15. System.out.println("站点网址:http://www.jishuchi.com");
  16. // 把请求传回过滤链
  17. chain.doFilter(request,response);
  18. }
  19. public void destroy( ){
  20. /* 在 Filter 实例被 Web 容器从服务移除之前调用 */
  21. }
  22. }

这边使用前文提到的 DisplayHeader.java 为例子:

  1. //导入必需的 java 库
  2. import java.io.IOException;
  3. import java.io.PrintWriter;
  4. import java.util.Enumeration;
  5. import javax.servlet.ServletException;
  6. import javax.servlet.annotation.WebServlet;
  7. import javax.servlet.http.HttpServlet;
  8. import javax.servlet.http.HttpServletRequest;
  9. import javax.servlet.http.HttpServletResponse;
  10. @WebServlet("/DisplayHeader")
  11. //扩展 HttpServlet 类
  12. public class DisplayHeader extends HttpServlet {
  13. // 处理 GET 方法请求的方法
  14. public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
  15. {
  16. // 设置响应内容类型
  17. response.setContentType("text/html;charset=UTF-8");
  18. PrintWriter out = response.getWriter();
  19. String title = "HTTP Header 请求实例 - Servlet教程实例";
  20. String docType =
  21. "<!DOCTYPE html> \n";
  22. out.println(docType +
  23. "<html>\n" +
  24. "<head><meta charset=\"utf-8\"><title>" + title + "</title></head>\n"+
  25. "<body bgcolor=\"#f0f0f0\">\n" +
  26. "<h1 align=\"center\">" + title + "</h1>\n" +
  27. "<table width=\"100%\" border=\"1\" align=\"center\">\n" +
  28. "<tr bgcolor=\"#949494\">\n" +
  29. "<th>Header 名称</th><th>Header 值</th>\n"+
  30. "</tr>\n");
  31. Enumeration headerNames = request.getHeaderNames();
  32. while(headerNames.hasMoreElements()) {
  33. String paramName = (String)headerNames.nextElement();
  34. out.print("<tr><td>" + paramName + "</td>\n");
  35. String paramValue = request.getHeader(paramName);
  36. out.println("<td> " + paramValue + "</td></tr>\n");
  37. }
  38. out.println("</table>\n</body></html>");
  39. }
  40. // 处理 POST 方法请求的方法
  41. public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
  42. doGet(request, response);
  43. }
  44. }

Web.xml 中的 Servlet 过滤器映射(Servlet Filter Mapping)

定义过滤器,然后映射到一个 URL 或 Servlet,这与定义 Servlet,然后映射到一个 URL 模式方式大致相同。在部署描述符文件 web.xml 中为 filter 标签创建下面的条目:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <web-app>
  3. <filter>
  4. <filter-name>LogFilter</filter-name>
  5. <filter-class>com.servlet.test.LogFilter</filter-class>
  6. <init-param>
  7. <param-name>Site</param-name>
  8. <param-value>技术池</param-value>
  9. </init-param>
  10. </filter>
  11. <filter-mapping>
  12. <filter-name>LogFilter</filter-name>
  13. <url-pattern>/*</url-pattern>
  14. </filter-mapping>
  15. <servlet>
  16. <!-- 类名 -->
  17. <servlet-name>DisplayHeader</servlet-name>
  18. <!-- 所在的包 -->
  19. <servlet-class>com.servlet.test.DisplayHeader</servlet-class>
  20. </servlet>
  21. <servlet-mapping>
  22. <servlet-name>DisplayHeader</servlet-name>
  23. <!-- 访问的网址 -->
  24. <url-pattern>/TomcatTest/DisplayHeader</url-pattern>
  25. </servlet-mapping>
  26. </web-app>

上述过滤器适用于所有的 Servlet,因为我们在配置中指定 /* 。如果您只想在少数的 Servlet 上应用过滤器,您可以指定一个特定的 Servlet 路径。

现在试着以常用的方式调用任何 Servlet,您将会看到在 Web 服务器中生成的日志。您也可以使用 Log4J 记录器来把上面的日志记录到一个单独的文件中。

接下来我们访问这个实例地址 http://localhost:8080/TomcatTest/DisplayHeader, 然后在控制台看下输出内容,如下所示:

  1. 网站名称:技术池
  2. 站点网址:http://www.jishuchi.com

使用多个过滤器

Web 应用程序可以根据特定的目的定义若干个不同的过滤器。假设您定义了两个过滤器 AuthenFilterLogFilter。您需要创建一个如下所述的不同的映射,其余的处理与上述所讲解的大致相同:

  1. <filter>
  2. <filter-name>LogFilter</filter-name>
  3. <filter-class>com.servlet.test.LogFilter</filter-class>
  4. <init-param>
  5. <param-name>test-param</param-name>
  6. <param-value>Initialization Paramter</param-value>
  7. </init-param>
  8. </filter>
  9. <filter>
  10. <filter-name>AuthenFilter</filter-name>
  11. <filter-class>com.servlet.test.AuthenFilter</filter-class>
  12. <init-param>
  13. <param-name>test-param</param-name>
  14. <param-value>Initialization Paramter</param-value>
  15. </init-param>
  16. </filter>
  17. <filter-mapping>
  18. <filter-name>LogFilter</filter-name>
  19. <url-pattern>/*</url-pattern>
  20. </filter-mapping>
  21. <filter-mapping>
  22. <filter-name>AuthenFilter</filter-name>
  23. <url-pattern>/*</url-pattern>
  24. </filter-mapping>

过滤器的应用顺序

web.xml 中的 filter-mapping 元素的顺序决定了 Web 容器应用过滤器到 Servlet 的顺序。若要反转过滤器的顺序,您只需要在 web.xml 文件中反转 filter-mapping 元素即可。

例如,上面的实例将先应用 LogFilter,然后再应用 AuthenFilter,但是下面的实例将颠倒这个顺序:

  1. <filter-mapping>
  2. <filter-name>AuthenFilter</filter-name>
  3. <url-pattern>/*</url-pattern>
  4. </filter-mapping>
  5. <filter-mapping>
  6. <filter-name>LogFilter</filter-name>
  7. <url-pattern>/*</url-pattern>
  8. </filter-mapping>

web.xml配置各节点说明

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

过滤器 doFilte() 方法

过滤器中我们可以根据 doFilte() 方法中的 request 对象获取表单参数信息,例如我们可以获取到请求的用户名和密码进行逻辑处理,也可以通过 response 对用户做出回应。比如如果验证用户名不正确,禁止用户访问 web 资源,并且向浏览器输出提示,告诉用户用户名或者密码不正确等等;

  1. public void doFilter(ServletRequest req, ServletResponse resp,
  2. FilterChain chain) throws IOException, ServletException {
  3. //获取请求信息(测试时可以通过get方式在URL中添加name)
  4. //http://localhost:8080/servlet_demo/helloword?name=123
  5. String name = req.getParameter("name");
  6. // 过滤器核心代码逻辑
  7. System.out.println("过滤器获取请求参数:"+name);
  8. System.out.println("第二个过滤器执行--网站名称:www.jishuchi.com");
  9. if("123".equals(name)){
  10. // 把请求传回过滤链
  11. chain.doFilter(req, resp);
  12. }else{
  13. //设置返回内容类型
  14. resp.setContentType("text/html;charset=GBK");
  15. //在页面输出响应信息
  16. PrintWriter out = resp.getWriter();
  17. out.print("<b>name不正确,请求被拦截,不能访问web资源</b>");
  18. System.out.println("name不正确,请求被拦截,不能访问web资源");
  19. }
  20. }