Filter（过滤器）

简介

Filter的基本功能是对 Servlet容器调用 Servlet的过程进行拦截，从而在 Servlet进行响应处理的前后实现一些特殊的功能。
在 Servlet AP|中定义了三个接口类来开供开发人员编写Filter程序: Filter，FilterChain，FilterConfig
Filter程序是一个实现了Fier接口的Java类，与 Servlet程序相似，它由Sere容器进行调用和执行
Filter程序需要在 web.xml 文件中进行注册和设置它所能拦截的资源: Filter程序可以拦截 Jsp，Servlet静态图片文件和静态htm文件

1 Filter是什么？

JavaWeb 的一个重要组件，可以发送到 Servlet 的请求进行拦截，并对响应也进行拦截
Filter 是实现了 Filter 接口的 Java 类
FIlter 需要在 web.xml 文件进行配置和映射
Filter 的过滤过程

2 Filter如何创建，并运行

创建一个 FIlter类：实现 FIlter 接口
在 web.xml 文件中配置并映射该 Filter （类比于Servlet），其中 url-pattern 指定该 FIlter 可以拦截哪些资源，即可以通过哪些 url 访问到该 Filter

<!-- 注册 Filter -->
<filter>
    <filter-name >helloFilter</filter-name>
    <filter-class>com. atguigu javaweb HelloFilter</filter-class>
</filter>

<!-- 映射 Filter -->
<filter-mapping>
    <filter-name >helloFilter</filter-name>
    <url-pattern>/test.jsp</url-pattern>
</filter-mapping>

3 Filter 相关的API

Filter接口：

public void init(FilterConfig filterConfig):

类似与Servlet 的 init 方法，在创建Filter对象后，立即被调用，且只被调用一次。Filter 对象在 Servlet 容器加载当前 WEB 应用时即被创建，该方法用于对当前的 Filter 进行初始化操作，Filter 实例时单例的
```
* FilterConfig 类似于 ServletConfig
* 可以在web.xml 文件中配置当前 Filter 的初始化参数。配置方式和 Servlet 相似
```
```
<filter>
    <filter-name>helloFilter</filter-name>
    <filter-class>com.atguigu.javaweb.HelloFilter</filter-class>
    <init-param>
        <param-name >name</param-name>
        <param-value>root</param-value>
    </init-param>
</filter>
```
public void doFilter(ServletRequest request， ServletResponse response， FilterChain chain)：

真正 FIlter 的逻辑代码要写在该方法中，每次拦截都会调用
FilterChain：Filter链，多个 FIlter 可以构成一个FIlter 链
- doFIlter(ServletRequest request， ServletResponse response)：白请求传给 Filter 链的下一个FIlter 若当前 FIlter 链的最后一个 Filter，将把请求给到目标 Servlet(或JSP)
- 多个 Filter 拦截的顺序和 <filter-mapping> 配置的顺序有关，靠前的先被调用
public void destroy()：释放当前 Filter 所占用的资源的方法，在 Filter 被销毁之前调用，且只调用一次

4 Filter 工作原理

当在 web.xml 中注册了一个 Filter 来对某个 Servlet 程序进行拦截处理时；

这个 Filter 就成了 Servlet 容器与该 Servlet 程序的通信线路上的一道关卡；

该 Filter 可以对 Servlet 容器发送给 Servlet 程序的请求和 Sevlet 程序回送给 Servlet 容器的响应进行拦截，可以决定是否将请求继续传递给 Servlet 程序，以及对请求和相应信息是否进行修改
在一个 Web 应用程序中可以注册多个 Filter 程序，每个 Filter 程序都可以对一个或一组 Servlet 程序进行拦截。
若有多个 FIlter 程序对某个 Servlet 程序的访问过程进行拦截，当针对该 Servlet 的访问请求到达时，web 容器将把这多个 Filter 程序组合成一个 Filter链接 (链过滤器链) 。Filter 链中各个 Filter 的拦截顺序与它们在应用程序的 web.xml 中映射的顺序一致

