Filter也称之为过滤器,如下图所示,浏览器在访问web资源时,如果服务器配置了过滤器,则该访问在获取到web资源之间会经过过滤器,在访问完后又会回到过滤器,最后经过服务器才返回浏览器。通过这种方法,我们可以实现权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
1.Filter开发步骤
开发过滤器很简单,只需要经过编写java类,进行相关配置,就可以使用了。
1.1 编写java类
Servlet API中提供了一个Filter接口,我们通过实现该接口重写里面的方法就可以实现过滤器的功能。
import java.io.IOException;
import java.util.Enumeration;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
public class HelloFilter implements Filter{
// 创建实例
public HelloFilter(){
System.out.println("1. 创建过滤器实例");
}
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("2. 执行过滤器初始化方法");
// 获取过滤器在web.xml中配置的初始化参数
String encoding = filterConfig.getInitParameter("encoding");
System.out.println(encoding);
// 获取过滤器在web.xml中配置的初始化参数 的名称
Enumeration<String> enums = filterConfig.getInitParameterNames();
while (enums.hasMoreElements()){
// 获取所有参数名称:encoding、path
String name = enums.nextElement();
// 获取名称对应的值
String value = filterConfig.getInitParameter(name);
System.out.println(name + "\t" + value);
}
}
// 过滤器业务处理方法: 在请求到达servlet之前先进入此方法处理公用的业务逻辑操作
@Override
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
System.out.println("3. 执行过滤器业务处理方法");
// 放行 (去到Servlet)
// 如果有下一个过滤器,进入下一个过滤器,否则就执行访问servlet
chain.doFilter(request, response);
System.out.println("5. Servlet处理完成,又回到过滤器");
}
@Override
public void destroy() {
System.out.println("6. 销毁过滤器实例");
}
}
1.2 进行相关配置
在web.xml中添加如下内容:
<filter>
<!-- 过滤器名称 -->
<filter-name>hello_filter</filter-name>
<!-- 过滤器对应的实现类 -->
<filter-class>cn.itcast.a_filter_hello.HelloFilter</filter-class>
<!-- 过滤器初始化参数 -->
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
<init-param>
<param-name>path</param-name>
<param-value>c:/...</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>hello_filter</filter-name>
<!-- 过滤器过滤模式,/* 表示过滤所有资源 -->
<url-pattern>/*</url-pattern>
</filter-mapping>
** 辅助servlet:**
public class ServletTest extends HttpServlet {
public void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
System.out.println("I'm a test servlet!");
}
}
当我们两次访问辅助测试servlet时效果如下:
2.FilterChain
即Filter链,在一个web应用中,可以开发编写多个Filter,这些Filter组合起来称之为一个Filter链。web服务器根据Filter在web.xml文件中的注册顺序,决定先调用哪个Filter,当第一个Filter的doFilter方法被调用时,web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中,开发人员如果调用了FilterChain对象的doFilter方法,则web服务器会检查FilterChain对象中是否还有filter,如果有,则调用第2个filter,如果没有,则调用目标资源。
3.Filter生命周期
通过上面实例, 可以看到在启动tomcat服务器时就执行了过滤器的构造方法和初始化方法,在每次访问servlet时都会进入doFilter()方法,访问完servlet方法后又会返回到doFilter()方法,而destroy()方法只在停止服务器时才会执行一次。
下图通过时序图展示了有两个过滤器的Filter执行流程:
4.Filter映射
<filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定:Servlet 名称和资源访问的请求路径
<filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字
<filter-name>hello_filter</filter-name>
<url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)
<!-- 拦截指定的jsp -->
<url-pattern>/index.jsp</url-pattern>
<url-pattern>/list.jsp</url-pattern>
<!-- 拦截所有的jsp -->
<url-pattern>*.jsp</url-pattern>
<servlet-name>指定过滤器所拦截的Servlet名称。
<!-- 3. 根据servlet的内部名称拦截 -->
<servlet-name>IndexServlet</servlet-name>
<!-- 拦截指定的servlet -->
<url-pattern>/index</url-pattern>
<dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式,可以是REQUEST,INCLUDE,FORWARD和ERROR之一,默认REQUEST。用户可以设置多个<dispatcher> 子元素用来指定 Filter 对资源的多种调用方式进行拦截。
<!-- 拦截直接访问的请求或者重定向的资源 -->
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
<dispatcher> 子元素可以设置的值及其意义:
REQUEST:当用户直接访问页面时,Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时,那么该过滤器就不会被调用。
INCLUDE:如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。
FORWARD:如果目标资源是通过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。
ERROR:如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用。除此之外,过滤器不会被调用。
网友评论