javaweb之Filter过滤器_it博客站

1、Filter

1.1、什么是Filter？

首先Filter是一个接口。
Filter是java Web三大组件之一。 javaWeb三大组件分别是：Servlet小程序、Filter过滤器、Listener监听器
Filter是服务器专门用来过滤请求，拦截响应的。

Filter的常见作用：

检查用户访问权限。
设置请求响应编码，解决乱码问题。

1.2、Filter的初体验

需求：现在在WebContent目录下有一个目录admin。这个目录是管理员操作的目录。这个目录里有jsp文件，有html文件，还有图片资源文件。现在我们要让这些资源都在用户登录才能被访问。那么我们要怎么实现这样的需求。

思路：前面我们讲过Session。有同学可能会想，我们可以在用户登录之后。把用户的信息保存在Session域对象中。然后在jsp页面里通过Session域对象获取用户的信息，如果用户信息存在，说明用户已登录。否则就重定向到登录页面。这个方案可行。可是html页面呢? html页面是没有Session域对象的。

解决方案：这就需要我们使用Filter过滤器来进行请求的拦截。然后判断Session域对象中是否包含用户的信息。

现在我们以admin目录下user.jsp为例进行讲解。

首先，我们需要创建一个类来实现Filter接口，用来检查Session中是否包含用户信息。
实现Filter中的doFilter方法
然后到web.xml文件中去配置Filter的过滤信息。
然后重启服务器访问测试

1）Filter1的类代码：

package com.atguigu.filter;

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;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class Filter1 implements Filter {

    /**
     * Filter初始化方法
     */
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    /**
     * Filter的过滤方法
     */
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // 强转
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        HttpServletResponse httpResponse = (HttpServletResponse) response;
        // 获取用户登录信息
        String username = (String) httpRequest.getSession().getAttribute("username");
        if (username != null) {
            // 过滤器中，只要允许用户访问资源，一定要调用chain.doFilter方法，否则用户永远访问不到资源
            chain.doFilter(request, response);
        } else {
            // 如果用户未登录。返回登录页面
            httpResponse.sendRedirect(httpRequest.getContextPath() + "/login.jsp");
        }
    }

    /**
     * Filter销毁的方法
     */
    public void destroy() {
    }

}

2）web.xml文件中的Filter配置

    <!-- 配置Filter1 -->
    <filter>
        <!-- 给Filter1起一个名字 -->
        <filter-name>Filter1</filter-name>
        <!-- 是哪一个Filter类 -->
        <filter-class>com.atguigu.filter.Filter1</filter-class>
    </filter>
    <filter-mapping>
        <!-- Filter的名字 -->
        <filter-name>Filter1</filter-name>
        <!-- Filter1的过滤地址
            表示过滤http://127.0.0.1:8080/day17/admin/user.jsp
         -->
        <url-pattern>/admin/user.jsp</url-pattern>
    </filter-mapping>

1.3、Filter的生命周期

Servlet的生命周期

先执行构造方法
执行init方法做初始化操作
执行Service方法
销毁的时候调用destory方法

Filter生命周期：

先执行Filter的构造方法
然后执行Filter的init方法
执行Filter的doFilter方法，每次访问资源，只要匹配过滤的地址，就会调用。
执行Filter的destroy方法

创建一个Filter2类。代码如下：

package com.atguigu.filter;

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 Filter2 implements Filter {

    public Filter2() {
        System.out.println("Filter2 构造 方法 被调用");
    }
    
    /**
     * Filter初始化方法
     */
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("Filter2 init 方法被调用。初始化……");
    }

    /**
     * Filter的过滤方法
     */
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        System.out.println("Filter2 doFilter 方法被调用  ");
        // 一定要调用此方法，否则用户访问的资源会访问不到。
        chain.doFilter(request, response);
    }

    /**
     * Filter销毁的方法
     */
    public void destroy() {
        System.out.println("Filter2 的destroy方法被调用……");
    }

}

web.xml文件中的配置

    <!-- 配置Filter2 -->
    <filter>
        <!-- 给Filter2起一个名字 -->
        <filter-name>Filter2</filter-name>
        <!-- 是哪一个Filter类 -->
        <filter-class>com.atguigu.filter.Filter2</filter-class>
    </filter>
    <filter-mapping>
        <!-- Filter的名字 -->
        <filter-name>Filter2</filter-name>
        <!-- Filter1的过滤地址
            表示过滤http://127.0.0.1:8080/day17/login.jsp
         -->
        <url-pattern>/login.jsp</url-pattern>
    </filter-mapping>

然后打开浏览器访问 http://127.0.0.1:8080/day17/login.jsp。查看整个控制台的打印如下：

