Servlet过滤器与监听器（ServletFilter）

最新推荐文章于 2024-07-05 05:00:00 发布

猿小许

最新推荐文章于 2024-07-05 05:00:00 发布

阅读量1.8k

点赞数 1

分类专栏：框架

本文链接：https://blog.csdn.net/weixin_44205087/article/details/117923765

版权

框架专栏收录该内容

5 篇文章 0 订阅

订阅专栏

本文详细阐述了Java过滤器的工作原理、应用场景，包括过滤器的生命周期、过滤器链，以及监听器如ServletContextListener、HttpSessionListener的作用和使用方法。了解如何在Servlet编程中利用过滤器进行请求和响应的拦截与处理，以及监听器对域对象状态变化的监听。

摘要由CSDN通过智能技术生成

过滤器

一、过滤器的作用

1. 过滤器可以动态地拦截请求和响应，以变换或使用包含在请求或响应中的信息，

也就是说可以监视，修改或以某种方式处理客户端与服务端下在交流的数据

2.过滤器是可用于 Servlet 编程的 Java 类，可以实现以下目的：

（1）在客户端的请求访问后端资源之前，拦截这些请求。

（2）在服务器的响应发送回客户端之前，处理这些响应。

二. 工作原理：

客户端请求-过滤器对请求数据进行过滤，筛选->将有效数据交与web容器进行处理->web容器处理数据后返回处理数据->返回数据到客户端

（如果设置 FOWERD 则是在调用转发的情况下会进行拦截）

三.常见用途

记录日志
处理和过滤敏感字符
安全会话管理控制
处理字符编码

四.如何使用：

(1) 实现接口

定义一个过滤器需要实现 javax.servlet.filter接口

(2) 实现接口方法

1、 doFilter(ServletRequest,ServletResponse,FilterChain) ：对请求数据进行拦截处理并使用即相当于在此过滤器中放行

2、FilterChain.doFilter(ServletRequest,ServletResponse) 交由下web容器进行数据处理

如果有过滤器链，则交由下一个过滤器进行处理

3、 init(FilterConfig filterConfig); web容器启动时将实例化过滤器，之后将调用此方法读取web.xml 中设置的初始参数

4、进行数据初始化操作，（过滤器与init方法都是只执行一次）

5、 destroy()->在web容器销毁filter实例前（也就是服务器关闭时）调用此方法

(3) 在web.xml中注册过滤器或注解方式注册过滤器

第一种web.xml中注册过滤器

<filter>  声明过滤器
      <filter-name>过滤器名称</filter-name> 
      <filter-class>过滤器指向的限定包名以及过滤器类名</filter-class> 
      <init-param>
           <param-name>参数名称</param-name>
          <param-value>参数值</param-value>
	</init-param>
  </filter>
  <filter-mapping>
    <filter-name>过滤器名称</filter-name> 
    <url-pattern>对那些地址进行拦截</url-pattern> 
    <servlet-name>指定要拦截的servlet名称，与web.xml文件定义的servlet命名一致</servlet-name>	
    <dispatcher>对那些请求进行拦截 </dispatcher>  
</filter-mapping>

第二种：在类前注解的方式注册过滤器

例：@WebFilter (urlPatterns = "/newsServlet")
//(urlPatterns = "/newsServlet")代表过滤那个servlet实现类
public class NewsFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws 
    ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest,
     ServletResponse servletResponse, FilterChain filterChain)
     throws IOException, ServletException {
        System.out.println("经过了newsFilter过滤器..........");
        //执行doFilter()方法，则进入到下一个过滤器，即放行
        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {
    }
}

五.生命周期

服务器启动时实例化过滤器
调用init()方法初始化参数
利用FilterConfig ->getInitParams(name)方法获取参数值
客户端请求数据时doFilter()执行过滤器
服务器关闭时容器销毁过滤器实例前调用destory()方法

六.过滤器链

可以创建多个过滤器，形成过滤器链,过滤器链的执行步骤如下：

