Web三大组件-Filter

Filter

​ Filter(过滤器)用于拦截用户请求,在服务器作出响应前,可以在拦截后修改request和response。可以实现一次编码,多处应用。Filter不像Servlet,它不能产生一个请求或者响应,它只是修改对某一资源的请求,或者修改从某一的响应。

通常来说最后的目的资源可以是JSP,Servlet,Html等web资源,本文中用Servlet来做为例子进行讲解。

file

作用

Filter主要的作用有两个:

  • 拦截修改请求:在HttpServletRequest到达Servlet之前,拦截客户的HttpServletRequest。根据需要检查HttpServletRequest,也可以修改HttpServletRequest头和数据。
  • 拦截修改响应:在HttpServletResponse到达客户端之前,拦截HttpServletResponse。根据需要检查HttpServletResponse,也可以修改HttpServletResponse头和数据。

原理

通常Filter完整的工作流程是:Filter对用户请求进行预处理,接着将请求交给Servlet进行处理并生成响应,最后Filter再对服务器响应进行后处理。

Filter的底层原理是基于函数回调的,很容易联想到设计模式中的责任链模式,有兴趣的朋友可以参看我之前的博文。

具体原理如图所示:

file

图示的Filter的逻辑为doFilter()方法的逻辑

    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        //对用户请求执行预处理的代码逻辑
        precode... 
        //交给FilterChain的下一个对象处理
        //如果还有filter则调用下一个filter
        //如果没有,则调用目标资源。
        chain.doFilter(req, resp);
        //对服务器响应执行后处理
        postcode... 
    }

其中:

  • preCode为Filter的doFilter()中chain.doFilter(request,response)调用之前的代码语句用于对用户请求执行预处理
  • postCode为Filter的doFilter()中chain.doFilter(request,response)调用之后的代码语句用于对服务器响应执行后处理

生命周期

Filter的生命周期和Servlet一样,Filter的创建和销毁也是由WEB服务器负责。

file
  • init(FilterConfig filterConfig)
    • 初始化方法,只会在web应用程序启动时调用一次
    • 和我们编写的Servlet程序一样,Filter的创建和销毁由WEB服务器负责。
    • web 应用程序启动时,web 服务器将创建Filter 的实例对象,并调用其init方法,读取web.xml配置,完成对象的初始化功能,从而为后续的用户请求作好拦截的准备工作(filter对象只会创建一次,init方法也只会执行一次)。开发人员通过init方法的参数,可获得代表当前filter配置信息的FilterConfig对象。
    • Filter对象创建之后会驻留在内存,一直服务。
  • doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
    • 完成实际的过滤操作。当客户请求访问与过滤器关联的URL的时候,Servlet过滤器将先执行doFilter方法。FilterChain参数用于访问后续过滤器。
  • destroy();
    • 销毁方法,只会在当web应用移除或服务器停止时才调用一次来卸载Filter对象。
    • 通常在这个方法中,可以释放过滤器使用的资源。

FilterChain

在一个web应用当中,可以开发编写多个Filter,这些Filter组合起来称之为一个Filter链,其中每个过滤器(Filter)都可以决定是否执行下一步。

FilterChain实际上是一个接口,该接口中有一个方法:

  • doFilter():。该方法被FilterChain对象调用,表示对Filter过滤器过滤范围下的资源进行放行,让链中下一个对象进行处理。

FilterChain在tomcat中的实现类是ApplicationFilterChain,一个ApplicationFilterChain对象包含几个主要参数

  • n => filter个数
  • pos => 下一个要执行的filter的位置
  • Servlet => 当pos >= n,即过滤完成时,调用Servlet的service方法,把请求交给Servlet
  • filters => Filter的相关配置信息

FilterChain持有所有Filter的配置信息,它们保存在一个数组中,然后通过移动pos,来获取后续的Filter并执行的,这就符合之前的链式处理流程。

线程是否安全?

可能你看到上面pos++,就担心是否会有线程安全问题,这里大可放心,FilterChain不存在线程安全问题的。

ApplicationFilterChain对象由ApplicationFilterFactory工厂的createFilterChain方法生成。而这个方法在ApplicationDispatcher的invoke方法内被调用。这个invoke方法是Connector把新请求传递给Container的方式。这样来看每个请求都会创建一个FilterChain对象,所以不用担心会有线程安全问题。

