天天看点

Filter(过滤器)的入门案例以及其相关配置的分析Filter:过滤器

Filter(过滤器)的入门案例以及其相关配置的分析

  • Filter:过滤器
      • 1. 概念:
      • 2. 快速入门:
      • 3. 过滤器细节:
        • (1). web.xml配置,同样在浏览器中访问tomcat目录中的index.jsp文件的时候,过滤器一样会执行。
        • (2). 过滤器执行流程
        • (3). 过滤器生命周期方法
        • (4). 过滤器配置详解
        • (5). 过滤器链(配置多个过滤器)

Filter:过滤器

1. 概念:

  • web中的过滤器:当访问服务器的资源时,过滤器可以将请求拦截下来,完成一些特殊的功能。
  • 过滤器的作用:一般用于完成通用的操作。如:登录验证、统一编码处理、敏感字符过滤…

2. 快速入门:

(1). 步骤:

①. 定义一个类,实现接口Filter

②. 复写方法

③. 配置拦截路径【可以在web.xml和类文件中配置拦截路径】

(2). 代码:

首先在src文件中创建FilterDemo1类文件。

Filter(过滤器)的入门案例以及其相关配置的分析Filter:过滤器
Filter(过滤器)的入门案例以及其相关配置的分析Filter:过滤器

在下面的入门案例中我们先用"注解"的方式

package cn.itcast.web.filter;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;
/**
 * 过滤器快速入门
 */
@WebFilter("/*")//访问所有资源之前,都会执行该过滤器
public class FilterDemo1 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
  	}
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filterDemo被执行了...");
    }
    @Override
    public void destroy() {
    }
}
           

然后再在index.jsp中,加入内容,方便当我们访问的时候,可以观察到过滤器的功能。

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>FilterDemo1</title>
  </head>
  <body>
  index.jsp
  </body>
</html>
           

通过以上的配置,当我们访问tomcat目录中的index.jsp文件的时候,浏览器并不会输出相关的内容,因为已经将资源拦截了。但是控制台会输出" filterDemo被执行了… " 。

@Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filterDemo被执行了...");
        //放行
        filterChain.doFilter(servletRequest,servletResponse);
    }
           

不过如果在doFilter方法中加上面的放行语句的话,就可以在浏览器上面看到我们在index.jsp文件写入的相关内容。

3. 过滤器细节:

(1). web.xml配置,同样在浏览器中访问tomcat目录中的index.jsp文件的时候,过滤器一样会执行。

<filter>
        <filter-name>demo1</filter-name>
        <filter-class>cn.itcast.web.filter.FilterDemo1</filter-class>
    </filter>

    <filter-mapping>
        <filter-name>demo1</filter-name>
        <!--拦截路径-->
        <url-pattern>/*</url-pattern>
    </filter-mapping>
           

(2). 过滤器执行流程

①. 执行过滤器。

②. 执行放行后的资源。

③. 回来执行过滤器放行代码下边的代码。

我们可以演示一下上面的执行流程,新建FilterDemo2,在这里我们可以快速的创建Filter文件,File—>New—>Create New Filter

package cn.itcast.web.filter;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;
@WebFilter("/*")
public class FilterDemo2 implements Filter {
    public void destroy() {
    }
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        //对request对象请求消息增强
        System.out.println("filterDemo2执行了...");
        //放行
        chain.doFilter(req, resp);
        //对response对象的响应消息增强
        System.out.println("filterDemo2回来了...");
    }
    public void init(FilterConfig config) throws ServletException {
    }
}
           

为了便于观察,我们在先前的index.jsp文件中加入下面的代码:

<body>
index.jsp
<%
    System.out.println("index.jsp....");
%>
</body>
           

控制台输出结果为:

Filter(过滤器)的入门案例以及其相关配置的分析Filter:过滤器

(3). 过滤器生命周期方法

①. init:在服务器启动后,会创建Filter对象,然后调用init方法。只执行一次。用于加载资源

②. doFilter:每一次请求被拦截资源时,会执行。执行多次

③. destroy:在服务器关闭后,Filter对象被销毁。如果服务器是正常关闭,则会执行destroy方法。只执行一次。用于释放资源

通过运行一下的代码,来看一下过滤器的生命周期

package cn.itcast.web.filter;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

@WebFilter("/*")
public class FilterDemo3 implements Filter {
    /**
     * 在服务器关闭后,Filter对象被销毁,如果服务器是正常关闭,则会执行destroy方法,只执行一次,释放资源
     */
    public void destroy() {
        System.out.println("destroy...");
    }
    
    /**
     * 每一次请求被拦截资源时,会执行,执行多次
     */
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        System.out.println("doFilter...");
        //放行
        chain.doFilter(req, resp);
    }

    /**
     * 在服务器启动后,会创建Filter对象,然后调用init方法,只执行一次
     */
    public void init(FilterConfig config) throws ServletException {
        System.out.println("init....");
    }
}
           

