[Java | Web] JavaWeb——Filter 过滤器

目录

一、Filter 过滤器简介

1、简介

2、作用

二、Filter 过滤器的基本使用

1、示例

三、完整的用户登录和权限检查

1、示例

四、Filter 的生命周期

1、Filter 的生命周期包含几个方法:

五、FilterConfig 类

1、简介

2、作用

3、示例

六、FilterChain 过滤器链

1、示例

七、Filter 的拦截路径

1、精确匹配

2、目录匹配

3、后缀名匹配


一、Filter 过滤器简介

1、简介

Filter 过滤器是 JavaWeb 的三大组件之一。三大组件分别是:Servlet 程序、Listener 监听器、Filter 过滤器。

Filter 过滤器是 JavaEE 的规范,也就是接口。

2、作用

Filter 过滤器的作用是:拦截请求、过滤响应

(1)拦截请求常见的应用:

  • 权限检查
  • 日记操作
  • 事务管理
  • ……

二、Filter 过滤器的基本使用

权限检查作为例子说明。

要求在 Web 工程目录下,有一个 admin 目录。这个目录下的所有资源(html、jpg、jsp、……),必须是用户登录之后才允许访问。

1、示例

(1)代码文件:

(1-1)/admin/a.jsp:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <%
        System.out.println("访问 a.jsp ");
        Object user = session.getAttribute("user");
        if (user == null) {
            request.getRequestDispatcher("/login.jsp").forward(request, response);
            return;
        }
    %>
    我是 a.jsp 页面
</body>
</html>

(1-2)AdminFilter:

package com;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import java.io.IOException;

public class AdminFilter implements Filter {
    /**
     * TODO dofilter 方法,专门用于拦截请求,可以做权限检查
     * @param servletRequest
     * @param servletResponse
     * @param filterChain
     * @throws IOException
     * @throws ServletException
     */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("访问了 filter!");
        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
        // servletRequest 没有 getSession 方法,所以要强制转换为 httpServletRequest
        HttpSession session = httpServletRequest.getSession();
        Object user = session.getAttribute("user");
        if (user == null) {
            servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest, servletResponse);
            return;
        } else {
            // 让程序继续往下访问目标资源:放行
            /**
             * 但是 filter 还不知道要对哪些信息(比如账号、密码)进行检查,还需要到 web.xml 中去配置
             */
            filterChain.doFilter(servletRequest, servletResponse);
        }
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // Filter.super.init(filterConfig);
    }

    @Override
    public void destroy() {
        // Filter.super.destroy();
    }
}

(1-3)login.jsp:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
  这是登录页面
</body>
</html>

(1-4)web.xml:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

        <!-- Filter 标签用于配置 filter 过滤器 -->
        <filter>
            <!-- 给 filter 起一个名称 -->
            <filter-name>AdminFilter</filter-name>
            <!-- 配置全类名 -->
            <filter-class>com.AdminFilter</filter-class>
        </filter>
        <!-- 配置一个拦截路径,明确拦截哪些信息 -->
        <filter-mapping>
            <!-- 表示当前的拦截路径给哪个 filter 使用 -->
            <filter-name>AdminFilter</filter-name>
            <!-- 配置拦截路径
                / 表示:http:ip:port/工程路径/,同样映射到 Web 目录
                /admin/* 表示:拦截 /admin/ 目录下的全部资源
            -->
            <url-pattern>/admin/*</url-pattern>
        </filter-mapping>

</web-app>

(2)执行

首先访问 /admin/a.jsp,此时就会被 AdminFilter 拦截,然后检测到没有 user 登录信息,请求转发至 login.jsp。

三、完整的用户登录和权限检查

在上面的基本使用的示例的基础上,添加 login 的 Servlet 程序,模拟登陆成功后的访问。

1、示例

(1)代码

(1-1)LoginServlet 类:

package com.web;

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

public class LoginServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.setContentType("text/html; charset=UTF-8");
        String username = req.getParameter("username");
        String password = req.getParameter("password");

        if ("admin".equals(username) && "123456".equals(password)) {
            req.getSession().setAttribute("user", username);
            resp.getWriter().write("登陆成功");
        } else {
            req.getRequestDispatcher("/login.jsp").forward(req, resp);
        }
    }
}

(1-2)login.jsp:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    这是登录页面
    <form action="http://localhost:8080/Filter_war_exploded/start_LoginServlet" method="get">
        username: <input type="text" name="username"/> <br/>
        password: <input type="password" name="password"/> <br/>
        <input type="submit" value="登录"/>
    </form>
</body>
</html>

(2)执行

当访问 admin 目录下的资源时,Filter 会检测 session 域中是否包含登录后的 user 参数。若未登录,则会跳转到登陆页面;若登录成功,则可以访问 admin 目录下的资源。

四、Filter 的生命周期

1、Filter 的生命周期包含几个方法:

(1)构造器方法;

(2)init 初始化方法;

  • 第(1)(2)步在 Web 工程启动的时候执行(Filter 已经创建)。

(3)doFilter 过滤方法;

  • 第(3)步是每次拦截到请求就会执行。

(4)destroy 销毁方法;

  • 第(4)步,停止 Web 工程时就会执行,销毁 Filter 过滤器。

五、FilterConfig 类

1、简介

FilterConfig 类,是 Filter 过滤器的配置文件类。

Tomcat 每次创建 Filter 时,也会同时创建一个 FilterConfig 类,包含了 Filter 配置文件的的配置信息。

2、作用

FilterConfig 类的作用是,获取 Filter 过滤器的配置内容。

  • 获取 Filter 的名称 filter-name 的内容;
  • 获取在 Filter 中配置的 init-param 初始化参数;
  • 获取 ServletContext 对象;

3、示例

(1)代码

(1-1)AdminFilter 类

相关方法写在了 init 方法中。

package com;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import java.io.IOException;

public class AdminFilter implements Filter {
    public AdminFilter() {
        System.out.println("1.Filter 构造方法");
    }


    /**
     * TODO dofilter 方法,专门用于拦截请求,可以做权限检查
     * @param servletRequest
     * @param servletResponse
     * @param filterChain
     * @throws IOException
     * @throws ServletException
     */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("3.Filter 的 doFilter 方法");
        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
        // servletRequest 没有 getSession 方法,所以要强制转换为 httpServletRequest
        HttpSession session = httpServletRequest.getSession();
        Object user = session.getAttribute("user");
        if (user == null) {
            servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest, servletResponse);
            return;
        } else {
            // 让程序继续往下访问目标资源:放行
            /**
             * 但是 filter 还不知道要对哪些信息(比如账号、密码)进行检查,还需要到 web.xml 中去配置
             */
            filterChain.doFilter(servletRequest, servletResponse);
        }
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        //Filter.super.init(filterConfig);
        System.out.println("2.Filter 的 init 方法");

        System.out.println("filter-name 的值:" + filterConfig.getFilterName());
        System.out.println("初始化参数 username 的值:" + filterConfig.getInitParameter("username"));
        System.out.println("初始化参数 url 的值:" + filterConfig.getInitParameter("url"));
        System.out.println("servlet-context 对象:" + filterConfig.getServletContext());
    }

    @Override
    public void destroy() {
       // Filter.super.destroy();
        System.out.println("3.Filter 的 destroy 方法");
    }
}

