Fileter过滤器

最新推荐文章于 2023-02-14 20:41:53 发布

原创最新推荐文章于 2023-02-14 20:41:53 发布 · 574 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#filter #web开发

JavaWeb 专栏收录该内容

14 篇文章

订阅专栏

本文详细介绍了Java Web中的Filter过滤器技术，包括Filter的概念、使用场景、工作原理及其实现方法。通过示例代码展示了如何创建Filter类、配置Filter以及利用FilterConfig接口获取初始化参数。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Fileter过滤器

标签（空格分隔）： JavaWeb

Fileter过滤器

Filter介绍

什么是Filter

Filter也称之为过滤器，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。Filter不光能预处理数据，只要是发送过来的请求它都是可以预处理的，同时，它还可以对服务器返回的响应进行预处理，这样，大大减轻了服务器的压力。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

通俗地将，Fileter过滤器像哨卡一样，卡在客户端和服务器之间，对通过的请求和相应进行过滤。并且过滤器也可以是一个链式的，即由多个哨卡，通过一个哨卡，放行，至下一个哨卡继续进行过滤。

使用场景

实现URL级别的权限访问控制，过滤敏感词汇，压缩响应信息等。

Filter过滤原理

Filter过滤器就是一个java类。Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。

Filter接口中有一个doFilter方法，当我们编写好Filter，并在配置文件中配置好映射关系，即对哪个web资源进行拦截后。WEB服务器每次在调用web资源的service方法之前，都会先调用一下实现Filter类的doFilter方法，因此，在该方法内编写代码可达到如下目的：

调用目标资源之前，让一段代码执行。
是否调用目标资源（即是否让用户访问web资源）。
调用目标资源之后，让一段代码执行。

web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。

实现Filter过滤器

Filter开发分为二个步骤：

编写java类实现Filter接口，并实现其doFilter方法。
在 web.xml 文件中使用和元素对编写的filter类进行注册，并设置它所能拦截的资源。

实现Filter接口

filter的三种典型应用：
1. chain.doFilter(request, response)方法表示将资源“放行”，可以在filter中根据条件决定是否调用chain.doFilter(request, response)方法，即是否让目标资源执行
2. 在让目标资源执行之前，可以对request\response作预处理，再让目标资源执行
3. 在目标资源执行之后，可以捕获目标资源的执行结果，从而实现一些特殊的功能

import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;


public class FilterDemo01 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("----过滤器初始化----");
    }

    @Override
    // 注意是ServletRequest和ServletResponse的cashUser，FilterChain对象调用doFilter方法
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {

        //对request和response进行一些预处理
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");
        System.out.println("FilterDemo01执行前！！！");

        //让目标资源执行，放行（通常需要判断才能放行）
        chain.doFilter(request, response);  

        System.out.println("FilterDemo01执行后！！！");
    }

    @Override
    public void destroy() {
        System.out.println("----过滤器销毁----");
    }
}

配置过滤器

在web. xml中配置过滤器：

  <!--注册过滤器-->
  <filter>
      <filter-name>FilterDemo</filter-name>
      <filter-class>过滤器类的全类名</filter-class>
  </filter>

  <!--映射过滤器-->
  <filter-mapping>
      <filter-name>FilterDemo01</filter-name>
      <!--url填写目的地的地址，“/*”表示拦截所有的请求 -->
      <url-pattern>/*</url-pattern>
  </filter-mapping>

注册过滤器：

<description>用于添加描述信息，该元素的内容可为空，可以不配置。
<filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。
<filter-class>元素用于指定过滤器的完整的限定类名。
<init-param>元素用于为过滤器指定初始化参数，它的子元素指定参数的名字，指定参数的值。在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。如果过滤器不需要指定初始化参数，那么元素可以不配置。

映射过滤器：

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

Filter链

在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。

web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中，开发人员如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如果没有，则调用目标资源。

Filter的生命周期

Filter的创建和销毁由web服务器控制。服务器启动的时候，web服务器创建Filter的实例对象，并调用其init方法，完成对象的初始化功能。filter对象只会创建一次，init方法也只会执行一次。拦截到请求时，执行doFilter方法。可以执行多次。服务器关闭时，web服务器销毁Filter的实例对象。

Filter接口中有三个重要的方法。

init()方法：初始化参数，在创建Filter时自动调用。当我们需要设置初始化参数的时候，可以写到该方法中。
doFilter()方法：拦截到要执行的请求时，doFilter就会执行。这里面写我们对请求和响应的预处理。
destroy()方法：在销毁Filter时自动调用。

FilterConfig接口

用户在web.xml中配置filter时，可以使用<init-param>为filter配置一些初始化参数。
当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时，通过filterConfig对象的方法，就可获得：

String getFilterName()：得到filter的名称。
String getInitParameter(String name)：返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.
Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。
ServletContext getServletContext()：返回Servlet上下文对象的引用。

在filter中配置初始化参数name和like

    <filter>
        <filter-name>FilterDemo02</filter-name>
        <filter-class>me.gacl.web.filter.FilterDemo02</filter-class>
        <!--配置FilterDemo02过滤器的初始化参数-->
        <init-param>
            <description>配置FilterDemo02过滤器的初始化参数</description>
            <param-name>name</param-name>
            <param-value>tom</param-value>
        </init-param>
        <init-param>
             <description>配置FilterDemo02过滤器的初始化参数</description>
             <param-name>like</param-name>
             <param-value>java</param-value>
        </init-param>
    </filter>

    <filter-mapping>
        <filter-name>FilterDemo02</filter-name>
        <!--“/*”表示拦截所有的请求 -->
        <url-pattern>/*</url-pattern>
    </filter-mapping>

在init初始化参数中邓庄filterConfig接口，获取初始化参数

public class FilterDemo02 implements Filter {

    /* 过滤器初始化
     * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
     */
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("----过滤器初始化----");

        //得到过滤器的名字
        String filterName = filterConfig.getFilterName();
        //得到在web.xml文件中配置的初始化参数
        String initParam1 = filterConfig.getInitParameter("name");
        String initParam2 = filterConfig.getInitParameter("like");
        //返回过滤器的所有初始化参数的名字的枚举集合。
        Enumeration<String> initParameterNames = filterConfig.getInitParameterNames();

        System.out.println(filterName);     //FilterDemo02
        System.out.println(initParam1);     //tom
        System.out.println(initParam2);     //java
        while (initParameterNames.hasMoreElements()) {
            String paramName = (String) initParameterNames.nextElement();
            System.out.println(paramName);
        }
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("FilterDemo02执行前！！！");
        chain.doFilter(request, response);  //让目标资源执行，放行
        System.out.println("FilterDemo02执行后！！！");
    }

    @Override
    public void destroy() {
        System.out.println("----过滤器销毁----");
    }
}