Servlet之Filter过滤器

Servlet之Filter过滤器

简介：过滤器是在Servlet规范2.3中定义的，它可以动态的拦截请求和响应但过滤器本身不生成请求和响应，也就是说只是可以对请求和响应的对象进行检查和修改。

 

一、过滤器的概念

过滤器是一个程序，它先于与之相关的servlet或JSP页面运行在服务器上。过滤器可附加到一个或多个servlet或JSP页面上，并且可以检查进入这些资源的请求信息。在这之后，过滤器可以作如下的选择：

①以常规的方式调用资源（即，调用servlet或JSP页面）。

②利用修改过的请求信息调用资源。

③调用资源，但在发送响应到客户机前对其进行修改。

④阻止该资源调用，代之以转到其他的资源，返回一个特定的状态代码或生成替换输出。

 

二、过滤器的使用

在客户端的请求访问后端资源之前，拦截这些请求。

在服务器的响应发送回客户端之前处理这些响应。

常用的方式：

1.拦截资源（一些不合理的访问）

2.设置字符集（设置请求和响应的字符集）

3.权限控制（常用）

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

· 身份验证过滤器（Authentication Filters）。

· 数据压缩过滤器（Data compression Filters）。

· 加密过滤器（Encryption Filters）。

· 触发资源访问事件过滤器。

· 图像转换过滤器（Image Conversion Filters）。

· 日志记录和审核过滤器（Logging and Auditing Filters）。

· MIME-TYPE 链过滤器（MIME-TYPE Chain Filters）。

· 标记化过滤器（Tokenizing Filters）。

· XSL/T 过滤器（XSL/T Filters），转换 XML 内容。

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

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

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

 

1.过滤器的实现

Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截。简单说，就是可以实现web容器对某资源的访问前截获进行相关的处理，还可以在某资源向web容器返回响应前进行截获进行处理。

Filter接口：javax.Servlet.Filtervax.servlet.Filter接口定义了三个方法：

2.Servlet 过滤器方法

Initf方法（初始化方法）

web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）。开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。

public void init(FilterConfig filterConfig){}

doFilter方法（过滤的关键）

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

public void doFilter (ServletRequest, ServletResponse, FilterChain){}

destroy方法垃圾回收

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

public void destroy(){}

3.设置配置文件web.xml

 

· <filter>指定一个过滤器。

· <filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。

· <filter-class>元素用于指定过滤器的完整的限定类名。

· <init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。

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

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

· <filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字

· <url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)

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

· <dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。用户可以设置多个<dispatcher>子元素用来指定 Filter 对资源的多种调用方式进行拦截。

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

· REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。

· INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。

· FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。

· ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。

 

  示例：

  <!-- 设置过滤器 -->

  <filter>

<!-- 设置过滤器名称-->

   <filter-name>MyFirstFilter</filter-name>

<!-- 设置过滤器全类名-->

   <filter-class>filter.MyFirstFilter</filter-class>

  </filter>

  

  <!-- 添加过滤的位置 -->

  <filter-mapping>

<!-- 该路径对应的过滤器名-->

   <filter-name>MyFirstFilter</filter-name>

<!-- 需要过滤的路径  *带表该路径下所有 -->

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

 </filter-mapping>

上述过滤器适用于所有的 Servlet，因为我们在配置中指定 /* 。如果您只想在少数的 Servlet 上应用过滤器，您可以指定一个特定的 Servlet 路径。

4.过滤器链

我们可以根据不同的需求定义多个过滤器，也叫做过滤器链

过滤器链的顺序：web.xml 中的 filter-mapping 元素的顺序决定了 Web 容器应用过滤器到 Servlet 的顺序。若要反转过滤器的顺序，您只需要在 web.xml 文件中反转 filter-mapping 元素即可。

注意：只要有一层过滤器不通过，就会被直接拦截

 

<filter>

   <filter-name>LogFilter</filter-name>

   <filter-class>com.runoob.test.LogFilter</filter-class>

   <init-param>

      <param-name>test-param</param-name>

      <param-value>Initialization Paramter</param-value>

   </init-param></filter>

<filter>

   <filter-name>AuthenFilter</filter-name>

   <filter-class>com.runoob.test.AuthenFilter</filter-class>

   <init-param>

      <param-name>test-param</param-name>

      <param-value>Initialization Paramter</param-value>

   </init-param></filter>

<filter-mapping>

   <filter-name>LogFilter</filter-name>

   <url-pattern>/*</url-pattern></filter-mapping>

<filter-mapping>

   <filter-name>AuthenFilter</filter-name>

   <url-pattern>/*</url-pattern></filter-mapping>

 

5.FilterConfig 使用

Filter 的 init 方法中提供了一个 FilterConfig 对象。

如 web.xml 文件配置如下：

<filter>

    <filter-name>LoginFilter</filter-name>

    <filter-class>com.runoob.test.LogFilter</filter-class>

    <init-param>

        <param-name>test/param-name>

        <param-value>测试</param-value>

    </init-param>

    </filter>

在 init 方法使用 FilterConfig 对象获取参数：

public void  init(FilterConfig config) throws ServletException {

    // 获取初始化参数

    String site= config.getInitParameter("test"); 

    // 输出初始化参数

    System.out.println("test: " + test); }