对于FilerChain,我们需要注意的点有:

  • 只要 Filter 链中任意一个 Filter 没有调用 FilterChain.doFilter 方法,则目标 Servlet 的 service 方法都不会被执行。
  • Filter 链中的各个 Filter 的拦截顺序与它们在 web.xml 文件中的映射顺序一致
  • 最后一个Filter调用doFilter 方法将激活目标 Servlet的service 方法。

FilterConfig

与普通的 Servlet 程序一样,Filter 也很可能需要访问 Servlet 容器。Servlet 规范将代表 ServletContext 对象和 Filter 的配置参数信息都封装到一个称为 FilterConfig 的对象中。

FilterConfig接口中有如下四个方法:

  • getInitParameter():获取初始化参数。
  • getInitParameterNames():获取所有初始化参数的名称。
  • getFilterName():获取过滤器的配置名称。
  • getServletContext():获取application。

使用方法

创建使用一个Filter只需要两个步骤:

  • 创建一个实现javax.servlet.Filter接口的Filter处理类实现过滤逻辑
  • 配置Filter到服务器中

Filter实现类

实现Filter接口,然后写对应的业务代码即可

public class MyFilter implements Filter {
    public void destroy() {
        /*销毁时调用*/
    }

    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        /*过滤方法 主要是对request和response进行一些处理,然后交给下一个过滤器或Servlet处理*/
        precode...
        chain.doFilter(req, resp);
        postcode...
    }

    public void init(FilterConfig config) throws ServletException {
        /*初始化方法  接收一个FilterConfig类型的参数 该参数是对Filter的一些配置*/

    }

}

配置方法

将Filter配置到服务器中有两种方法:

  • 使用web.xml 配置
            <filter>
                <filter-name>myFilter</filter-name>
                <filter-class>whu.web.filter.myFilter</filter-class>
            </filter>
            <filter-mapping>
                <filter-name>myFilter</filter-name>
                <url-pattern>/*</url-pattern>
            </filter-mapping>
  • 基于注解的配置
@WebFilter("/*") 

在注解中可以配置的属性如下:

������述

一些常用配置项:

  • urlPatterns:配置拦截的资源路径
    • 精确匹配 —— 如/foo.htm,只会匹配foo.htm这个URL
    • 路径匹配 —— 如/foo/*,会匹配以foo为前缀的URL
    • 后缀匹配 —— 如*.htm,会匹配所有以.htm为后缀的URL
    • 通配——/*,会拦截所有web资源
  • initParams:配置初始化参数
    • initParams = {
      @WebInitParam(name = "key",value = "value")
      }
    • 配置之后即可通过Filterconfig.getInitParameter("key")获得对应value
  • dispatcherTypes:配置拦截的类型,可配置多个
    • REQUEST:直接访问目标资源时执行过滤器。包括:在地址栏中直接访问、表单提交、超链接、重定向,只要在地址栏中可以看到目标资源的路径,就是REQUEST;
    • FORWARD:转发访问执行过滤器。包括RequestDispatcher#forward()方法、< jsp:forward>标签都是转发访问;
    • INCLUDE:包含访问执行过滤器。包括RequestDispatcher#include()方法、< jsp:include>标签都是包含访问;
    • ERROR:当目标资源在web.xml中配置为< error-page>中时,并且真的出现了异常,转发到目标资源时,会执行过滤器。

Filter执行顺序

Filter的执行顺序是按照FilterChain来执行的,FilterChain中Filter的顺序不同配置方式下的组织情况不同,具体如下:

  • 基于注解配置:按照类名的字符串比较规则比较,值小的先执行
  • 使用web.xml配置:根据对应的Mapping的顺序组织,谁定义在上边谁就在前

实际运用

在实际使用过程中,Filter通常有以下用途:

  • 处理全站中文乱码问题
  • 过滤非法请求
  • 实现自动登录
  • 过滤敏感词汇
  • 压缩网页
  • 选择性让浏览器缓存
  • 结合日志记录用户操作

参考文章

拦截器(Interceptor)和过滤器(Filter)的执行顺序和区别

Javaweb三大组件-过滤器、监听器

Java Web中的三大器

JavaWeb中filter的详解及应用案例

JavaWeb三大组件

Java Web之过滤器(Filter)

【杂谈】FilterChain相关知识整理

本文由博客群发一文多发等运营工具平台 OpenWrite 发布

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335