橘子味的心
标题:JSP过滤器

在本章中,我们将讨论JSP中的过滤器。Servlet和JSP过滤器是可以在Servlet和JSP编程中用于以下目的的Java类:

  • 在客户端访问后端的资源之前拦截请求。
  • 在服务器发送回客户端之前操纵响应。

有各种类型的过滤器由规格建议 -

  • 验证过滤器
  • 数据压缩过滤器
  • 加密过滤器
  • 触发资源访问事件的过滤器
  • 图像转换过滤器
  • 记录和审核过滤器
  • MIME类型链式过滤器
  • 令牌过滤器
  • 转换XML内容的XSL/T过滤器

过滤器部署在部署描述符文件web.xml中,然后映射到应用程序部署描述符中的servlet或JSP名称或URL模式。部署描述符文件web.xml可以在<Tomcat-installation-directory>\conf目录中或在项目的WEB-INF目录下找到。

Servlet过滤器方法

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

编号 方法 描述
1 public void doFilter (ServletRequest, ServletResponse, FilterChain) 由于是在链末端的客户端请求,所以每当通过链路传递请求/响应对时,容器就会调用此方法。
2 public void init(FilterConfig filterConfig) 该方法由Web容器调用,向过滤器指示它正在投入使用。
3 public void destroy() 该方法由Web容器调用以向过滤器指示它正在停用服务。

JSP过滤器示例

以下示例显示了如何在客户访问任何JSP文件时,打印客户端的IP地址和当前日期时间。 这个例子将让您对JSP过滤器有一个基本的了解,基于这个示例,您可以使用相同的概念编写更复杂的过滤器应用程序。

打开Eclipse,创建一个动态Web项目:Filter,其项目的结构如下所示 -

下面来看看这个应用的具体实现。

文件:LogFilter.java

  1. package com.yiibai;
  2.  
  3. //Import required java libraries
  4. import java.io.*;
  5. import javax.servlet.*;
  6. import javax.servlet.http.*;
  7. import java.util.*;
  8.  
  9. //Implements Filter class
  10. public class LogFilter implements Filter {
  11. public void init(FilterConfig config) throws ServletException {
  12. // Get init parameter
  13. String testParam = config.getInitParameter("test-param");
  14. // Print the init parameter
  15. System.out.println("Test Param: " + testParam);
  16. }
  17.  
  18. public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
  19. throws java.io.IOException, ServletException {
  20.  
  21. // Get the IP address of client machine.
  22. String ipAddress = request.getRemoteAddr();
  23.  
  24. // Log the IP address and current timestamp.
  25. System.out.println("IP " + ipAddress + ", Time " + new Date().toString());
  26.  
  27. // Pass request back down the filter chain
  28. chain.doFilter(request, response);
  29. }
  30.  
  31. public void destroy() {
  32. /*
  33. * Called before the Filter instance is removed from service by the web
  34. * container
  35. */
  36. }
  37. }
  38. Java

Web.xml中的JSP过滤器映射

过滤器需要先定义,然后映射到URL或JSP文件名,与Servlet定义的方式大致相同,然后映射到web.xml文件中的URL模式。在部署描述符文件web.xml中为过滤器标签创建以下标签项 -

  1. <filter>
  2. <filter-name>LogFilter</filter-name>
  3. <filter-class>LogFilter</filter-class>
  4.  
  5. <init-param>
  6. <param-name>test-param</param-name>
  7. <param-value>Initialization Paramter</param-value>
  8. </init-param>
  9. </filter>
  10.  
  11. <filter-mapping>
  12. <filter-name>LogFilter</filter-name>
  13. <url-pattern>/*</url-pattern>
  14. </filter-mapping>
  15. XML

上述过滤器将适用于所有servlet和JSP,因为我们在配置中指定了/*。如果要仅在少数servlet或JSP上应用过滤器,则可以指定特定的servlet或JSP路径。

现在尝试调用任意一个servlet或JSP,将看到有生成日志到Web服务器日志。可以使用Log4J记录器记录以上日志在单独的文件中。

在终端输出结果如下 -

  1. ......
  2. 信息: Starting Servlet Engine: Apache Tomcat/8.5.23
  3. 十月 20, 2017 2:22:55 上午 org.apache.catalina.util.SessionIdGeneratorBase createSecureRandom
  4. 警告: Creation of SecureRandom instance for session ID generation using [SHA1PRNG] took [110] milliseconds.
  5. Test Param: Initialization Paramter
  6. 十月 20, 2017 2:22:55 上午 org.apache.coyote.AbstractProtocol start
  7. 信息: Starting ProtocolHandler ["http-nio-8080"]
  8. 十月 20, 2017 2:22:55 上午 org.apache.coyote.AbstractProtocol start
  9. 信息: Starting ProtocolHandler ["ajp-nio-8009"]
  10. 十月 20, 2017 2:22:55 上午 org.apache.catalina.startup.Catalina start
  11. 信息: Server startup in 717 ms
  12. IP 0:0:0:0:0:0:0:1, Time Fri Oct 20 02:22:57 BOT 2017
  13. Shell

使用多个过滤器

Web应用程序可以定义几个具有特定目的的不同过滤器。考虑一下,定义两个过滤器AuthenFilterLogFilter。其余的过程将保持跟上面一样,除了需要创建一个不同的映射,如下所述 -

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

过滤应用顺序

web.xml中的过滤器映射元素的顺序确定了Web容器将过滤器应用于servlet或JSP的顺序。 要颠倒过滤器的顺序,只需要反转web.xml文件中的过滤器映射元素即可。

例如,上面的例子将首先应用LogFilter,然后将AuthenFilter应用于任何servlet或JSP; 以下示例将颠倒顺序 -

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