Filter在工程启动的时候初始化。
在访问过滤的时候调用doFilter方法
Tomcat关闭Filter被销毁的时候调用destory方法

图片的描述

1.4、FilterConfig类

作用：FilterConfig类和ServletConfig类是一样的。可以获取Filter在web.xml文件中的配置信息，做初始化之用。

我们可以在web.xml文件中给Filter添加初始化参数。然后在init初始化方法中使用FilterConfig类获取到初始化的参数。

FilterConfig类，一般有三个作用：

获取Filter在web.xml文件中配置的名称
获取Filter在web.xml文件中配置的初始化参数
通过FilterConfig类获取ServletContext对象实例

1.4.1、修改Filter2在web.xml中的配置信息

    <!-- 配置Filter2 -->
    <filter>
        <!-- 给Filter2起一个名字 -->
        <filter-name>Filter2</filter-name>
        <!-- 是哪一个Filter类 -->
        <filter-class>com.atguigu.filter.Filter2</filter-class>
        <!-- 配置初始化参数 -->
        <init-param>
            <!-- 初始化参数的名称 -->
            <param-name>username</param-name>
            <!-- 初始化参数的值 -->
            <param-value>root</param-value>
        </init-param>
    </filter>

1.4.2、修改Filter2中init方法的代码如下：

    /**
     * Filter初始化方法
     */
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("Filter2 init 方法被调用。初始化……");
        // 获取Filter的名称
        String filterName = filterConfig.getFilterName();
        System.out.println("Filter name ==>>> " + filterName);
        // 获取初始化参数。username的值
        String username = filterConfig.getInitParameter("username");
        System.out.println("username ==>> " + username);
        // 获取ServletContext的对象实例 
        ServletContext ctx = filterConfig.getServletContext();
        System.out.println(ctx);
    }

1.4.3、然后重启Tomcat服务器，控制台打印如下：

图片的描述

1.5、FilterChain 过滤器链(重点*)

FilterChain是整个Filter过滤器的调用者。Filter与Filter之间的传递，或者Filter与请求资源之间的传递都靠FilterChain.doFilter方法。一般Filter.doFilter中的代码分为三段。

第一段是FilterChain.doFilter之前的代码。一般用来做请求的拦截，检查用户访问的权限，访问日记的记录。参数编码的设置等等操作。

第二段是FilterChain.doFilter方法。此方法可以将代码的执行传递到下一个Filter中。或者是传递到用户最终访问的资源中。

第三段是FilterChain.doFilter之后的代码。主要用过做一些日记操作。我们很少会在第三段中做太多复杂的操作。

在每一个Filter类的doFilter方法中，一定要调用chain.doFilter方法，除非你想要阻止用户继续往下面访问。否则一定要调用FilterChain的doFilter方法。

1.5.1、图解：多个Filter过滤器的代码流转

图片的描述

1.5.2、现在我们添加两个Filter类。对同一个资源进行过滤。

第一个Filter类ChainFilter1 代码：

package com.atguigu.filter;

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 ChainFilter1 implements Filter {

    public void init(FilterConfig filterConfig) throws ServletException {
    }

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        System.out.println("资源访问前---ChainFilter1 -- 开始执行");
        // 转发下一个Filter或者请求的资源
        chain.doFilter(request, response);
        System.out.println("资源访问后---ChainFilter1 -- 执行结束");
    }

    public void destroy() {
    }

}

第二个Filter类ChainFilter2 代码：

package com.atguigu.filter;

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 ChainFilter2 implements Filter {

    public void init(FilterConfig filterConfig) throws ServletException {
    }

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        System.out.println("资源访问前---ChainFilter2 -- 开始执行");
        // 转发下一个Filter或者请求的资源
        chain.doFilter(request, response);
        System.out.println("资源访问后---ChainFilter2 -- 执行结束");
    }

    public void destroy() {
    }

}

1.5.3、他们在web.xml文件中的配置如下：

    <filter>
        <filter-name>ChainFilter1</filter-name>
        <filter-class>com.atguigu.filter.ChainFilter1</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>ChainFilter1</filter-name>
        <url-pattern>/chainFilter.jsp</url-pattern>
    </filter-mapping>
    <filter>
        <filter-name>ChainFilter2</filter-name>
        <filter-class>com.atguigu.filter.ChainFilter2</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>ChainFilter2</filter-name>
        <url-pattern>/chainFilter.jsp</url-pattern>
    </filter-mapping>

