Filter过滤器

一、Filter过滤器

过滤器实际上就是对web资源进行拦截，做一些处理后再交给下一个过滤器或servlet处理。通常都是用来拦截request进行处理的，也可以对返回的response进行拦截处理

二、应用场景

自动登录，统一设置编码格式，访问权限控制，敏感字符过滤等

根据规范建议的各种类型的过滤器：

1. 身份验证过滤器（Authentication Filters）。
2. 数据压缩过滤器（Data compression Filters）。
3. 加密过滤器（Encryption Filters）。
4. 触发资源访问事件过滤器。
5. 图像转换过滤器（Image Conversion Filters）。
6. 日志记录和审核过滤器（Logging and Auditing Filters）。
7. MIME-TYPE 链过滤器（MIME-TYPE Chain Filters）。
8. 标记化过滤器（Tokenizing Filters）。
9. XSL/T 过滤器（XSL/T Filters），转换 XML 内容。

过滤器通过 Web 部署描述符（web.xml）中的 XML 标签来声明，然后映射到您的应用程序的部署描述符中的 Servlet 名称或 URL 模式。

当 Web 容器启动 Web 应用程序时，它会为您在部署描述符中声明的每一个过滤器创建一个实例。

Filter的执行顺序与在web.xml配置文件中的配置顺序一致，一般把Filter配置在所有的Servlet之前。

三、Filter过滤方法

过滤器是一个实现了 javax.servlet.Filter 接口的 Java 类。javax.servlet.Filter 接口定义了三个方法

1）public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

该方法完成实际的过滤操作，当客户端请求方法与过滤器设置匹配的URL时，Servlet容器将先调用过滤器的doFilter方法。

FilterChain用户访问后续过滤器

2）public void init(FilterConfig fConfig)

web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能。

从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）。

开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。

3）public void destroy()

Servlet容器在销毁过滤器实例前调用该方法，在该方法中释放Servlet过滤器占用的资源。

四、多个Filter的执行顺序

在我们的请求到达Servle之间是可以经过多个Filter的，一般来说，建议Filter之间不要有关联，各自处理各自的逻辑即可。这样，我们也无需关心执行顺序问题。

如果一定要确保执行顺序，就要对配置进行修改了，执行顺序如下：

① 在web.xml中，filter执行顺序跟<filter-mapping>的顺序有关，先声明的先执行

② 使用注解配置的话，filter的执行顺序跟名称的字母顺序有关，例如AFilter会比BFilter先执行

③ 如果既有在web.xml中声明的Filter，也有通过注解配置的Filter，那么会优先执行web.xml中配置的Filter

五、web.xml配置各节点说明

1）<filter>：指定一个过滤器

• <filter-name>：用于为过滤器指定一个名字，该元素的内容不能为空。
• <filter-class>：元素用于指定过滤器的完整的限定类名。
• <init-param>：元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。

在过滤器中，可以使用 FilterConfig 接口对象来访问初始化参数。

2）<filter-mapping>：用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径

• <filter-name>：子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字
• <url-pattern>：设置 filter 所拦截的请求路径(过滤器关联的URL样式)

3）<servlet-name>：指定过滤器所拦截的Servlet名称。

4）<dispatcher>：指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。

用户可以设置多个 <dispatcher> 子元素用来指定 Filter 对资源的多种调用方式进行拦截。

5）<dispatcher>子元素：可以设置的值及其意义

• REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
• INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
• FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
• ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。

六、XMl代码展示

    <!-- 注册过滤器 -->
    <filter>
        <filter-name>EncodeFilter</filter-name>
        <filter-class>com.sikiedu.filter.EncodeFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
    </filter>
    <filter>
        <filter-name>AdminFilter</filter-name>
        <filter-class>com.sikiedu.filter.AdminFilter</filter-class>
    </filter>
    <!-- //注册过滤器 -->
    
    <!-- 启动过滤器 -->
    <filter-mapping>
        <filter-name>EncodeFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    <filter-mapping>
        <filter-name>AdminFilter</filter-name>
        <url-pattern>/admin/*</url-pattern>
    </filter-mapping>
    <!-- //启动过滤器 -->