用户请求->第一个filter->执行完成后调用FilterChain的doFilter方法执行下一个过滤器->第二个过滤器.....->最后一个过滤器 ->服务器处理客户端请求返回数据

（每一个过滤器必须调用FilterChain 的 doFilter方法再能执行下一个过滤器，当最后一个过滤器时将交由服务器处理，也就是将合法的客户端请求交由服务端处理并返回数据）

过滤器链的执行顺序是由web.xml中配置的filter-mapping的先后顺序决定

一.监听器Listener

1.什么是监听器

监听器就是监听某个域对象的的状态变化的组件
监听器的相关概念：

- 事件源：被监听的对象(三个域对象 request、session、servletContext)
- 监听器：监听事件源对象事件源对象的状态的变化都会触发监听器（6+2）
- 注册监听器：将监听器与事件源进行绑定
- 响应行为：监听器监听到事件源的状态变化时所涉及的功能代码（程序员编写代码）

2.监听器有哪些

第一维度按照被监听的对象划分：ServletRequest域、HttpSession域、ServletContext域
第二维度按照监听的内容分：监听域对象的创建与销毁的、监听域对象的属性变化的

3.监听三大域对象的创建与销毁的监听器

监听器的编写步骤（重点）：

- 编写一个监听器类去实现监听器接口
- 覆盖监听器的方法
- 需要在web.xml中进行配置—注册

监听器ServletContextListener

监听ServletContext域的创建与销毁的监听器ServletContextListener

Servlet域的生命周期

- - 何时创建：服务器启动创建
  - 何时销毁：服务器关闭销毁

- ServletContextListener监听器的主要作用

