Servlet 监听器

最新推荐文章于 2025-04-25 09:32:31 发布

留兰香丶

最新推荐文章于 2025-04-25 09:32:31 发布

阅读量749

点赞数

CC 4.0 BY-SA版权

分类专栏： Java 基础文章标签：监听器

本文链接：https://blog.youkuaiyun.com/codejas/article/details/79046182

Java 基础专栏收录该内容

55 篇文章

订阅专栏

可参考博文：Session 的钝化与活化

(一)Servlet 中的作用域总结

趁着这个知识点顺便把Servlet 中的四大作用域也在这篇博文中总结一下。

application域(ServletContext)

作用范围：在整个Web 应用范围内共享数据 (所有用户)
生命周期：当服务器启动，Web 应用被加载后创建ServletContext 对象，域产生，当被移出Web 容器或者服务器关闭后随着Web 应用的销毁而销毁。

session域(HttpSession)

作用范围：当前会话范围内(当前用户)
生命周期：当程序第一次调用request.getSession() 方法时在服务器内存中创建客户端需要的Session 对象。当Session 超时、调用invalidate 方法或者当Web 服务器非正常关闭的情况下被销毁。

request域(HttpServletRequest)

作用范围：整个请求转发链
生命周期：当服务器接收到一个请求，创建代表请求的request 的对象，当请求结束时，服务器销毁代表请求的request 对象，request 域被销毁。

pageContext域(PageContext)

作用范围：当前JSP 页面
生命周期：当对JSP 页面访问开始时，创建代表当前JSP 的PageContext，对JSP 访问结束时，销毁当前JSP 的PageContext。

(二)监听器概述

监听器是一个实现特定接口的普通Java 程序，这个程序专门用于监听另一个Java 对象的方法调用或属性的改变，当被监听对象发生上面的动作时，监听器根据动作的发生立即执行自身的某个方法。

Servlet 中的监听器有八个。这里根据其特定的功能把它们分为三种。

这里写图片描述

监听器的实现步骤
①：实现对应的接口
②：在web.xml 配置文件中配置该监听器(对于HttpSessionActivationListener 与HttpSessionBindingListener 不需要进行配置)

(三)监听三大作用域创建和销毁的监听器

ServletContextListener

作用：用来监听ServletContext对象创建和销毁
接口方法：contextInitialized()、contextDestroyed()
接收事件：ervletContextEvent
触发场景：在服务器加载Web 应用程序时，会调用contextInitialized()，而当容器移除Web 应用程序时，会调用contextDestroyed ()方法。

HttpSessionListener

作用：用来监听HttpSession对象创建和销毁
接口方法：sessionCreated()、sessionDestroyed ()
接收事件：HttpSessionEvent
触发场景：在session （HttpSession）对象建立或被销毁时，会分别调用这两个方法。

ServletRequestListener

作用：用来监听ServletRequest对象创建和销毁
接口方法：requestInitialized()、requestDestroyed()
接收事件：RequestEvent
触发场景：在request（HttpServletRequest）对象建立或被销毁时，会分别调用这两个方法。

简单例子演示(由于这三个监听器有很大的共性，所以这里只演示HttpSessionListener)

在Servlet 中创建一个HttpSession 对象，并立即销毁它。在监听器里监听HttpSession 的创建与销毁状态，分别在创建与销毁时在控制台打印一句话。

监听器类MyHttpSessionListener

package com.jas.listener;

import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;

public class MyHttpSessionListener implements HttpSessionListener {
    @Override
    public void sessionCreated(HttpSessionEvent httpSessionEvent) {
        System.out.println("HttpSession 对象被创建了！" + httpSessionEvent.getSession());
    }

    @Override
    public void sessionDestroyed(HttpSessionEvent httpSessionEvent) {
        System.out.println("HttpSession1 对象被销毁了！" + httpSessionEvent.getSession());
    }
}

Servlet 类HttpSessionServlet

package com.jas.servlet;

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

@WebServlet("/testSession")
public class HttpSessionServlet extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException {
            HttpSession session = request.getSession();    //创建HttpSession 对象
            request.getSession().invalidate();    //创建之后立即销毁

    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException {
            doPost(request,response);
    }
}

在web.xml 中配置监听器

<listener>
        <listener-class>com.jas.listener.MyHttpSessionListener</listener-class>
</listener>

访问“testSession”时，输出结果如下

HttpSession 对象被创建了！org.apache.catalina.session.StandardSessionFacade@36d351f0
HttpSession1 对象被销毁了！org.apache.catalina.session.StandardSessionFacade@36d351f0

(四)监听三大作用域中属性变化的监听器

ServletContextAttributeListener

作用：用来监听ServletContext 对象属性的变化
接口方法： attributeAdded()、 attributeReplaced()、attributeRemoved()
接收事件： ServletContextAttributeEvent
触发场景：若有对象加入为application（ServletContext）对象的属性，则会调用attributeAdded()，同理在置换属性与移除属性时，会分别调用attributeReplaced()、attributeRemoved()。

HttpSessionAttributeListener

