1.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.xml 中,然后映射到您的应用程序的部署描述符中的 Servlet 名称或 URL 模式。
当 Web 容器启动 Web 应用程序时,它会为您在部署描述符中声明的每一个过滤器创建一个实例。该过滤器执行的顺序是按它们在部署描述符中声明的顺序。
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 容器调用,指示一个过滤器被取出服务。 |
FilterConfig 使用
Filter 的 init 方法中提供了一个 FilterConfig 对象。
如 web.xml 文件配置如下:
<filter> <filter-name>TestFiterfilter-name> <filter-class>com.my.web.TestFiterfilter-class> <init-param> <param-name>Nameparam-name> <param-value>Summerparam-value> init-param> filter> <filter-mapping> <filter-name>TestFiterfilter-name> <url-pattern>/*url-pattern> filter-mapping>
上述过滤器适用于所有的 Servlet,因为我们在配置中指定 /* 。如果您只想在少数的 Servlet 上应用过滤器,您可以指定一个特定的 Servlet 路径。
package com.my.web; import java.io.IOException; import javax.servlet.Filter; import javax.servlet.FilterChain; import javax.servlet.FilterConfig; import javax.servlet.ServletException; import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import javax.servlet.annotation.WebFilter; /** * Servlet Filter implementation class TestFiter */ @WebFilter("/TestFiter") public class TestFiter implements Filter { String name ="unknow"; /** * Default constructor. */ public TestFiter() { // TODO Auto-generated constructor stub } /** * @see Filter#init(FilterConfig) */ public void init(FilterConfig fConfig) throws ServletException { // TODO Auto-generated method stub name = fConfig.getInitParameter("Name"); System.out.println("name:" +name); } /** * @see Filter#doFilter(ServletRequest, ServletResponse, FilterChain) */ public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { // TODO Auto-generated method stub // place your code here // pass the request along the filter chain System.out.println(System.currentTimeMillis()+"=========="); chain.doFilter(request, response); } /** * @see Filter#destroy() */ public void destroy() { // TODO Auto-generated method stub } }
使用多个过滤器
Web 应用程序可以根据特定的目的定义若干个不同的过滤器。假设您定义了两个过滤器 AuthenFilter 和 LogFilter。您需要创建一个如下所述的不同的映射,其余的处理与上述所讲解的大致相同:
<filter> <filter-name>LogFilterfilter-name> <filter-class>com.w3cschool.test.LogFilterfilter-class> <init-param> <param-name>test-paramparam-name> <param-value>Initialization Paramterparam-value> init-param> filter> <filter> <filter-name>AuthenFilterfilter-name> <filter-class>com.w3cschool.test.AuthenFilterfilter-class> <init-param> <param-name>test-paramparam-name> <param-value>Initialization Paramterparam-value> init-param> filter> <filter-mapping> <filter-name>LogFilterfilter-name> <url-pattern>/*url-pattern> filter-mapping> <filter-mapping> <filter-name>AuthenFilterfilter-name> <url-pattern>/*url-pattern> filter-mapping>
web.xml 中的 filter-mapping 元素的顺序决定了 Web 容器应用过滤器到 Servlet 的顺序。若要反转过滤器的顺序,您只需要在 web.xml 文件中反转 filter-mapping 元素即可。
在过滤器中,可以使用FilterConfig接口对象来访问初始化参数。
REQUEST:当用户直接访问页面时,Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时,那么该过滤器就不会被调用。
INCLUDE:如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。
FORWARD:如果目标资源是通过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。
ERROR:如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用。除此之外,过滤器不会被调用。