关于Filter的一些使用总结

最近在项目中看到filter使用有很多种,于是自己写下这个笔记作为记录。
项目中定义的方式有2种:
直接继承Filter

public class MyFilter implements Filter{
    ...
}

继承OncePerRequestFilter

public class MyOncePerRequestFilter implements OncePerRequestFilter{
    ...
}

因为OncePerRequestFilter继承Filter ,这2种定义的方式其实差不多,本意都是每个请求只执行一次此过滤器。spring中filter都是继承OncePerRequestFilter,查过一些文档得到答案是,Filter是servlet实现的,即时web容器实现的,而不是版本的Filter实现方式可能不一致。
如,servlet2.3与servlet2.4也有一定差异

在servlet-2.3中,Filter会过滤一切请求,包括服务器内部使用forward转发请求和<%@ include file="/index.jsp"%>的情况。

到了servlet-2.4中Filter默认下只拦截外部提交的请求,forward和include这些内部转发都不会被过滤,但是有时候我们需要 forward的时候也用到Filter。

而spring使用OncePerRequestFilter方式是为了兼容不同的web container,特意而为之(jsr168),所以默认filter继承OncePerRequestFilter是一个比较稳妥的选择

另外注册Filter的方式也有多种,因为项目使用spring-boot,本地使用内嵌tomcat进行调试,而部署到服务器使用war的方式部署。
项目使用了这几种方式进行注册
本地debug环境

@Configuration
@Conditional(DebugEnvCondition.class)
public class FilterConfiguration {
    @Bean
    public FilterRegistrationBean myFilter() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(new MyFilter());
        registration.setOrder(Integer.MAX_VALUE - 1);
        registration.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.FORWARD);
        registration.setAsyncSupported(true);
        registration.addUrlPatterns("/*");
        return registration;
    }
}

war包使用web.xml的方式进行注册

    <filter>
        <filter-name>myFilter</filter-name>
        <filter-class>com.test.MyFilter</filter-class>
        <async-supported>true</async-supported>
    </filter>

    <filter-mapping>
        <filter-name>debugFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

有的filter类上会加上WebFilter进行注解

@WebFilter(filterName = "myFilter", urlPatterns = "/*",
                dispatcherTypes = {DispatcherType.REQUEST, DispatcherType.FORWARD}, asyncSupported = true)
public class MyFilter extends OncePerRequestFilter 

常规使用方式其实是不用web.xml的方式也是可以的
用WebFilter注解,然后再启动类上加ServletComponentScan注解

SpringBootApplication 上使用@ServletComponentScan 注解后
Servlet可以直接通过@WebServlet注解自动注册
Filter可以直接通过@WebFilter注解自动注册
Listener可以直接通过@WebListener 注解自动注册

单独使用WebFilter注解后如果使用war包部署到外包tomcat下,这样是可以注册到filterChain中,使filter生效,只是本地调试不作用。
第三方的Filter一般是通过**FilterAutoConfiguration进行注册,也是上面本地debug方式,只是环境没有限制在debug环境中,通过这种方式注册到servlet的filter链表中

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

推荐阅读更多精彩内容

  • 本章聊一聊ServletContext 3.0规范中定义的注解以及在web应用中使用的框架和库的可插拔性的提升。 ...
    Lucky_Micky阅读 5,991评论 0 3
  • Version:1.0StartHTML:000000231EndHTML:000105074StartFragm...
    yasuo1阅读 234评论 0 0
  • IOC 控制反转容器控制程序对象之间的关系,而不是传统实现中,有程序代码之间控制,又名依赖注入。All 类的创建,...
    irckwk1阅读 922评论 0 0
  • 1、Filter介绍 Filter技术是servlet 2.3新增加的功能。servlet2.3是sun公司于20...
    SpaceCat阅读 692评论 0 1
  • 快啊,丫头。赶紧啊,现在都几点了,知不知道。 车怎么还不来呢?不是十分钟一趟吗? 快,快,快,再来几个,再来几个!...
    叶青竹阅读 656评论 0 2