启动tomcat服务器,启动完成后,然后关闭tomcat服务器,控制台输出的顺序为:

init....
doFilter...
index.jsp....
destroy...
           

(4). 过滤器配置详解

拦截路径配置:

①. 具体资源路径: /index.jsp 只有访问index.jsp资源时,过滤器才会被执行

②. 拦截目录: /user/* 访问/user下的所有资源时,过滤器都会被执行

③. 后缀名拦截: * .jsp 访问所有后缀名为jsp资源时,过滤器都会被执行

④. 拦截所有资源:/* 访问所有资源时,过滤器都会被执行

拦截方式配置:资源被访问的方式

Ⅰ、 注解配置:

* 设置dispatcherTypes属性

1. REQUEST:默认值。浏览器直接请求资源

2. FORWARD:转发访问资源

3. INCLUDE:包含访问资源

4. ERROR:错误跳转资源

5. ASYNC:异步访问资源

Ⅱ、web.xml配置

* 设置< dispatcher >< /dispatcher>标签即可,标签里面可以设置上面的属性和值

为了演示拦截方式配置即资源被访问的方式,首先创建filterDemo5文件,

package cn.itcast.web.filter;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

//浏览器直接请求index.jsp资源时,该过滤器会被执行
//@WebFilter(value = "/index.jsp",dispatcherTypes = DispatcherType.REQUEST)

//只有转发访问index.jsp时,该过滤器才会被执行。
//@WebFilter(value = "/index.jsp", dispatcherTypes = DispatcherType.FORWARD)  

//浏览器直接请求index.jsp或者转发访问index.jsp,该过滤器都会被执行
@WebFilter(value = "/index.jsp", dispatcherTypes = {DispatcherType.FORWARD, DispatcherType.REQUEST})//输出updateServlet...filterDemo5....index.jsp....  ->filterDemo5....index.jsp....

public class FilterDemo5 implements Filter {
    public void destroy() {
    }

    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        System.out.println("filterDemo5....");
        //放行
        chain.doFilter(req, resp);
    }

    public void init(FilterConfig config) throws ServletException {
    }

}
           

再创建一个ServletDemo2文件,此文件是为了转发到index.jsp页面。

package cn.itcast.web.servlet;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet("/user/updateServlet")
public class ServletDemo2 extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        System.out.println("updateServlet...");

        //转发到index.jsp
        request.getRequestDispatcher("/index.jsp").forward(request,response);
    }
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        this.doPost(request, response);
    }
}
           

然后通过访问index.jsp和/user/updateServlet两个路径,便可以清楚的发现资源的拦截方式

(5). 过滤器链(配置多个过滤器)

  • 执行顺序:如果有两个过滤器:过滤器1和过滤器2

    ①. 过滤器1

    ②. 过滤器2

    ③. 资源执行

    ④. 过滤器2

    ⑤. 过滤器1

  • 过滤器先后顺序问题:

    ①. 注解配置:按照类名的字符串比较规则比较,值小的先执行

    * 如: AFilter 和 BFilter,AFilter就先执行了。

    ②. web.xml配置: < filter-mapping >谁定义在上边,谁先执行