J2EE Filter 基础知识总结

我会带着你远行 2022-12-02 04:27 195阅读 0赞

*  **Tomcat 9**

Filter（过滤器）

1.  Tomcat 提供的一个组件，类似 Servlet 机制与使用方式
2.  是一个特殊的 Servlet
3.  过滤什么? 什么时候使用?

# 一：Filter 的基本使用 #

1.  自己定义一个类，继承 HttpFilter
2.  重写方法，重写 doFilter、init、destroy
3.  doFilter 方法的三个参数，HttpServletRequest、HttpServletResponse、FilterChain
4.  可以抛出两个异常，ServletException、IOException
5.  配置 web.xml 文件

<filter>
    	<filter-name>xxx/filter-name>
    	<filter-class>类全名</filter-class>	
    </filter>
    
    <filter-mapping>
    	<filter-name>xxx</filter-name>
    	<url-pattern>/请求名</url-pattern>
    </filter-mapping>

*  filter 与 servlet 都可以拦截同一个请求，但是 **filter 先执行**，因为 servlet（或者 JSP）是真正的目标，filter 是到达真正目标之前的一个环节
 *  filter 放行之后，请求才能到达真正的目标 servlet（或者 JSP）

//放行前做事
    ...
    
    chain.doFilter(request, response); //放行
    
    //放行后做事
    ...

虽然 Filter 可以实现 Servlet 全部功能，但是使用上最好作为过滤器（一般而言，一个过滤器是用来拦截多个请求的）

**Filter 拦截请求的三种写法（web.xml 配置文件的写法）：**

*  filter 拦截一个请求

<url-pattern>/请求名</url-pattern>

*  filter 可以拦截所有请求

<url-pattern>/*</url-pattern>

*  filter 可以拦截所有 JSP 请求

<url-pattern>*.jsp</url-pattern>

**Filter 的使用场景：**

1.  用户认证
2.  事务的处理
3.  字符集处理
4.  …

# 二：Filter 的管理机制 #

**（1）Filter 对象采用生命周期托管方式实现单例模式**

**（2）默认效果是立即加载模式**

与 Servlet 的延迟加载模式不同，Filter 是立即加载模式，并且不能通过配置 load-on-startup 来进行修改优先级

因为 Filter 必须要在 Servlet、JSP 之前加载好，所以只能是立即加载模式

**（3）Filter 对象生命周期**

Tomcat9 为了更好的管理对象的产生和销毁，提供了三个方法标识 Filter对象的生命周期

1.  `init()`  
    Servlet对象创建的时候调用的，像似构造方法
2.  `doFilter()`  
    执行体
3.  `destroy()`  
    Servlet对象被回收的时候调用的，像 finalize() 方法

**（4）****Filter 对象加载时，可以携带信息**

在 web.xml 配置文件中添加以下内容：

<filter>   
        ...
        <init-param>
    		<param-name>key1</param-name>
            <param-value>value1</param-value>
        </init-param>
        ...
        <init-param>
            <param-name>keyN</param-name>
            <param-value>valueN</param-value>
    	</init-param>
    </filter>
    
    <filter-mapping>
        ...
    </filter-mapping>

与此对应的，Filter对象生命周期的 `init()` 方法有一个重载方法读取 Filter 对象加载时携带的信息

# 三：Filter 的继承关系 #

Filter 的继承关系与 Servlet 的继承关系是非常类似的，  
![在这里插入图片描述][20200830213913965.png]

*  三个接口
    
     *  Serializable 序列化接口
     *  FilterConfig 接口，方法涉及到 web.xml 配置文件  
        ![在这里插入图片描述][20200830214318781.png]
     *  Filter 接口，三个管理生命周期的方法  
        ![在这里插入图片描述][20200830214243811.png]
 *  抽象的父类 GenericFilter，实现三个接口，体现了缺省适配器模式；还增加了 init 方法重载

public void init(FilterConfig filterConfig) throws ServletException { 
        this.filterConfig = filterConfig;
        this.init();
    }

*  抽象的父类 HttpFilter，做一个参数类型的转化 （将无协议的参数强制转化成 Http 协议的参数）
 *  我们自己写的类

# 四：Filter 链 #

**（1）****Filter 拦截请求**

*  **Filter 可以拦截浏览器发来的请求、服务器内请求重定向，但不拦截服务器内请求转发**  
    总结：同一次请求默认不经过 Filter，而一次新请求会经过 Filter
 *  如果想要让所有的请求都经过 Filter 过滤，需要配置 web.xml 文件

<filter>
    	...
    </filter>
    <filter-mapping>
    	...
    	<dispatcher>REQUEST</dispatcher>
    	<dispatcher>FORWARD</dispatcher>
    </filter-mapping>

默认是只配置 `<dispatcher>REQUEST</dispatcher>`，  
如果只配置 `<dispatcher>FORWARD</dispatcher>` 会将默认效果覆盖掉，只过滤请求转发，  
所以想要过滤任意请求，需要配置两行。

**（2）****Filter 处理请求**

*  可以有多个 Filter，如果都可以拦截同一个请求，Filter 执行先后顺序如何？
    
     *  按照 web.xml 配置文件中先后顺序进行拦截
 *  多个 Filter 与 同一个 Servlet，执行顺序本质上是方法的压栈与弹栈；
    
     *  执行 Servlet 之前，Filter 拦截请求是按照压栈顺序执行；
     *  `chain.doFilter(request, response);` 执行，则下一个 Filter 或者 Servlet 入栈；
     *  执行 Servlet 之后，Filter 按照弹栈的顺序拦截响应，一个个的执行完 `chain.doFilter(request, response);` 后面的代码，然后弹出。
 *  执行到某个 Filter 时并没有执行 `chain.doFilter(request, response);` ，那就没有后面的 Filter 或者 Servlet 的事了，而是执行该 Filter 中的响应或者重定向或者转发或者…

**（3）****Filter 链是责任链设计模式**

责任链设计模式（Chain of Responsbility Pattern）与双向链表非常相似，差别点：

*  双向链表中每一个节点都知道上一个节点、下一个节点是谁；
 *  而责任链设计模式中不知道自己的上一个责任人或者下一个责任人是谁，通过管理者分配
    
     *  doFilter 方法中的参数 `FilterChain` 就是管理者
     *  Filter 类中每一个 filter 对象管理当前 filter 做的事情（doFilter 方法）
     *  体现了 AOP（面向切面编程） 编程思想

[20200830213913965.png]: https://img-blog.csdnimg.cn/20200830213913965.png
[20200830214318781.png]: /images/20221123/fb2269fb81db4aa1b0999095cc3f37bb.png
[20200830214243811.png]: /images/20221123/9fc435299c854a859df0d700ace050cf.png