JavaWeb--过滤器

一、初识过滤器

1.过滤器简介

Filter(过滤器)是对Web资源进行拦截的对象
一般来说在过滤器中做一些逻辑处理以后再交给下一个过滤器或Servlet来处理，它一般是用来拦截请求进行处理，也可以对返回的响应进行拦截处理

2.执行原理

在正式学习过滤器之前，先来看看在没有学习过滤器的时候，简单的通信流程是怎么样的

那么我们为什么要学习这个技术呢，在没有学这个技术之前，我们在执行Servlet的时候，可能不同的Servlet之间有共同的方法，但是要分别写，这样无法达到代码的复用，我们使用过滤器就可以解决这样的问题
过滤器可以解决代码复用问题，我们一般在过滤器中写公共的代码，Filter可以在Servlet目标程序执行之前添加代码，也可以在执行之后添加代码，也就是添加过滤的原则

3.过滤器相关API和方法

主要的API是

• Filter

想要创建过滤器，一定要实现Filter接口

• FilterChain

FilterChain接口负责调用链中的下一个过滤器或者资源，这一个对象在Filter接口的doFilter方法中传递，这个接口只有一个方法
public void doFilter（HttpServletRequest request，HttpServletResponse response）：它将控件传递给下一个过滤器或资源。

• FilterConfig

4.Filter的编写

这里以Tomcat10版本为例

1. 写一个类实现jakarta.servlet.Filter接口，并且实现里面的方法
   init–在Filter对象第一次被创建之后调用，而且只调用一次
   doFilter–用户发送一次请求，就会执行一次方法，类似于Servlet的servlce方法，在这个方法中编写过滤原则
   destroy—在Filter对象被释放或销毁之前释放并且只执行一次
2. 在web.xml中对Filter进行配置，这个配置和Servlet很相似
3. 注意:
   Servlet对象默认在服务器启动的时候，是不会新建对象的
   Filter对象默认在服务器启动的时候，会新建对象
   Servlet和Filter都是单例的，都只创建一个对象
4. 如果Servlet和Filter对应的路径是一样的，那么就会执行Filter,不会执行Servlet,如果想要让程序继续执行，就应该加上这样的代码

这个代码是我学习的时候用来测试的
 
@Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("Filter1的doFilter方法执行");
        //执行下一个过滤器，如果下一个不是过滤器，则执行目标程序
        //程序往下走，一定要有这个代码
        chain.doFilter(request, response);
        //在响应的时候添加过滤规则
        System.out.println("doFilter方法执行结束");

    }

在浏览器输入http://localhost:8080/filter/a.do

@WebFilter("/a.do")
public class AServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        System.out.println("AServlet的doGet方法执行");
    }
}

程序执行结果

Filter1的doFilter方法执行
AServlet的doGet方法执行
doFilter方法执行结束

5. 写请求路径的注意点:
   @WebFilter(“*.do”) 模糊匹配中的扩展匹配 这种路径不要以/开始,匹配所有以.do结尾的路径
   @WebFilter(“/*”)匹配所有路径 “/*”
   @WebFilter(“/a/*”)前缀匹配，匹配所有以a开头的路径
6. 我们的目标Servlet程序如果想要执行，需要满足两个条件:
   1. 过滤器是否编写 chain.doFilter(request, response);
   2. 用户发送的请求路径是否和Servlet对应的路径一样
7. chain.doFilter(request, response);的作用:
   执行下一个过滤器，如果没有，则执行最终的Servlet程序
8. Filter优先级比Servlet高
9. 在配置文件中，Filter的优先顺序问题
   如果在配置文件写了配置信息，根据<filter -mapping> 标签的位置，来判断优先顺序，从上往下优先级递减。
   如果是通过注解来配置，那么过滤器的优先顺序是根据过滤器的名字来定。FilterA比FilterB先执行，Filter1比Filter2先执行
10. 过滤器调用顺序遵循栈数据结构

5.Filter的生命周期

Filter的生命周期和Servlet一致
有一点不同的是Filter在服务器启动的时候默认会创建对象，而Servlet不会

6.责任链设计模式

Filter这里涉及责任链设计模式，就类似下面的代码
不过下面的代码有一个问题，在编译阶段就已经把调用顺序确定了，如果我们想要改变调用顺序的话，就得改变源代码，违背OCP开闭原则

过滤器的优点就是在程序编译阶段，不会确定调用顺序，因为Filter调用顺序是配置到web.xml中，我们只需要修改配置文件 <filter - mapping >信息就可以改变Filter的执行顺序，Filter的执行顺序是在运行阶段动态组合的，这种设计模式叫做责任链设计模式。

责任链设计模式思想：程序运行阶段动态组合程序执行顺序。
过滤器一般配置在web.xml，而不是通过注解配置

二、编写身份过滤器

思路:在过滤器进行身份验证，如果用户名和密码正确，则转发到目标程序

使用过滤器进行过滤

package com.bjpowernode.filter;

import jakarta.servlet.*;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jdk.nashorn.internal.ir.IfNode;

import java.io.IOException;
import java.io.PrintWriter;

/**
 * @author zengyihong
 * @create 2022--04--07 16:12
 */
public class LoginFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain  chain) throws IOException, ServletException {

        HttpServletRequest request=(HttpServletRequest) servletRequest;

        String username = request.getParameter("username");
        String password = request.getParameter("password");
        HttpServletResponse response=(HttpServletResponse) servletResponse;
        PrintWriter writer = response.getWriter();
        response.setContentType("text/html");
        /**
         * 用户名和密码正确就去执行相应的目标程序
         * 否则就让它继续登录
         */
        if("admin".equals(username) && "123".equals(password)){
            chain.doFilter(request,response);

        }else {
            /**
             * 账户密码不匹配
             * 就显示登录错误，并且让它重新登录
             */
            writer.println("登录信息错误，请重新输入"+"<br>");
            RequestDispatcher requestDispatcher = request.getRequestDispatcher("/index.jsp");
//            response.sendRedirect(request.getContextPath()+"/index.jsp");
            requestDispatcher.include(request,response);
        }


    }
}

目标程序

测试



这里涉及到了Servlet的转发，重定向，包含等知识，大家可以看我博客的文章https://blog.csdn.net/qq_52797170/article/details/123464381

三、过滤器的相关案例

1.使用过滤器统计访问次数

这里有一个要注意的地方
cnt要设置成静态变量，不然的话每次访问都显示只有1次

2.计算页面响应时间

  public void doFilter(ServletRequest req, ServletResponse resp,
                         FilterChain chain) throws IOException, ServletException {
        resp.setContentType("text/html;charset=utf-8");

        PrintWriter out=resp.getWriter();
        long before=System.currentTimeMillis();

        chain.doFilter(req,resp);

        long after=System.currentTimeMillis();
        out.print("<br/>总响应时长： "+(after-before)+" 毫秒");
        out.close();

    }