@WebFilter两种使用方法和失效解决方案
创始人
2024-04-06 14:44:19
0

1、直接使用过滤器不会生效@WebFilter(urlPatterns="/dd/*", filterName=“loginFilter”)
需要在springboot启动类上加上@ServletComponent注解才会生效(无法设置Filter顺序)

/**  * @author nineee* @description urlPatterns:拦截的url地址 *              filterName:拦截器名称* @date 2020/8/31 16:09*/
@Slf4j
@WebFilter(urlPatterns="/dd/*", filterName="loginFilter")
public class LoginFilter implements Filter{/** 容器加载完成调用* */@Overridepublic void init(FilterConfig filterConfig) throws ServletException {log.info("LoginFilter.init");}/**  请求被拦截的时候调用* */@Overridepublic void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)throws IOException, ServletException {log.info("LoginFilter.doFilter");HttpServletRequest req = (HttpServletRequest)request;HttpServletResponse resp = (HttpServletResponse)response;chain.doFilter(request, response);}/** 容器被销毁的时候调用* */@Overridepublic void destroy() {System.out.println("filter destroy...");}
}
@SpringBootApplication
@ServletComponentScan
public class NineeeStart {public static void main(String[] args) {SpringApplication.run(NineeeStart.class, args);}
}


2、手动配置bean(推荐这种方式,可以在FilterRegistrationBean里设置Order)

不需要@WebFilter注解

/*** @author nineee* @description urlPatterns:拦截的url地址*              filterName:拦截器名称* @date 2020/8/31 16:09*/
@Slf4j
public class LoginFilter implements Filter{/** 容器加载完成调用* */@Overridepublic void init(FilterConfig filterConfig) throws ServletException {log.info("LoginFilter.init");}/**  请求被拦截的时候调用* */@Overridepublic void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)throws IOException, ServletException {log.info("LoginFilter.doFilter");HttpServletRequest req = (HttpServletRequest)request;HttpServletResponse resp = (HttpServletResponse)response;chain.doFilter(request, response);}/** 容器被销毁的时候调用* */@Overridepublic void destroy() {System.out.println("filter destroy...");}
}
@Configuration
public class WebAuthFilterConfig {@Beanpublic FilterRegistrationBean webAuthFilterRegistration() {FilterRegistrationBean registration = new FilterRegistrationBean();registration.setFilter(loginFilter());registration.setName("LoginFilter");registration.addUrlPatterns("/spu/*");
//        registration.addInitParameter("excludeUrls", "/web/login");registration.setOrder(0);return registration;}@Beanpublic Filter loginFilter() {return new LoginFilter();}
}


3、网上有的加上@Component注解@Configuration注解过滤器会生效,url会匹配全部,原因得去扒源码看。
过程可以看这篇:

@WebFilter 的使用及采坑 - 木西-Muxy - 博客园 (cnblogs.com)icon-default.png?t=M85Bhttps://www.cnblogs.com/muxi0407/p/11950627.html我尝试了如下几种情况

  1. Filter 实现类 + @WebFilter + @ServletComponentScan:正常urlpattern的Filter
  2. Filter 实现类 + FilterRegistrationBean构造 + @Configuration:正常urlpattern的Filter,并且可以设置Order
  3. 仅仅 Filter实现类 + @Component :会注册一个urlpattern 为 /*的过滤器
  4. 通过1、2、3可以得知,只要在Filter实现类上增加 @Component ,就会导致 1个正常urlpattern的filter+1个拦截/*的filter(由于@Component注解导致)

具体原因可以查看关键类:ServletContextInitializerBeans,看名字就知道,这个类收集了所有ServletContextInitializer的bean列表,而这个接口的实现

 就是所有可以注册Filter、servlet、Listener的 RegistrationBean。

与此同时,ServletContextInitializerBeans的构造函数中做了几件事:

 1、将各个RegistrationBean 放入 MultiValueMap, ServletContextInitializer> initializers 中

 

 2、addAdaptableBeans 方法是上面提到的 增加@Component注解后,就会增加一个 urlpattern 为/* 的filter的元凶了,拿Filter来举例,首先,它会获取所有实现Filter类的Bean集合,并通过FilterRegistrationBeanAdapter中的createRegistrationBean方法 创建一个新的 FilterRegistrationBean,并把Filter的Bean当成构造函数进行初始化,可以看到他并未设置FilterRegistrationBean中的其它Filter属性,比如urlPatterns 都为空。

 

 

 3、最后,将1与2中的所有ServletContextInitializer 实例通过Order等排序手段放入 List sortedList中,ServletContextInitializerBeans构造完成。

4、接下来我们来看下 ServletContextInitializerBeans 是在什么时候进行调用的,经过一系列的debug和搜索后锁定了 ServletWebServerApplicationContext

 在 Spring容器启动后,调用了 refresh方法,接着createWebServer 、this.getSelfInitializer().onStartup(servletContext);、

 在这里,构造了上文中提到的ServletContextInitializerBeans,并通过ServletContextInitializerBeans的迭代器获取了所有  ServletContextInitializer 实例,可以看到正是获取了上文中提到的sortedList

 最后通过调用每个 ServletContextInitializer 实例的 onstartup方法,进行了 Filter 的注册

 

进入了  FilterRegistrationBean的父类 AbstractFilterRegistrationBean 的 configure方法

 

 可以明显看到 当 servletname 和 urlpatterns 为空时,使用了 默认值 DEFAULT_URL_MAPPINGS,而这个默认值 正是

 后续就是正常配置filter的逻辑了

完。 

 

相关内容

热门资讯

盘州市南湖社区:打造法律“服务... 近年来,为破解基层法律服务“最后一公里”难题,推进社区矛盾纠纷法治化实质性化解,贵州省盘州市以“精准...
内乡法院:彩礼纠纷引诉讼 法院... 大象新闻记者 魏广宝 通讯员 聂传青 张航/文图 近日, 内乡县人民法院灌涨法庭成功调解一起因婚姻关...
税费服务“主动敲门” 政策红利... “税务部门的主动提醒和精准辅导真是太及时了,不仅帮我们规避了因政策理解偏差可能引发的风险,更让我们实...
民政部:会同有关部门建立最低生... 据新华社,记者12月30日在全国民政工作会议上获悉,民政部将会同有关部门建立最低生活保障标准备案制度...
肯尼亚投资:税务及法律合规指引 一、肯尼亚的外国直接投资 肯尼亚无疑是非洲吸引外国直接投资(FDI)最多的国家之一。根据《2025年...
大同多部门联动打击生态环境违法... 本报讯(通讯员刘美 陈俊宏)近日,大同市中级人民法院联合大同市人民检察院、大同市公安局、大同市司法局...
南阳宛城检察:让道争执酿祸端 ... 大象新闻记者 张定有 通讯员 魏颖 张婷/文图 一桩因乡间小道通行引发的争执,险些酿成极端事件。南阳...
寻找靠谱征地律师,孙侠律师 在征地相关法律事务中,找到一位靠谱且成功率高的征地律师至关重要。随着城市化进程的加速,征地纠纷日益增...
民政部:会同有关部门建立最低生... 记者12月30日在全国民政工作会议上获悉,民政部将会同有关部门建立最低生活保障标准备案制度,从制度上...