- - 初始化的工作：初始化对象、初始化数据（加载数据库驱动、连接池的初始化）
  - 加载一些初始化的配置文件(spring的配置文件）

任务调度(定时器—Timer/TimerTask）

- 实例应用：
- 整体流程：create包下创建MyServletContextListener类实现ServletContextListener接口并覆盖方法public void contextInitialized(ServletContextEvent arg0)监听context域对象的创建；覆盖方法public void contextDestroyed(ServletContextEvent arg0)监听context域对象的销毁。并在web.xml中通过<listener>中的<listener-class>书写监听器全类名配置。
- 实现任务调度（即定时器）的思路：使用Timer类对象的scheduleAtFixedRate(task,firstTime,period)方法第一个参数书写TimerTask()的匿名内部类重写run方法从而实现调度任务内容；firstTime是Date类型对象，我们可以设置成当前晚上12点；period是间隔执行时间（单位毫秒），我们可以设置成24小时。从而实现从当前晚上12点开始，每24小时都执行对应的调度任务。

实例代码：

//web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
<!-- 注册监听器 -->
<listener>
    <listener-class>create.MyServletContextListener</listener-class>
</listener>
<display-name>WEB23_LISTENER</display-name>
<welcome-file-list>
  <welcome-file>index.jsp</welcome-file>
</welcome-file-list>
</web-app>

//MyServletContextListener.java
package create;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Timer;
import java.util.TimerTask;
import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
public class MyServletContextListener implements ServletContextListener{
//监听context域对象的创建
@Override
public void contextInitialized(ServletContextEvent arg0) {//参数可以获得被监听的对象
//        ServletContext servletContext1 = arg0.getServletContext();//返回值是被监听的对象
//        Object servletContext2 = arg0.getSource();//等同于arg0.getServletContext()，获得的是Object类型，但实际上也是获得被监听的对象
//        System.out.println("context创建了...");
    //开启一个计息任务调度——每天晚上12点计息一次
    Timer timer = new Timer();
    //task任务，firstTime第一次执行的时间，period间隔执行的时间(单位毫秒)
    //timer.scheduleAtFixedRate(task, firstTime, period);
    //测试demo:从服务器启动开始每隔5秒打印“银行计息了”
//        timer.scheduleAtFixedRate(new TimerTask() {
//            @Override
//            public void run() {
//                System.out.println("银行计息了...");
//            }
//        }, new Date(), 5000);
    //实际银行计息业务
    //1.起始时间，定义成晚上12点
    //2.间隔时间：24小时
    SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
    String currentTime = "2018-08-15 00:00:00";
    Date date = null;
    try {
        date = format.parse(currentTime);
    } catch (ParseException e) {
        e.printStackTrace();
    }
    timer.scheduleAtFixedRate(new TimerTask() {
        @Override
        public void run() {
            System.out.println("银行计息了...");
        }
    }, date, 24*60*60*1000);
}
//监听context域对象的销毁
@Override
public void contextDestroyed(ServletContextEvent arg0) {
    System.out.println("context销毁了...");
}
}
1

HttpSessionListener监听器的运行过程

监听Httpsession域的创建于销毁的监听器HttpSessionListener

- HttpSession对象的生命周期

- - 何时创建：第一次调用request.getSession时创建
  - 何时销毁：服务器关闭销毁、session过期（默认30分钟，修改默认的30分钟是在Tomcat的web.xml，修改当前项目的过期时间是在自己项目的web.xml中）、手动销毁

- HttpSessionListener监听器的主要作用：

- - 由于每次访问网站都会默认创建session对象（jsp页面中page指令中的session属性默认为true，即被访问时创建session），可以用于计数网站访问过的人

- 实例应用：

- - 整体流程：创建MyHttpSessionListener类实现HttpSessionListener接口并覆盖public void sessionCreated(HttpSessionEvent arg0)和public void sessionDestroyed(HttpSessionEvent arg0)方法。并在web.xml中注册该listener，和index.jsp页面。每当访问一次index页面，即会调用一次sessionCreated方法。
  - 实例代码：

//web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
<!-- 注册监听器 -->
<listener>
    <listener-class>create.MyHttpSessionListener</listener-class>
</listener>
<display-name>WEB23_LISTENER</display-name>
<welcome-file-list>
  <welcome-file>index.jsp</welcome-file>
</welcome-file-list>
</web-app>

//MyHttpSessionListener.java
package create;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;
public class MyHttpSessionListener implements HttpSessionListener{
@Override
public void sessionCreated(HttpSessionEvent arg0) {
    //获得Session对象的方法arg0.getSession()
    String id = arg0.getSession().getId();
    System.out.println("session创建"+id);

}
@Override
public void sessionDestroyed(HttpSessionEvent arg0) {
    System.out.println("session销毁");

}
}

//index.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="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
index.jsp
</body>
</html>
1

监听器ServletRequestListener

监听ServletRequest域创建与销毁的监听器ServletRequestListener

- ServletRequest的生命周期

- - 创建：每一次请求都会创建request
  - 销毁：请求结束

- 用法同上，用处不是很大，此处省略。

监听三大域对象的属性变化

域对象的通用的方法：

- setAttribute(name,value)

- - 触发添加属性的监听器的方法
  - 触发修改属性的监听器的方法

- getAttribute(name)
- removeAttribute(name)

- - 触发删除属性的监听器的方法

ServletContextAttibuteListener监听器

- 整体使用流程：定义类MyServeltContextAttributeListener实现ServeltContextAttributeListener接口并覆盖public void attributeAdded(ServletContextAttributeEvent arg0) ;public void attributeRemoved(ServletContextAttributeEvent arg0);public void attributeReplaced(ServletContextAttributeEvent arg0)三个方法。在attributeAdded方法中的参数传递的ServletContextAttributeEvent实例对象中，调用getName方法获取放到域中的name，调用getValue方法获取放到域中的value；在attributeRemoved方法中的参数传递的ServletContextAttributeEvent实例对象中，调用getName方法获取被删除的域中的name，调用getValue方法获取被删除的域中的value；在attributeReplaced 方法中的参数传递的ServletContextAttributeEvent实例对象中，调用getName方法获取修改前的域中的name，调用getValue方法获取修改前的域中的value。并在web.xml中注册监听器。
- 实例代码：

//MyServletContextAttributeLister.java
package attribute;
import javax.servlet.ServletContextAttributeEvent;
import javax.servlet.ServletContextAttributeListener;
public class MyServletContextAttributeListener implements ServletContextAttributeListener{
    @Override
    public void attributeAdded(ServletContextAttributeEvent arg0) {
        //添加属性时的监听方法
        System.out.println(arg0.getName());//获得放到域中的name
        System.out.println(arg0.getValue());//获得放到域中的value
    }
    @Override
    public void attributeRemoved(ServletContextAttributeEvent arg0) {
        //移除属性时的监听方法
        System.out.println(arg0.getName());//删除的域中的name
        System.out.println(arg0.getValue());//删除的域中的value
    }
    @Override
    public void attributeReplaced(ServletContextAttributeEvent arg0) {
        //修改属性时的监听方法
        System.out.println(arg0.getName());//获得修改前的域中的name
        System.out.println(arg0.getValue());//获得修改前的域中的value
    }
}

//web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
  <listener>
    <listener-class>attribute.MyServletContextAttributeListener</listener-class>
  </listener>
  <display-name>WEB23_LISTENER</display-name>
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
  <servlet>
    <description></description>
    <display-name>TestMyServletContextAttributeListener</display-name>
    <servlet-name>TestMyServletContextAttributeListener</servlet-name>
    <servlet-class>attribute.TestMyServletContextAttributeListener</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>TestMyServletContextAttributeListener</servlet-name>
    <url-pattern>/test1</url-pattern>
  </servlet-mapping>
</web-app>

//用于测试的接口TestMyServletContextAttributeListener.java
package attribute;
import java.io.IOException;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class TestMyServletContextAttributeListener extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        ServletContext context = this.getServletContext();
        //向context域中存数据
        context.setAttribute("name", "tom");
        //改context数据
        context.setAttribute("name", "lucy");
        //删context数据
        context.removeAttribute("name");
    }
    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doGet(request, response);
    }
}