(1-2)web.xml:

<init-param> 是写在 <filter> 中的。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

        <!-- Filter 标签用于配置 filter 过滤器 -->
        <filter>
            <!-- 给 filter 起一个名称 -->
            <filter-name>AdminFilter</filter-name>
            <!-- 配置全类名 -->
            <filter-class>com.AdminFilter</filter-class>

            <init-param>
                <param-name>username</param-name>
                <param-value>root</param-value>
            </init-param>
            <init-param>
                <param-name>url</param-name>
                <param-value>localhost</param-value>
            </init-param>

        </filter>
        <!-- 配置一个拦截路径,明确拦截哪些信息 -->
        <filter-mapping>
            <!-- 表示当前的拦截路径给哪个 filter 使用 -->
            <filter-name>AdminFilter</filter-name>
            <!-- 配置拦截路径
                / 表示:http:ip:port/工程路径/,同样映射到 Web 目录
                /admin/* 表示:拦截 /admin/ 目录下的全部资源
            -->
            <url-pattern>/admin/*</url-pattern>
        </filter-mapping>

    
        <servlet>
            <servlet-name>LoginServlet</servlet-name>
            <servlet-class>com.web.LoginServlet</servlet-class>
        </servlet>
        <servlet-mapping>
            <servlet-name>LoginServlet</servlet-name>
            <url-pattern>/start_LoginServlet</url-pattern>
        </servlet-mapping>
</web-app>

(2)执行

六、FilterChain 过滤器链

前面的示例中的 doFilter 方法,在我们登录成功后,调用了 filterChain.doFilter(),目的是为了让程序能够继续访问目标资源。

FilterChain 就是过滤器链(多个过滤器如何一起工作)。

1、示例

多个 Filter 拦截 web 目录下的 target.jsp

(1)代码

(1-1)Filter1:

package com;

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

public class Filter1 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        //Filter.super.init(filterConfig);
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("Filter1 的前置代码");

        filterChain.doFilter(servletRequest, servletResponse);

        System.out.println("Filter1 的后置代码");
    }

    @Override
    public void destroy() {
        //Filter.super.destroy();
    }
}

(1-2)Filter2:

package com;

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

public class Filter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        //Filter.super.init(filterConfig);
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("Filter2 的前置代码");

        filterChain.doFilter(servletRequest, servletResponse);

        System.out.println("Filter2 的后置代码");
    }

    @Override
    public void destroy() {
        //Filter.super.destroy();
    }
}

(1-3)target.jsp:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <%
        System.out.println("访问了 target.jsp 页面");
    %>
</body>
</html>

(1-4)web.xml:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <filter>
        <filter-name>Filter1</filter-name>
        <filter-class>com.Filter1</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>Filter1</filter-name>
        <url-pattern>/target.jsp</url-pattern>
    </filter-mapping>

    <filter>
        <filter-name>Filter2</filter-name>
        <filter-class>com.Filter2</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>Filter2</filter-name>
        <url-pattern>/target.jsp</url-pattern>
    </filter-mapping>
</web-app>

(2)执行结果

(2-1)执行结果1:

访问 /target.jsp,产生如下输出结果:

(2-2)执行结果2:

调换 web.xml 中的配置顺序,把 Filter2 放在 Filter1 之前:

当有多个 Filter 过滤器时,执行顺序是按照在 web.xml 中的配置顺序来决定的。

(2-3)执行结果3:

使用 Fliter1 -> Filter2 的顺序,将 Filter2 中的 filterChain.doFilter() 删除:

如果多个 Filter 拦截对同一资源的访问,只要其中有一个没写 filterChain.doFilter(),那么该资源永远访问不了。

七、Filter 的拦截路径

拦截路径有三种匹配方法:

1、精确匹配

以上配置的路径。表示请求地址必须为:http://ip:port/工程路径/target.jsp

2、目录匹配

以上配置的路径,表示请求地址必须为:http://ip:port/工程路径/admin/* 

3、后缀名匹配

以上配置的路径,表示请求地址必须以 .html 结尾才会拦截到。也可以写成 *.abc、*.nihao。

Filter 过滤器只关心请求的地址是否匹配,不关心请求的资源是否存在。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值