Servlet过滤器----Filter

最新推荐文章于 2023-05-09 19:23:39 发布

Megustas_JJC

最新推荐文章于 2023-05-09 19:23:39 发布

阅读量663

点赞数 1

分类专栏： Servlet 文章标签： filter

本文链接：https://blog.csdn.net/megustas_jjc/article/details/53893489

版权

Servlet 专栏收录该内容

12 篇文章 0 订阅

订阅专栏

JavaEE的Servlet规范描述了三种技术：Servlet，Filter，Listener

（一）过滤器简介

Filter也称之为过滤器，它是Servlet技术中最实用的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

作用总结：对服务器web资源进行拦截（权限控制，通过拦截资源进行权限控制，是否可以访问）

Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截，如下所示：

这里写图片描述

过滤器拦截对目标资源的访问（HTTP请求）和服务器的HTTP响应
过滤器拦截的本质是对URL访问的拦截（因为资源通过URL进行标识）

（二）过滤器原理

Filter接口中定义了三个方法：init（初始化），doFilter（执行过滤），destory（销毁）

doFilter方法：
Filter接口中有一个doFilter方法，当开发人员编写好Filter，并配置对哪个web资源(拦截url)进行拦截后，WEB服务器每次在调用web资源之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：

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

即Filter的doFilter方法中，传入FilterChain参数，FilterChain请求调用链，提供doFilter用于执行调用链下一个资源

（三）第一个Filter实例

Filter的编写其实与Servlet的编写流程十分相像（Servlet的编写见http://blog.csdn.net/megustas_jjc/article/details/53164394），Filter的编写步骤如下：

假设现有一个JSP页面：

<body>
<h1>Hello JSP</h1>
</body>

（1）编写类实现（继承）Filter接口（实现Filter接口 init doFilter destroy ）

public class Filter1 implements Filter {
    public Filter1() {
        System.out.println("创建了Filter1实例");
    }

    @Override
    public void destroy() {
        System.out.println("filter destroy...");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        // 默认：对目标资源进行了拦截，目标资源没有被访问
        System.out.println("filter doFilter...");
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("filter init...");
    }

}

（2）在web.xml中注册过滤器（为过滤器定义一个name，同servlet一样，那么可以随意选取），配置Filter拦截哪个web资源

  <!-- 配置Filter 拦截目标资源 hello.jsp -->    

  <!-- 对过滤器注册，为过滤器定义 name -->
  <filter>
    <filter-name>Filter1</filter-name>
    <filter-class>cn.megustas.filter.Filter1</filter-class>
  </filter> 


    <!-- 配置过滤器拦截哪个web 资源 -->
  <filter-mapping>
    <filter-name>Filter1</filter-name>
    <!-- 拦截路径 -->
    <url-pattern>/hello.jsp</url-pattern>
  </filter-mapping>

在启动服务器时，Filter对象被创建，执行过滤器init 方法
配置拦截后，访问hello.jsp — 过滤器中doFilter方法获得执行（每请求一次，doFilter 过滤一次）

没有配置过滤器之前，直接访问hello.jsp，当配置过滤器后，过滤器先于hello.jsp执行 - - - - - 此时过滤器Filter1和hello.jsp组成请求调用链FilterChain（就是这条链上有多少个请求访问资源）

如果想要访问请求调用链上的下一个资源：

// 如果访问请求调用链下一个资源
chain.doFilter(request, response);

即拦截目标资源后，如果想目标资源执行: chain.doFilter ；如果不执行chain.doFilter 目标资源不会得到执行

destroy方法和Servlet的destroy 一样，在正常关闭服务器情况下执行

（四）Filter链

在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。对同一web资源配置多个过滤器，例如，我们再定义一个过滤器Filter2，那么web.xml的配置如下：

  <filter>
    <filter-name>Filter1</filter-name>
    <filter-class>cn.megustas.filter.Filter1</filter-class>
  </filter> 
  <filter-mapping>
    <filter-name>Filter1</filter-name>
    <url-pattern>/hello.jsp</url-pattern>
  </filter-mapping>
  <filter>
    <filter-name>Filter2</filter-name>
    <filter-class>cn.megustas.filter.Filter2</filter-class>
  </filter>
   <filter-mapping>
    <filter-name>Filter2</filter-name>
    <url-pattern>/hello.jsp</url-pattern>
  </filter-mapping>

