Servlet过滤器是可用于Servlet编程的Java类,用于以下目的 :
拦截请求在客户端访问后端资源之前从客户端开始.
在将服务器发送回客户端之前对其进行操作.
规格和减号建议使用各种类型的过滤器;
身份验证过滤器.
数据压缩过滤器.
加密过滤器.
触发资源访问事件的过滤器.
图像转换过滤器.
日志记录和审核过滤器.
MIME-TYPE链过滤器.
标记过滤器.
转换XML内容的XSL/T过滤器.
过滤器部署在部署描述符文件 web.xml 然后映射到应用程序部署描述符中的servlet名称或URL模式.
当Web容器启动Web应用程序时,它会创建您在其中声明的每个过滤器的实例部署描述符.过滤器按照在部署描述符中声明的顺序执行.
过滤器只是一个实现javax.servlet.Filter接口. javax.servlet.Filter接口定义了三个方法 :
Sr.No. | 方法&描述 |
---|---|
1 | public void doFilter(ServletRequest,ServletResponse,FilterChain) 每次请求/响应对时,容器都会调用此方法由于客户端对链末端的资源的请求而传递链. |
2 | public void init(FilterConfig filterConfig) Web容器调用此方法以向过滤器指示它正在投入使用. |
3 | public void destroy() Web容器调用此方法,以向过滤器指示它已停止服务. |
以下是将打印客户端IP地址和当前日期时间的Servlet过滤器示例.这个例子可以让你对Servlet过滤器有基本的了解,但你可以使用相同的概念编写更复杂的过滤器应用程序 :
// Import required java libraries import java.io.*; import javax.servlet.*; import javax.servlet.http.*; import java.util.*; // Implements Filter class public class LogFilter implements Filter { public void init(FilterConfig config) throws ServletException { // Get init parameter String testParam = config.getInitParameter("test-param"); //Print the init parameter System.out.println("Test Param: " + testParam); } public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException { // Get the IP address of client machine. String ipAddress = request.getRemoteAddr(); // Log the IP address and current timestamp. System.out.println("IP "+ ipAddress + ", Time " + new Date().toString()); // Pass request back down the filter chain chain.doFilter(request,response); } public void destroy( ) { /* Called before the Filter instance is removed from service by the web container*/ } }
以通常的方式编译 LogFilter.java 并将您的类文件放在< Tomcat-installationdirectory>/webapps/ROOT/WEB -INF/classes
过滤器已定义,然后映射到URL或Servlet,方式大致相同定义Servlet,然后映射到URL模式.在部署描述符文件中为过滤器标记创建以下条目 web.xml
<filter> <filter-name>LogFilter</filter-name> <filter-class>LogFilter</filter-class> <init-param> <param-name>test-param</param-name> <param-value>Initialization Paramter</param-value> </init-param> </filter> <filter-mapping> <filter-name>LogFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
上面的过滤器将适用于所有servlet,因为我们在配置中指定了/* .如果要仅在几个servlet上应用过滤器,则可以指定特定的servlet路径.
现在尝试以通常的方式调用任何servlet,您将在Web服务器日志中看到生成的日志.您可以使用Log4J记录器将上面的日志记录在一个单独的文件中.
您的Web应用程序可能会定义几个具有特定过滤器的不同过滤器目的.考虑一下,您定义了两个过滤器 AuthenFilter 和 LogFilter .其余的过程将保持如上所述,除非你需要创建一个不同的映射,如下所述 :
<filter> <filter-name>LogFilter</filter-name> <filter-class>LogFilter</filter-class> <init-param> <param-name>test-param</param-name> <param-value>Initialization Paramter</param-value> </init-param> </filter> <filter> <filter-name>AuthenFilter</filter-name> <filter-class>AuthenFilter</filter-class> <init-param> <param-name>test-param</param-name> <param-value>Initialization Paramter</param-value> </init-param> </filter> <filter-mapping> <filter-name>LogFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>AuthenFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
web.xml中过滤器映射元素的顺序决定了Web的顺序容器将过滤器应用于servlet.要反转过滤器的顺序,您只需要反转web.xml文件中的过滤器映射元素.
例如,上面的示例将首先应用LogFilter,然后它将应用AuthenFilter到任何servlet,但以下示例将颠倒顺序 :
<filter-mapping> <filter-name>AuthenFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>LogFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>