老杜 JavaWeb 讲解（十九） ——Filter过滤器

(十七)Filter过滤器

Filter过滤器

• 当前的OA项目存在什么缺陷？

  • DeptServlet、EmpServlet、OrderServlet。每一个Servlet都是处理自己相关的业务。在这些Servlet执行之前都是需要判断用户是否登录了。如果用户登录了，可以继续操作，如果没有登录，需要用户登录。这段判断用户是否登录的代码是固定的，并且在每一个Servlet类当中都需要编写，显然代码没有得到重复利用。包括每一个Servlet都要解决中文乱码问题，也有公共的代码。这些代码目前都是重复编写，并没有达到复用。怎么解决这个问题?

    可以使用Servlet规范中的Filter过滤器来解决这个问题。

• Filter是什么，有什么用，执行原理是什么？

  • Filter是过滤器。

  • Filter可以在Servlet这个目标程序执行之前添加代码。也可以在目标Servlet执行之后添加代码。之前之后都可以添加过滤规则。

  • 一般情况下，都是在过滤器当中编写公共代码。

• 一个过滤器怎么写呢？

第一步：编写一个Java类实现一个接口：jarkata.servlet.Filter。并且实现这个接口当中所有的方法。

• init方法：在Filter对象第一次被创建之后调用，并且只调用一次。
• doFilter方法：只要用户发送一次请求，则执行一次。发送N次请求，则执行N次。在这个方法中编写过滤规则。
• destroy方法：在Filter对象被释放/销毁之前调用，并且只调用一次。

第二步：在web.xml文件中对Filter进行配置。这个配置和Servlet很像。

• <filter>
      <filter-name>filter2</filter-name>
      <filter-class>com.bjpowernode.javaweb.servlet.Filter2</filter-class>
  </filter>
  <filter-mapping>
      <filter-name>filter2</filter-name>
      <url-pattern>*.do</url-pattern>
  </filter-mapping>
  

• 或者使用注解：@WebFilter({"*.do"})

注意：

• Servlet对象默认情况下，在服务器启动的时候是不会新建对象的。
• Filter对象默认情况下，在服务器启动的时候会新建对象。
• Servlet是单例的。Filter也是单例的。（单实例。）

目标Servlet是否执行，取决于两个条件：

• 第一：在过滤器当中是否编写了：chain.doFilter(request, response); 代码。
• 第二：用户发送的请求路径是否和Servlet的请求路径一致。

chain.doFilter(request, response); 这行代码的作用：

• 执行下一个过滤器，如果下面没有过滤器了，执行最终的Servlet。

注意：Filter的优先级，天生的就比Servlet优先级高。

• /a.do 对应一个Filter，也对应一个Servlet。那么一定是先执行Filter，然后再执行Servlet。

关于Filter的配置路径：

• /a.do、/b.do、/dept/save。这些配置方式都是精确匹配。
• /* 匹配所有路径。
• *.do 后缀匹配。不要以 / 开始
• /dept/* 前缀匹配。

在web.xml文件中进行配置的时候，Filter的执行顺序是什么？

• 依靠filter-mapping标签的配置位置，越靠上优先级越高。

过滤器的调用顺序，遵循栈数据结构。

使用@WebFilter的时候，Filter的执行顺序是怎样的呢？

• 执行顺序是：比较Filter这个类名。
• 比如：FilterA和FilterB，则先执行FilterA。
• 比如：Filter1和Filter2，则先执行Filter1.

Filter的生命周期？

• 和Servlet对象生命周期一致。
• 唯一的区别：Filter默认情况下，在服务器启动阶段就实例化。Servlet不会。

Filter过滤器这里有一个设计模式：

• 责任链设计模式。
• 过滤器最大的优点：
  • 在程序编译阶段不会确定调用顺序。因为Filter的调用顺序是配置到web.xml文件中的，只要修改web.xml配置文件中filter-mapping的顺序就可以调整Filter的执行顺序。显然Filter的执行顺序是在程序运行阶段动态组合的。那么这种设计模式被称为责任链设计模式。
• 责任链设计模式最大的核心思想：
  • 在程序运行阶段，动态的组合程序的调用顺序。

改造oa 项目

主要两个部分：

第一部分：增加Filter代码

package com.zwm.oa.web.filter;

import jakarta.servlet.*;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.servlet.http.HttpSession;

import java.io.IOException;

/**
 * @author 猪无名
 * @date 2023/8/4 16 34
 * discription:
 */
public class LoginFilter implements Filter {
    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
            throws IOException, ServletException {
        //将传进来的参数转型
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) resp;
        //获取session对象，有就拿，没有不拿（只是做判断用的，不需要重新建）。
        HttpSession session = request.getSession(false);
        String servletPath = request.getServletPath();

        //对特殊页面和登录用户进行放行
        if("/index.jsp".equals(servletPath)|| "/welcome".equals(servletPath)||
                "/user/login".equals(servletPath)|| "/user/exit".equals(servletPath)||
               ( session != null && session.getAttribute("username") !=null)){
           //没有问题，继续向下走
            chain.doFilter(request,response);
        }else {
            //跳转到登录页面
            System.out.println("跳转失败");
            response.sendRedirect(request.getContextPath()+"/welcome");

        }
    }

}

<!--登录检查的过滤器，过滤所用的路径。-->
    <filter>
        <filter-name>loginFilter</filter-name>
        <filter-class>com.zwm.oa.web.filter.LoginFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>loginFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

第二部分：修改业务代码

@WebServlet({ "/dept/list","/dept/delete","/dept/detail","/dept/save","/dept/modify"})
public class DeptServlet extends HttpServlet {
    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        //获取session对象，有就拿，没有不拿（只是做判断用的，不需要重新建）。
//        HttpSession session = request.getSession(false);
//
//        if(session != null && session.getAttribute("username") !=null){
//            String servletPath = request.getServletPath();
//            if("/dept/list".equals(servletPath)){
//                doList(request,response);
//            }else if("/dept/delete".equals(servletPath)){
//                doDel(request,response);
//            }else if("/dept/detail".equals(servletPath)){
//                doDetail(request,response);
//            }else if("/dept/save".equals(servletPath)){
//                doSave(request,response);
//            }else if("/dept/modify".equals(servletPath)){
//                doModify(request,response);
//            }
//        }else {
//            //跳转到登录页面
//            //response.sendRedirect(request.getContextPath() + "/index.jsp");
//            //或者直接访问web站点的根即可，自动找到index页面。
//            System.out.println("跳转失败");
//            response.sendRedirect(request.getContextPath()+"/welcome");
//
//        }
        
        
        //上面的验证操作全部放在了过滤器中实现，在业务代码中只需要进行对应页面的跳转。
        String servletPath = request.getServletPath();
        if("/dept/list".equals(servletPath)){
            doList(request,response);
        }else if("/dept/delete".equals(servletPath)){
            doDel(request,response);
        }else if("/dept/detail".equals(servletPath)){
            doDetail(request,response);
        }else if("/dept/save".equals(servletPath)){
            doSave(request,response);
        }else if("/dept/modify".equals(servletPath)){
            doModify(request,response);
        }
    }