当调用context.setAttribute(“name”, “tom”)时打印name tom；当调用context.setAttribute(“name”, “lucy”)时打印name tom；当调用context.removeAttribute(“name”)时打印name lucy。

HttpSessionAttributeListener监听器（同上）
ServletRequestAriibuteListenr监听器（同上）

5.与session中的绑定的对象相关的监听器（对象感知监听器）

即将要被绑定到session中的对象有几种状态

- 绑定状态：就一个对象被放到session域中(setAttribute)
- 解绑状态：就是这个对象从session域中移除了(removeAttribute)
- 钝化状态：是将session内存中的对象持久化（序列化）到磁盘
- 活化状态：就是将磁盘上的对象再次恢复到session内存中(注意对象必须实现Serializable

接口)

绑定与解绑的监听器HttpSessionBindingListener（绑在对象上的，且不用在web.xml配置）

- 流程：创建对象实现HttpSessionBindingListener 接口中的public void valueBound(HttpSessionBindingEvent arg0)（绑定的方法，将对象放到session时触发）和public void valueUnbound(HttpSessionBindingEvent arg0)（解绑的方法，将对象从session中移除时触发）。
- 实例代码：

//Person.java创建Person类
package domian;
import javax.servlet.http.HttpSessionBindingEvent;
import javax.servlet.http.HttpSessionBindingListener;
public class Person implements HttpSessionBindingListener{
    private String id;
    private String name;
    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    @Override
    public String toString() {
        return "Person [id=" + id + ", name=" + name + "]";
    }
    public Person(String id, String name) {
        super();
        this.id = id;
        this.name = name;
    }
    public Person() {
        super();
    }
    @Override
    public void valueBound(HttpSessionBindingEvent arg0) {
        // 绑定的方法，将person对象放到session时触发
        System.out.println("Person被绑定");
    }
    @Override
    public void valueUnbound(HttpSessionBindingEvent arg0) {
        // 解绑的方法，将person对象从session移除时触发
        System.out.println("Person被解绑");
    }
}