1.5.4、WebContent/chainFilter.jsp文件的内容如下：

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
    <head>
        <meta http-equiv="pragma" content="no-cache" />
        <meta http-equiv="cache-control" content="no-cache" />
        <meta http-equiv="Expires" content="0" />
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <title>Insert title here</title>
    </head>
    <body>
        <%
            System.out.println("这是请求资源的代码");
        %>
        这是ChainFilter.jsp
    </body>
</html>

1.5.5、打开浏览器输入回车访问：

http://127.0.0.1:8080/day17/chainFilter.jsp

图片的描述

千万要注意：在Filter类的doFilter方法中，除非你要拦截请求的资源，否则一定要调用FilterChain参数的doFilter方法让代码的执行传递到下一个Filter或访问的资源中

1.6、Filter的拦截路径

精确匹配比如： /xxx/xxx/xxx.jsp 或 /xxx/xxx/xxx.html 等

目录匹配比如： /abc/* 表示可以拦截abc目录下的所有资源，甚至是abc目录下的其他目录， /* 表示访问当前工程下所有资源后缀名匹配比如：*.jsp 表示拦截所有后缀为jsp文件资源

精确匹配前面，我们已经演示过了。下面我们以目录匹配为示例展示代码。大家可以在此基础上。修改web.xml文件中的<url-pattern>标签来测试自己想要的路径

1）Filter的代码如下：

package com.atguigu.filter;

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 FilterPath implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        System.out.println("filter path 执行了");
        // 将代码执行传递到下一个Filter或者是请求资源
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {

    }

}

2）web.xml文件中的配置内容：

<filter>
    <filter-name>FilterPath</filter-name>
    <filter-class>com.atguigu.filter.FilterPath</filter-class>
</filter>
<filter-mapping>
    <filter-name>FilterPath</filter-name>
    <url-pattern>/admin/*</url-pattern>
</filter-mapping>

HuaShen

javaweb之Filter过滤器

1、Filter

1.1、什么是Filter？

Filter的常见作用：

1.2、Filter的初体验

1）Filter1的类代码：

2）web.xml文件中的Filter配置

1.3、Filter的生命周期

Servlet的生命周期

Filter生命周期：

创建一个Filter2类。代码如下：

web.xml文件中的配置

1.4、FilterConfig类

FilterConfig类，一般有三个作用：

1.4.1、修改Filter2在web.xml中的配置信息

1.4.2、修改Filter2中init方法的代码如下：

1.4.3、然后重启Tomcat服务器，控制台打印如下：

1.5、FilterChain 过滤器链(重点*)

1.5.1、图解：多个Filter过滤器的代码流转

1.5.2、现在我们添加两个Filter类。对同一个资源进行过滤。

第一个Filter类ChainFilter1 代码：

第二个Filter类ChainFilter2 代码：

1.5.3、他们在web.xml文件中的配置如下：

1.5.4、WebContent/chainFilter.jsp文件的内容如下：

1.5.5、打开浏览器输入回车访问：

1.6、Filter的拦截路径

1）Filter的代码如下：

2）web.xml文件中的配置内容：

推荐阅读

QQXML 卡片菜单代码分享

【iapp】手电筒源码

Effective-Java 第三版中文版明智审慎地进行优化

测试文章

最新评论

当前未登陆哦

关于此站

学习网站

优秀排版个人博客网址

HuaShen

javaweb之Filter过滤器

1、Filter

1.1、什么是Filter？

Filter的常见作用：

1.2、Filter的初体验

1）Filter1的类代码：

2）web.xml文件中的Filter配置

1.3、Filter的生命周期

Servlet的生命周期

Filter生命周期：

创建一个Filter2类。代码如下：

web.xml文件中的配置

1.4、FilterConfig类

FilterConfig类，一般有三个作用：

1.4.1、修改Filter2在web.xml中的配置信息

1.4.2、修改Filter2中init方法的代码如下：

1.4.3、然后重启Tomcat服务器，控制台打印如下：

1.5、FilterChain 过滤器链(重点*)

1.5.1、图解：多个Filter过滤器的代码流转

1.5.2、现在我们添加两个Filter类。对同一个资源进行过滤。

第一个Filter类ChainFilter1 代码：

第二个Filter类ChainFilter2 代码：

1.5.3、他们在web.xml文件中的配置如下：

1.5.4、WebContent/chainFilter.jsp文件的内容如下：

1.5.5、打开浏览器输入回车访问：

1.6、Filter的拦截路径

1）Filter的代码如下：

2）web.xml文件中的配置内容：

推荐阅读

QQXML 卡片菜单代码分享

【iapp】手电筒源码

Effective-Java 第三版中文版 明智审慎地进行优化

测试文章

最新评论

当前未登陆哦

关于此站

学习网站

优秀排版个人博客网址

Effective-Java 第三版中文版明智审慎地进行优化