Servlet如何编写过滤器呢?
下文笔者将讲述Servlet编写过滤器的方法分享,如下所示:
javax.servlet.Filter接口定义了三个方法
Servlet设置多个过滤器
例:
Web中定义两个过滤器AuthenFilter 和 LogFilter需为两个过滤器都进行相关配置
过滤器的用途: 过滤器可动态拦截请求和响应, 修改或使用请求中的信息 修改或使用响应信息 我们可以编写多个过滤器(设置过滤器的过滤规则),附加到Servlet上
Servlet过滤器的应用场景
身份验证过滤器(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 内容 |
Servlet过滤器方法
过滤器是一个实现javax.servlet.Filter 接口的 Java 类javax.servlet.Filter接口定义了三个方法
keyId | 方法名 | 备注说明 |
1 | public void doFilter (ServletRequest, ServletResponse, FilterChain) |
该方法完成实际的过滤操作,当客户端请求方法与过滤器设置匹配的URL时 Servlet容器将先调用过滤器的doFilter方法 FilterChain用户访问后续过滤器 |
2 | public void init(FilterConfig filterConfig) |
web 应用程序启动时,web 服务器将创建Filter 的实例对象,并调用其init方法 读取web.xml配置,完成对象的初始化功能,从而为后续的用户请求作好拦截的准备工作(filter对象只会创建一次,init方法也只会执行一次) 开发人员通过init方法的参数,可获得代表当前filter配置信息的FilterConfig对象 |
3 | public void destroy() | Servlet容器在销毁过滤器实例前调用该方法,在该方法中释放Servlet过滤器占用的资源 |
Servlet过滤器的示例
package com.java265; //导入必需的 java 库 import javax.servlet.*; import java.util.*; //实现 Filter 类 public class LogFilter implements Filter { public void init(FilterConfig config) throws ServletException { //获取初始化参数 String site = config.getInitParameter("Site"); //输出初始化参数 System.out.println("网站名称: " + site); } public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException { // 输出站点名称 System.out.println("站点--http://www.java265.com"); // 把请求传回过滤链 chain.doFilter(request,response); } public void destroy( ){ /* 在 Filter 实例被 Web 容器从服务移除之前调用 */ } } //编写Servlet import java.io.IOException; import java.io.PrintWriter; import java.util.Enumeration; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @WebServlet("/ShowTest") //扩展 HttpServlet 类 public class ShowTest extends HttpServlet { // 处理 GET 方法请求的方法 public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { // 设置响应内容类型 response.setContentType("text/html;charset=UTF-8"); PrintWriter out = response.getWriter(); out.println("test"); } // 处理 POST 方法请求的方法 public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } } Web.xml中设置过滤器 <?xml version="1.0" encoding="UTF-8"?> <web-app> <filter> <filter-name>LogFilter</filter-name> <filter-class>com.java265.LogFilter</filter-class> <init-param> <param-name>Site</param-name> <param-value>java265</param-value> </init-param> </filter> <filter-mapping> <filter-name>LogFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> </web-app>
Servlet设置多个过滤器
例:
Web中定义两个过滤器AuthenFilter 和 LogFilter需为两个过滤器都进行相关配置
<filter> <filter-name>LogFilter</filter-name> <filter-class>com.java265.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>com.java265.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>
过滤器的应用顺序
filter-mapping设置的顺序决定了过滤器应用于Servlet的顺序, 如果向调整filter的顺序,只需调整mapping的配置顺序即可
web.xml配置各节点说明
<filter>指定一个过滤器 |
<filter-name>用于为过滤器指定一个名字,该元素的内容不能为空 |
<filter-class>元素用于指定过滤器的完整的限定类名 |
<init-param>元素用于为过滤器指定初始化参数,它的子元素<param-name>指定参数的名字,<param-value>指定参数的值 |
<filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定:Servlet 名称和资源访问的请求路径 |
<filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字 |
<url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式) |
<servlet-name>指定过滤器所拦截的Servlet名称 |
<dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式,可以是REQUEST,INCLUDE,FORWARD和ERROR之一,默认REQUEST。用户可以设置多个<dispatcher>子元素用来指定 Filter 对资源的多种调用方式进行拦截 |
<dispatcher>子元素可以设置的值及其意义 |
REQUEST:当用户直接访问页面时,Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时,那么该过滤器就不会被调用 |
INCLUDE:如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用 |
FORWARD:如果目标资源是通过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用 |
ERROR:如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用。除此之外,过滤器不会被调用 |
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。