//TestPersonBindingServlet.java
package domian;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
public class TestPersonBindingServlet extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        HttpSession session = request.getSession();
        //将person对象绑定到session中
        Person p = new Person("100","jack");
        session.setAttribute("person",p);
        //将person对象从session中解绑
        session.removeAttribute("person");
    }
    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doGet(request, response);
    }
}
1

当访问接口时，代码执行到session.setAttribute("person",p);时输出Person被绑定；代码执行到session.removeAttribute("person");时输出Person被解绑。

钝化与活化的监听器HttpSessionActivationListener 【重要：用于服务器优化】

- 默认：实现了HttpSessionActivationListener（覆盖其中的public void sessionDidActivate(HttpSessionEvent arg0)和public void sessionWillPassivate(HttpSessionEvent arg0)方法）和Serializable接口（注意必须实现Serializable接口）的对象，被放入到session后，当服务器stop时，session会被钝化到work/catalina/localhost中命名为SESSIONS.ser;当服务器start时，session会被活化到session域中。
- 手动设置钝化时间和存储位置(通过配置文件指定对象钝化时间—对象多长时间不用被钝化）：

- - 在META-INF下创建一个context.xml
  - context.xml中的代码：

<?xml version="1.0" encoding="UTF-8"?>
<Context>
<!-- maxIdleSwap:session中的对象多长时间不使用就钝化(单位：分钟），注意钝化和销毁的概念完全不同 -->
<!-- directory:钝化后的对象的文件写到磁盘的哪个目录下配置钝化的对象文件在 work/catalina/localhost/钝化文件 -->
<Manager className="org.apache.catalina.session.PersistentManager" maxIdleSwap="1"><!-- Manager是处理内容的对象 -->
    <Store className="org.apache.catalina.session.FileStore" directory="storeFile" /><!-- Store是做存储的对象 -->
</Manager>
</Context>
1

- 实例代码：

//Customer.java
package domian;
import java.io.Serializable;
import javax.servlet.http.HttpSessionActivationListener;
import javax.servlet.http.HttpSessionEvent;
public class Customer implements HttpSessionActivationListener,Serializable{
    private String id;
    private String name;
    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    @Override
    public String toString() {
        return "Customer [id=" + id + ", name=" + name + "]";
    }
    public Customer(String id, String name) {
        super();
        this.id = id;
        this.name = name;
    }
    public Customer() {
        super();
    }
    @Override
    public void sessionDidActivate(HttpSessionEvent arg0) {
        //活化
        System.out.println("customer被活化了");
    }
    @Override
    public void sessionWillPassivate(HttpSessionEvent arg0) {
        //钝化
        System.out.println("customer被钝化了");
    }
}

//TestCustomerActiveServlet.java 用于将customer对象放至session中
package domian;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
public class TestCustomerActiveServlet extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        HttpSession session = request.getSession();
        //将customer放到session中
        Customer customer = new Customer("200","lucy");
        session.setAttribute("customer", customer);
        System.out.println("customer被放到session中");
    }
    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doGet(request, response);
    }
}

//TestCustomerActiveServlet2 用于测试session对象是否被活化
package domian;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
public class TestCustomerActiveServlet2 extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        HttpSession session = request.getSession();
        //从session域中获取customer
        Customer customer = (Customer)session.getAttribute("customer");
        System.out.println(customer.getName());
    }
    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doGet(request, response);
    }
}
1
2

猿小许

关注

1
点赞
踩
12

收藏

觉得还不错? 一键收藏
打赏
0
评论
Servlet过滤器与监听器（ServletFilter）

过滤器一、过滤器的作用1.过滤器可以动态地拦截请求和响应，以变换或使用包含在请求或响应中的信息，也就是说可以监视，修改或以某种方式处理客户端与服务端下在交流的数据2.过滤器是可用于 Servlet 编程的 Java 类，可以实现以下目的：（1）在客户端的请求访问后端资源之前，拦截这些请求。（2）在服务器的响应发送回客户端之前，处理这些响应。二.工作原理：客户端请求-过滤器对请求数据进行过滤，筛选->将有效数据交与web容器进行处理->web容器处理数据后返回...
复制链接

扫一扫