一、Filter简介
Filter也称之为过滤器,它是Servlet技术中最激动人心的技术之一,WEB开发人员通过Filter技术,对web服务器管理的所有web资源:例如Jsp,
Servlet, 静态图片文件或静态html文件等进行拦截,从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等
一些高级功能。
Servlet API中提供了一个Filter接口,开发web应用时,如果编写的Java类实现了这个接口,则把这个java类称之为过滤器Filter。通过Filter
技术,开发人员可以实现用户在访问某个目标资源之前,对访问的请求和响应进行拦截,Filter接口源代码:
二、Filter是如何实现拦截的?(Filter的工作原理)
Filter接口中有一个doFilter方法,当我们编写好Filter,并配置对哪个web资源进行拦截后,WEB服务器每次在调用web资源的service方法之前,
都会先调用一下filter的doFilter方法,因此,在该方法内编写代码可达到如下目的:
调用目标资源之前,让一段代码执行。
是否调用目标资源(即是否让用户访问web资源)。
调用目标资源之后,让一段代码执行。
web服务器在调用doFilter方法时,会传递一个filterChain对象进来,filterChain对象是filter接口中最重要的一个对象,它也提供了一个
doFilter方法,开发人员可以根据需求决定是否调用此方法,调用该方法,则web服务器就会调用web资源的service方法,即web资源就会被访问,
否则web资源不会被访问。
三、Filter开发流程
3.1、Filter开发步骤
Filter开发分为2步:
* 编写java类实现Filter接口,并实现其doFilter方法。
* 在web.xml 文件中使用和元素对编写的filter类进行注册,并设置它所能拦截的资源。
在web. xml中配置过滤器:
六、Filter的部署时的一些参数的含义
Filter的部署分为两个步骤:
1、注册Filter
2、映射Filter
6.1、注册Filter
开发好Filter之后,需要在web.xml文件中进行注册,这样才能够被web服务器调用。在web.xml文件中注册Filter范例:
- public abstract interface Filter{
- public abstract void init(FilterConfig paramFilterConfig) throws ServletException;
- public abstract void doFilter(ServletRequest paramServletRequest, ServletResponse paramServletResponse, FilterChain
- paramFilterChain) throws IOException, ServletException;
- public abstract void destroy();
- }
过滤器范例:
- 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;
- /**
- * @author yangcq
- * @description 过滤器Filter的工作原理
- */
- public class FilterTest implements Filter{
- public void destroy() {
- System.out.println("----Filter销毁----");
- }
- public void doFilter(ServletRequest request, ServletResponse response,FilterChain filterChain) throws IOException, ServletException {
- // 对request、response进行一些预处理
- request.setCharacterEncoding("UTF-8");
- response.setCharacterEncoding("UTF-8");
- response.setContentType("text/html;charset=UTF-8");
- System.out.println("----调用service之前执行一段代码----");
- filterChain.doFilter(request, response); // 执行目标资源,放行
- System.out.println("----调用service之后执行一段代码----");
- }
- public void init(FilterConfig arg0) throws ServletException {
- System.out.println("----Filter初始化----");
- }
- }
- <filter>
- <filter-name>FilterTest
- <filter-mapping>
- <filter-name>FilterTest
- <url-pattern>/*
- FilterTest
- name
- gacl
- 配置FilterTest过滤器的初始化参数
- like
- java
- FilterDemo02
- /*
- */
- //得到过滤器的名字
- String filterName = filterConfig.getFilterName();
- //得到在web.xml文件中配置的初始化参数
- String initParam1 = filterConfig.getInitParameter("name");
- String initParam2 = filterConfig.getInitParameter("like");
- //返回过滤器的所有初始化参数的名字的枚举集合。
- Enumeration initParameterNames = filterConfig.getInitParameterNames();
- System.out.println(filterName);
- System.out.println(initParam1);
- System.out.println(initParam2);
- while (initParameterNames.hasMoreElements()) {
- String paramName = (String) initParameterNames.nextElement();
- System.out.println(paramName);
- }
- }
- @Override
- public void doFilter(ServletRequest request, ServletResponse response,
- FilterChain chain) throws IOException, ServletException {
- System.out.println("FilterDemo02执行前!!!");
- chain.doFilter(request, response); //让目标资源执行,放行
- System.out.println("FilterDemo02执行后!!!");
- }
- @Override
- public void destroy() {
- System.out.println("----过滤器销毁----");
- }
- }
- <filter>
- <description>过滤器名称
- <init-param>
- <description>配置过滤器的初始化参数 FilterTest /* 元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定:Servlet 名称和资源访问的请求路径 子元素用于设置filter的注册名称。该值必须是在元素中声明过的过滤器的名字 设置 filter 所拦截的请求路径(过滤器关联的URL样式) 指定过滤器所拦截的Servlet名称。 指定过滤器所拦截的资源被 Servlet 容器调用的方式,可以是REQUEST,INCLUDE,FORWARD和ERROR之一,默认REQUEST。用户可以设置多个子元素用来指定 Filter 对资源的多种调用方式进行拦截。如下: testFilter /index.jsp REQUEST FORWARD 子元素可以设置的值及其意义: REQUEST:当用户直接访问页面时,Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问 时,那么该过滤器就不会被调用。 INCLUDE:如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。 FORWARD:如果目标资源是通过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。 ERROR:如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用。除此之外,过滤器不会被调用。
关注
打赏