作用：用来监听HttpSession 对象属性的变化
接口方法： attributeAdded()、 attributeReplaced()、attributeRemoved()
接收事件： HttpSessionBindingEvent
触发场景：若有对象加入为session（HttpSession）对象的属性，则会调用attributeAdded()，同理在置换属性与移除属性时，会分别调用attributeReplaced()、 attributeRemoved()。

ServletRequestAttributeListener

作用：用来监听ServletRequest 对象属性的变化
接口方法： attributeAdded()、 attributeReplaced()、attributeRemoved()
接收事件： HttpSessionBindingEvent
触发场景：若有对象加入为request（HttpServletRequest）对象的属性，则会调用attributeAdded()，同理在置换属性与移除属性时，会分别调用attributeReplaced()、 attributeRemoved()。

简单例子演示(这里以ServletContextAttributeListener 为例)

在Servlet 中创建一个ServletContext 对象，并在域中添加一个“hello” 属性，接着改变该属性值，并移除该属性。定义一个监听器监听其中的属性变化。

监听器类MyServletContextAttributeListener

package com.jas.listener;

import javax.servlet.ServletContextAttributeEvent;
import javax.servlet.ServletContextAttributeListener;

public class MyServletContextAttributeListener implements ServletContextAttributeListener {

    @Override
    public void attributeAdded(ServletContextAttributeEvent servletContextAttributeEvent) {
        System.out.println("属性被创建了!" + servletContextAttributeEvent.getName() + ":"
                + servletContextAttributeEvent.getValue());
    }

    @Override
    public void attributeRemoved(ServletContextAttributeEvent servletContextAttributeEvent) {
        System.out.println("属性被移除了!" );
    }

    @Override
    public void attributeReplaced(ServletContextAttributeEvent servletContextAttributeEvent) {
        System.out.println("属性被替换了!");
    }
}

Servlet 类ServletContext

package com.jas.servlet;

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

@WebServlet("/servletContext")
public class ServletContext extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException {
        this.getServletContext().setAttribute("hello","Hello");    //添加属性
        this.getServletContext().setAttribute("hello","Hello ~");    //覆盖原来的属性值
        this.getServletContext().removeAttribute("hello");    //移除属性
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException {
        doPost(request,response);
    }
}

在web.xml 中配置监听器

<listener>
        <listener-class>com.jas.listener.MyServletContextAttributeListener</listener-class>
</listener>

访问“servletContext”后，输出如下

属性被创建了!hello:Hello
属性被替换了!
属性被移除了!

(五)javabean 感知自己在Session 中状态变化的监听器

HttpSessionBindingListener

作用：当javabean 自己感知自己是否被加入到session 中
接口方法： valueBound()、valueUnbound()
接收事件： HttpSessionBindingEvent
触发场景：实现HttpSessionBindingListener 接口的类别，其实例如果被加入至session（HttpSession）对象的属性中，则会调用 valueBound()，如果被从session（HttpSession）对象的属性中移除，则会调用valueUnbound()，实现 HttpSessionBindingListener接口的类别不需在web.xml中设定。

HttpSessionActivationListener

作用：感知自己在session 中的钝化与活化
接口方法： sessionDidActivate()、 sessionWillPassivate()
接收事件： HttpSessionEvent
触发场景：当HttpSession 对象中的对象将要随HttpSession 被钝化之前，调用 sessionWillPassivate() 方法。当被钝化的HttpSession 活化之后调用sessionDidActivate() 方法。

PS：这两个监听器类很特殊，不需要自己去写类实现也不需要在web.xml中注册,只要使javabean实现这个接口就能起作用。

简单例子演示(这里以HttpSessionBindingListener 为例，关于Session 的钝化与活化，不了解的可以点击最上面的链接查看)

创建一个javabean 实现HttpSessionBindingListener 接口，并创建一个Servlet 类，创建User 类实例，将其存储在Session 域中。

javabean 类User

package com.jas.domain;

import javax.servlet.http.HttpSessionBindingEvent;
import javax.servlet.http.HttpSessionBindingListener;
import java.io.Serializable;

public class User implements Serializable,HttpSessionBindingListener {
    private String username;
    private int age;

    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public void valueBound(HttpSessionBindingEvent httpSessionBindingEvent) {
        System.out.println("当前javabean 感知到了自己被绑定到了Session 域！");
    }

    @Override
    public void valueUnbound(HttpSessionBindingEvent httpSessionBindingEvent) {
        System.out.println("当前javabean 感知到了自己被移出了Session 域！");
    }
}

Servlet 类SessionBindServlet

package com.jas.servlet;

import com.jas.domain.User;

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

@WebServlet("/sessionBindServlet")
public class SessionBindServlet extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException {
        User user = new User();
        user.setAge(18);
        user.setUsername("Jas");
        request.getSession().setAttribute("user",user);    //将user 对象添加到Session 域中
        request.getSession().removeAttribute("user");    //将user 对象从Session 域中移除
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException {
        doPost(request,response);
    }
}

当访问“sessionBindServlet” 时，输出如下

当前javabean 感知到了自己被绑定到了Session 域！
当前javabean 感知到了自己被移出了Session 域！