过滤器(Filter)

Posted gdwkong

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了过滤器(Filter)相关的知识,希望对你有一定的参考价值。

一、JavaWeb三大组件

  都需要在web.xml中进行配置

    • Servlet
    • Listener(2个感知监听器不需要配置)
    • Filter

二、过滤器

1、什么是过滤器
  过滤器JavaWeb三大组件之一,它与Servlet很相似!不它过滤器是用来拦截请求的,而不是处理请求的。
  当用户请求某个Servlet时,会先执行部署在这个请求上的Filter,如果Filter“放行”,那么会继承执行用户请求的Servlet;如果Filter不“放行”,那么就不会执行用户请求的Servlet。
  其实可以这样理解,当用户请求某个Servlet时,Tomcat会去执行注册在这个请求上的Filter,然后是否“放行”由Filter来决定。可以理解为,Filter来决定是否调用Servlet!当执行完成Servlet的代码后,还会执行Filter后面的代码。
Filter是单例的

创建示例:

 1 package web.filter;
 2 
 3 import javax.servlet.*;
 4 import javax.servlet.annotation.WebFilter;
 5 import java.io.IOException;
 6 
 7 @WebFilter(filterName = "AFilter",urlPatterns = "/AServlet")
 8 //urlPatterns为拦截资源路径名,等同于在下文配置web.xml文件
 9 public class AFilter implements Filter {
10     /*
11     * 创建之后马上执行,用来做初始化,Filter会在服务器启动时就创建
12     * */
13     public void init(FilterConfig config) throws ServletException {
14         System.out.println("过滤器出生了");
15     }
16     /*
17     *每次过滤时都会执行
18     * */
19     public void doFilter(ServletRequest req, ServletResponse resp,
20                          FilterChain chain) throws ServletException, IOException {
21         System.out.println("拦截你");
22     }
23 
24     /*
25     * 销毁之前执行,在服务器关闭时销毁
26     * */
27     public void destroy() {
28         System.out.println("过滤器要销毁了");
29     }
30 }

web.xml文件

1 <filter>
2       <filter-name>AFilter</filter-name>
3       <filter-class>web.filter.AFilter</filter-class>
4 </filter>
5 <filter-mapping>
6       <filter-name>AFilter</filter-name>
7       <url-pattern>/AServlet </url-pattern>
8 </filter-mapping>

 2、过滤器的生命周期

  • init(FilterConfig):在服务器启动时会创建Filter实例,并且每个类型的Filter只创建一个实例,从此不再创建!在创建完Filter实例后,会马上调用init()方法完成初始化工作,这个方法只会被执行一次;
  • doFilter(ServletRequest req,ServletResponse res,FilterChain chain):这个方法会在用户每次访问“目标资源

(<url-pattern>index.jsp</url-pattern>)”时执行,如果需要“放行”,那么需要调用FilterChain的doFilter(ServletRequest,ServletResponse)方法,如果不调用FilterChain的doFilter()方法,那么目标资源将无法执行;

  • destroy():服务器会在创建Filter对象之后,把Filter放到缓存中一直使用,通常不会销毁它。一般会在服务器关闭时销毁Filter对象,在销毁Filter对象之前,服务器会调用Filter对象的destory()方法。
3、FilterConfig

  功能与ServletConfig相似,与web.xml文件中的配置信息对应。下面是FilterConfig的功能介绍:

  • ServletContext getServletContext():获取ServletContext的方法;
  • String getFilterName():获取Filter的配置名称;与<filter-name>元素对应;
  • String getInitParameter(String name):获取Filter的初始化配置,与<init-param>元素对应;
  • Enumeration getInitParameterNames():获取所有初始化参数的名称。
4、多个过滤器执行顺序
      一个目标资源可以指定多个过滤器,过滤器的执行顺序是在web.xml文件中的部署顺序;
5、过滤器有四种拦截方式
  • 请求REQUEST:<dispatcher>REQUEST</dispatcher>(默认)
  • 转发FORWARD:<dispatcher>FORWARD</dispatcher>
  • 包含INCLUDE:<dispatcher>INCLUDE</dispatcher>
  • 错误ERROR:<dispatcher>ERROR</dispatcher>

自动配置web.xml:

@WebFilter(filterName = "BFilter",urlPatterns = "/AServlet",dispatcherTypes = FORWARD)
//需导包

6、过滤器的应用场景

  • 执行目标资源之前做预处理工作,例如设置编码,这种试通常都会放行,只是在目标资源执行之前做一些准备工作;
  • 通过条件判断是否放行,例如校验当前用户是否已经登录,或者用户IP是否已经被禁用;
  • 在目标资源执行后,做一些后续的特殊处理工作,例如把目标资源输出的数据进行处理;

7、设置目标资源

在web.xml文件中部署Filter时,可以通过“*”来执行目标资源:
<filter-mapping>
<filter-name>myfilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
还可以为<filter-mapping>指定目标资源为某个Servlet,例如:
<servlet>
<servlet-name>myservlet</servlet-name>
<servlet-class>servlet.MyServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>myservlet</servlet-name>
<url-pattern>/abc</url-pattern>
</servlet-mapping>
<filter>
<filter-name>myfilter</filter-name>
<filter-class>filter.MyFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>myfilter</filter-name>
<servlet-name>myservlet</servlet-name>
</filter-mapping>
当用户访问http://localhost:8080/filtertest/abc时,会执行名字为myservlet的Servlet,这时会执行过滤器。
 
8、filter中的注解说明(idea):
@WebFilter(filterName = "AFilter",servletNames = "AServlet",
urlPatterns = "/AServlet",dispatcherTypes = DispatcherType.FORWARD)
/*filterName 过滤器名
servletNames 指定过滤的servlet名字
urlPatterns为拦截资源路径
dispatcherTypes为拦截类型*/
 
 
 

以上是关于过滤器(Filter)的主要内容,如果未能解决你的问题,请参考以下文章

基于内部片段的graphql过滤器(gatsbyJS)

使用Logstash filter grok过滤日志文件

servlet,过滤器,监听器,拦截器的区别

vue实现简单的过滤器

Scapy BPF 过滤器不工作

在着色器中访问时,OpenGL如何决定使用MAG_FILTER和MIN_Filter?