• [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：

    1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    2. <html>
    3. <head>
    4.     <title>Titletitle>
    5. head>
    6. <body>
    7.     <%
    8.         System.out.println("访问 a.jsp ");
    9.         Object user = session.getAttribute("user");
    10.         if (user == null) {
    11.             request.getRequestDispatcher("/login.jsp").forward(request, response);
    12.             return;
    13.         }
    14.     %>
    15.     我是 a.jsp 页面
    16. body>
    17. html>

    （1-2）AdminFilter：

    1. package com;
    2.  
    3. import javax.servlet.*;
    4. import javax.servlet.http.HttpServletRequest;
    5. import javax.servlet.http.HttpSession;
    6. import java.io.IOException;
    7.  
    8. public class AdminFilter implements Filter {
    9.     /**
    10.      * TODO dofilter 方法，专门用于拦截请求，可以做权限检查
    11.      * @param servletRequest
    12.      * @param servletResponse
    13.      * @param filterChain
    14.      * @throws IOException
    15.      * @throws ServletException
    16.      */
    17.     @Override
    18.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    19.         System.out.println("访问了 filter！");
    20.         HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
    21.         // servletRequest 没有 getSession 方法，所以要强制转换为 httpServletRequest
    22.         HttpSession session = httpServletRequest.getSession();
    23.         Object user = session.getAttribute("user");
    24.         if (user == null) {
    25.             servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest, servletResponse);
    26.             return;
    27.         } else {
    28.             // 让程序继续往下访问目标资源：放行
    29.             /**
    30.              * 但是 filter 还不知道要对哪些信息（比如账号、密码）进行检查，还需要到 web.xml 中去配置
    31.              */
    32.             filterChain.doFilter(servletRequest, servletResponse);
    33.         }
    34.     }
    35.  
    36.     @Override
    37.     public void init(FilterConfig filterConfig) throws ServletException {
    38.         // Filter.super.init(filterConfig);
    39.     }
    40.  
    41.     @Override
    42.     public void destroy() {
    43.         // Filter.super.destroy();
    44.     }
    45. }

    （1-3）login.jsp：

    1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    2. <html>
    3. <head>
    4.     <title>Titletitle>
    5. head>
    6. <body>
    7.   这是登录页面
    8. body>
    9. html>

    （1-4）web.xml：

    1. "1.0" encoding="UTF-8"?>
    2. <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
    3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    4.          xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
    5.          version="4.0">
    6.  
    7.         
    8.         <filter>
    9.             
    10.             <filter-name>AdminFilterfilter-name>
    11.             
    12.             <filter-class>com.AdminFilterfilter-class>
    13.         filter>
    14.         
    15.         <filter-mapping>
    16.             
    17.             <filter-name>AdminFilterfilter-name>
    18.             
    19.             <url-pattern>/admin/*url-pattern>
    20.         filter-mapping>
    21.  
    22. web-app>

    （2）执行

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

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

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

    1、示例

    （1）代码

    （1-1）LoginServlet 类：

    1. package com.web;
    2.  
    3. import javax.servlet.ServletException;
    4. import javax.servlet.http.HttpServlet;
    5. import javax.servlet.http.HttpServletRequest;
    6. import javax.servlet.http.HttpServletResponse;
    7. import java.io.IOException;
    8.  
    9. public class LoginServlet extends HttpServlet {
    10.     @Override
    11.     protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    12.         resp.setContentType("text/html; charset=UTF-8");
    13.         String username = req.getParameter("username");
    14.         String password = req.getParameter("password");
    15.  
    16.         if ("admin".equals(username) && "123456".equals(password)) {
    17.             req.getSession().setAttribute("user", username);
    18.             resp.getWriter().write("登陆成功");
    19.         } else {
    20.             req.getRequestDispatcher("/login.jsp").forward(req, resp);
    21.         }
    22.     }
    23. }

    （1-2）login.jsp：

    1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    2. <html>
    3. <head>
    4.     <title>Titletitle>
    5. head>
    6. <body>
    7.     这是登录页面
    8.     <form action="http://localhost:8080/Filter_war_exploded/start_LoginServlet" method="get">
    9.         username: <input type="text" name="username"/> <br/>
    10.         password: <input type="password" name="password"/> <br/>
    11.         <input type="submit" value="登录"/>
    12.     form>
    13. body>
    14. 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 方法中。

    1. package com;
    2.  
    3. import javax.servlet.*;
    4. import javax.servlet.http.HttpServletRequest;
    5. import javax.servlet.http.HttpSession;
    6. import java.io.IOException;
    7.  
    8. public class AdminFilter implements Filter {
    9.     public AdminFilter() {
    10.         System.out.println("1.Filter 构造方法");
    11.     }
    12.  
    13.  
    14.     /**
    15.      * TODO dofilter 方法，专门用于拦截请求，可以做权限检查
    16.      * @param servletRequest
    17.      * @param servletResponse
    18.      * @param filterChain
    19.      * @throws IOException
    20.      * @throws ServletException
    21.      */
    22.     @Override
    23.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    24.         System.out.println("3.Filter 的 doFilter 方法");
    25.         HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
    26.         // servletRequest 没有 getSession 方法，所以要强制转换为 httpServletRequest
    27.         HttpSession session = httpServletRequest.getSession();
    28.         Object user = session.getAttribute("user");
    29.         if (user == null) {
    30.             servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest, servletResponse);
    31.             return;
    32.         } else {
    33.             // 让程序继续往下访问目标资源：放行
    34.             /**
    35.              * 但是 filter 还不知道要对哪些信息（比如账号、密码）进行检查，还需要到 web.xml 中去配置
    36.              */
    37.             filterChain.doFilter(servletRequest, servletResponse);
    38.         }
    39.     }
    40.  
    41.     @Override
    42.     public void init(FilterConfig filterConfig) throws ServletException {
    43.         //Filter.super.init(filterConfig);
    44.         System.out.println("2.Filter 的 init 方法");
    45.  
    46.         System.out.println("filter-name 的值：" + filterConfig.getFilterName());
    47.         System.out.println("初始化参数 username 的值：" + filterConfig.getInitParameter("username"));
    48.         System.out.println("初始化参数 url 的值：" + filterConfig.getInitParameter("url"));
    49.         System.out.println("servlet-context 对象：" + filterConfig.getServletContext());
    50.     }
    51.  
    52.     @Override
    53.     public void destroy() {
    54.        // Filter.super.destroy();
    55.         System.out.println("3.Filter 的 destroy 方法");
    56.     }
    57. }

    （1-2）web.xml：

    是写在 中的。

    1. "1.0" encoding="UTF-8"?>
    2. <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
    3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    4.          xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
    5.          version="4.0">
    6.  
    7.         
    8.         <filter>
    9.             
    10.             <filter-name>AdminFilterfilter-name>
    11.             
    12.             <filter-class>com.AdminFilterfilter-class>
    13.  
    14.             <init-param>
    15.                 <param-name>usernameparam-name>
    16.                 <param-value>rootparam-value>
    17.             init-param>
    18.             <init-param>
    19.                 <param-name>urlparam-name>
    20.                 <param-value>localhostparam-value>
    21.             init-param>
    22.  
    23.         filter>
    24.         
    25.         <filter-mapping>
    26.             
    27.             <filter-name>AdminFilterfilter-name>
    28.             
    29.             <url-pattern>/admin/*url-pattern>
    30.         filter-mapping>
    31.  
    32.     
    33.         <servlet>
    34.             <servlet-name>LoginServletservlet-name>
    35.             <servlet-class>com.web.LoginServletservlet-class>
    36.         servlet>
    37.         <servlet-mapping>
    38.             <servlet-name>LoginServletservlet-name>
    39.             <url-pattern>/start_LoginServleturl-pattern>
    40.         servlet-mapping>
    41. web-app>

    （2）执行

    六、FilterChain 过滤器链

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

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

    1、示例

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

    （1）代码

    （1-1）Filter1：

    1. package com;
    2.  
    3. import javax.servlet.*;
    4. import java.io.IOException;
    5.  
    6. public class Filter1 implements Filter {
    7.     @Override
    8.     public void init(FilterConfig filterConfig) throws ServletException {
    9.         //Filter.super.init(filterConfig);
    10.     }
    11.  
    12.     @Override
    13.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    14.         System.out.println("Filter1 的前置代码");
    15.  
    16.         filterChain.doFilter(servletRequest, servletResponse);
    17.  
    18.         System.out.println("Filter1 的后置代码");
    19.     }
    20.  
    21.     @Override
    22.     public void destroy() {
    23.         //Filter.super.destroy();
    24.     }
    25. }

    （1-2）Filter2：

    1. package com;
    2.  
    3. import javax.servlet.*;
    4. import java.io.IOException;
    5.  
    6. public class Filter2 implements Filter {
    7.     @Override
    8.     public void init(FilterConfig filterConfig) throws ServletException {
    9.         //Filter.super.init(filterConfig);
    10.     }
    11.  
    12.     @Override
    13.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    14.         System.out.println("Filter2 的前置代码");
    15.  
    16.         filterChain.doFilter(servletRequest, servletResponse);
    17.  
    18.         System.out.println("Filter2 的后置代码");
    19.     }
    20.  
    21.     @Override
    22.     public void destroy() {
    23.         //Filter.super.destroy();
    24.     }
    25. }

    （1-3）target.jsp：

    1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    2. <html>
    3. <head>
    4.     <title>Titletitle>
    5. head>
    6. <body>
    7.     <%
    8.         System.out.println("访问了 target.jsp 页面");
    9.     %>
    10. body>
    11. html>

    （1-4）web.xml：

    1. "1.0" encoding="UTF-8"?>
    2. <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
    3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    4.          xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
    5.          version="4.0">
    6.  
    7.     <filter>
    8.         <filter-name>Filter1filter-name>
    9.         <filter-class>com.Filter1filter-class>
    10.     filter>
    11.     <filter-mapping>
    12.         <filter-name>Filter1filter-name>
    13.         <url-pattern>/target.jspurl-pattern>
    14.     filter-mapping>
    15.  
    16.     <filter>
    17.         <filter-name>Filter2filter-name>
    18.         <filter-class>com.Filter2filter-class>
    19.     filter>
    20.     <filter-mapping>
    21.         <filter-name>Filter2filter-name>
    22.         <url-pattern>/target.jspurl-pattern>
    23.     filter-mapping>
    24. 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 过滤器只关心请求的地址是否匹配，不关心请求的资源是否存在。

  • 相关阅读:
    [附源码]java毕业设计博客系统设计
    什么牌子的蓝牙耳机好？音质好的蓝牙耳机推荐
    蓝桥杯嵌入式LCD屏幕
    Chapter7: SpringBoot与数据访问
    TFRecord的Shuffle、划分和读取
    Linux环境配置
    软件测试/测试开发丨Python闭包与装饰器 学习笔记
    LeetCode 389. Find the Difference
    .NET应用开发之SQLServer常见问题分析
    论文阅读 Exploring Temporal Information for Dynamic Network Embedding
  • 原文地址：https://blog.csdn.net/joyride_run/article/details/133136743