5 Filter 接口

init(Filter Config filterConfig) throws ServletException：

在 web 应用程序启动时，web服务器将根据 web.xml 文件中的配置信息来创建每个注册的 Filter 实例对象，并将其保存在服务器的内存中。

Web容器创建 Filter 对象实例后，将立即调用该 Filter 对象的 init 方法。

init 方法在 Filter 生命周期中仅执行一次，web 容器在调用 init 方法时，会传递一个包含 Filter 的配置和运行环境的 FilterConfig 对象 (FilterConfig 的用法和 ServletConfig 类似)。

利用 FilterConfig 对象可以得到 ServletContext 对象，以及部署描述符中配置的过滤器的初始化参数。在这个方法中，可以抛出 ServletException 异常，通知容器该过滤器不能正常工作。
destroy()：在 Web 容器卸载 Filter 对象之前被调用。该方法在 Filter 的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源
与开发 Servlet 不同的是，Fite接口并没有相应的实现类可供继承，要开发过滤器，只能值接实现 Filter 接口。
doFilter(ServletRequest request， ServletResponse response， FilterChain chain) throws java.io.IOException， ServletException：

doFilter方法类似于 Servlet 接口的service() 方法。当客户端请求目标资源的时候，容器就会调用与这个目标资源相关联的过滤器的 doFilter()方法。

其中参数 request， response 为 web容器或 Filter链的上一个Filter 传递过来的请求和相应对象；

参数 chain 为代表当前 Filter链的对象，在特定的操作完成后，可以在当前 Filter 对象的 doFilter 方法内部需要调用 FilterChain 对象的 chain.doFilter( request， response) 方法才能把请求交付给 Filter 链中的下一个 Filter 或者目标 Servlet 程序去处理，

也可以直接向客户端返回响应信息，或者利用 RequestDispatcher 的 forward() 和 include方法，以及 Http servletrEsponse 的 send Redirect方法将请求转向到其他资源。

这个方法的请求和响应参数的类型是 ServletRequest 和 ServletResponse，也就是说，过滤器的使用并不依赖于具体的协议。

6 FilterConfig 接口

javax.servlet.FilterConfig接口：该接口类似于 ServletConfig 接口，由容器实现。Servlet 规范将代表 ServletContext 对象和 Filter 的配置参数信息都封装在该对象中。Servlet 容器将其作为参数传入过滤器对象的 init() 方法中。
String getFilterName()：得到描述符中指定的过滤器的名字。
String getInitParameter( String name)：返回在部署描述中指定的名字为 name 的初始化参数的值。如果不存在返回null
Enumeration getlnitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。
public ServletContext getServletContext()：返回 Servlet 上下文对象的引用。

7 映射 Filter

在同一个 web.xml 文件中可以为同一个 Filter 设置多个映射。

若一个 Filter 链中多次出现了同一个 Filter 程序这个 Filter 程序的拦截处理过程捋被多次执行。
<filter-mapping> 元素用于设置一个 Filter 所负责拦截的资源。一个 Filter 拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径 (url样式)
<filter-name> 子元素用于设置 filter 的注册名称。该值必须是在元素中声明过的过滤器的名字
<url-pattern> 设置 filter 所拦截的请求路径过滤器关联的 URL 样式
<servlet-name> 指定过滤器所拦截的 Servlet名称。
<dispatcher> 指定过滤器所拦截的资源被 Servlet 容器调用的方式可以是 REQUEST、INCLUDE、FORWARD 和 ERROR 之一，默认REQUEST 可以设置多个子元素用来指定 FIlter 对资源的多种调用方式进行拦截。

JavaWeb学习笔记（四）【过滤器】

Filter（过滤器）

简介

1 Filter是什么？

2 Filter如何创建，并运行

3 Filter 相关的API

4 Filter 工作原理

5 Filter 接口

6 FilterConfig 接口

7 映射 Filter