当配置多个Filter 拦截hello.jsp 组成新的请求调用链 Filter1 — Filter2 — hello.jsp过滤器链会根据mapping 的顺序组成顺序调用过滤器执行

（五）Filter生命周期

1.init(FilterConfig filterConfig)throws ServletException：

和我们编写的Servlet程序一样，Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法进行初始化（注：filter对象只会创建一次，init方法也只会执行一次。）
开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。

FilterConfig
用户在配置filter时，可以使用<init-param>为filter**配置一些初始化参数，当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的FilterConfig对象传递进来**。因此开发人员在编写filter时，通过FilterConfig对象的方法，就可获得（FileConfig 作用和ServletConfig 类似—- 为过滤器提供初始化参数）：

String getFilterName():得到Filter的名称
String getInitParameter(String name):返回指定名称的初始化参数的值，如果不存在，则返回null。
Enumeration getInitParameterNames():返回过滤器所有初始化参数的名字的枚举集合。
public ServletContext getServletContext():返回Servlet上下文对象的引用（获得ServletContext对象保存全局数据、读取web资源文件）。

例如，如下进行初始化参数配置：

<filter>
         <filter-name>Fitler2</filter-name>
         <filter-class>cn.megustas.filter.Filter2</filter-class>
         <init-param>
             <param-name>company</param-name>   
             <param-value>megustas</param-value>
         </init-param>
</filter>

例如在WEB-INF中创建文件：

这里写图片描述

通过FilterConfig获得信息：

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 功能一 获得配置初始化参数
        String company = filterConfig.getInitParameter("company");
        System.out.println(company);//megustas
        // 功能二 读取web资源文件
        ServletContext servletContext = filterConfig.getServletContext();
        // 读取web资源文件 必须获得绝对磁盘路径
        String filePath = servletContext.getRealPath("/WEB-INF/info.txt");
        try {
            BufferedReader reader = new BufferedReader(new FileReader(filePath));
            System.out.println(reader.readLine());
            reader.close();
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

2.doFilter(ServletRequest,ServletResponse,FilterChain)：

每次filter进行拦截都会执行
在实际开发中方法中参数request和response通常转换为HttpServletRequest和HttpServletResponse类型进行操作

3.destroy()：

在Web容器卸载 Filter 对象之前被调用（服务器被正常关闭）。

（六）Filter映射

（1）一个web资源配置多个过滤器：上面例子

（2）一个过滤器配置多个web资源

<filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的servlet可通过两种方式来指定：Servlet 名称和资源访问的请求路径：
注意：如下，过滤servlet可以通过路径/hello或者通过servlet的名字进行过滤，<url-pattern>是通用的过滤方法，<servlet-name>是针对于过滤servlet可以使用的

    <!-- 配置过滤器拦截哪个web 资源 -->
  <filter-mapping>
    <filter-name>Filter1</filter-name>
    <!-- 拦截路径 -->
    <url-pattern>/hello.jsp</url-pattern>
    <url-pattern>/index.jsp</url-pattern>
    <!-- 过滤HelloServlet 通过Servlet名字对Servlet进行过滤 -->
<!--    <url-pattern>/hello</url-pattern>-->
    <servlet-name>HelloServlet</servlet-name>
  </filter-mapping>

（3）关于url-pattern 写法和Servlet相同有三种完全匹配、目录匹配、扩展名匹配

（4）<dispatcher>标签及意义（可以配置在什么情况下，或者说是在什么调用方式下拦截目标资源）

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

服务器调用资源的四种方式

这里写图片描述

例如，此时还有一个forword.jsp页面：

<%
    // 转发给 hello.jsp
    request.getRequestDispatcher("/hello.jsp").forward(request,response);
%>

在配置时：

  <filter-mapping>
    <filter-name>Filter1</filter-name>
    <!-- 拦截路径 -->
    <url-pattern>/hello.jsp</url-pattern>
    <dispatcher>FORWARD</dispatcher>
    <dispatcher>REQUEST</dispatcher>
  </filter-mapping>

此时直接访问hello.jsp，由于REQUEST的设置，会执行过滤，同理，直接访问forward.jsp也会执行过滤（执行doFilter），因为FORWARD在forward转发时执行过滤（可以同时添加多个<dispatcher>对过滤方式进行设置）。

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

如果想让过滤器执行，必须满足过滤方式！！！！如果forward、include 、error跳转时执行过滤必须配置 dispatcher。