监听器 Listener

2018-09-01 本文已影响1人善倾

JSP 中学习到的 9 个内置对象，是在 web 容器运行 web 应用的时候负责创建和管理的，有时候如果能够监听这些对象，可以实现一些重要功能。比如监听 request 对象的属性改变可以实现系统日志的功能，监听 session 对象的创建和删除，可以实现举例系统在线用户人数。可见监听内置对象还是很有市场的。

监听的多的也就是 application 、session 和 request 内置对象了，他们的监听器设计是一模一样的，下面以 application 对象来讲解监听器的使用，其他都是一模一样的。

监听器本质上也是一种特殊的 Servlet ，这一点和 JSP 、Filter 对象没有任何不同。Servlet 需要遵循的语法它都需要遵循，同样也需要在 WEB-INF/web.xml 中进行配置。

监听器之所以能够监听就是使用了观察者模式，也就是说 application 对象内部其实是持有了 ServletContextListener 和 ServletContextAttributeListener 接口的引用，内部做出相关改变，就调用对应接口的对应方法来通知监听器发生了改变，并且封装一个事件对象作为参数传递，这就是观察者模式的本质。查看观察者模式的笔记

监听 application 内置对象

JavaWeb 标准类库中把监听 application 对象的创建、销毁和属性的改变分为了两个监听器接口来实现。因为监听器也是一种特殊的 Servlet ，所以它同样需要在 WEB-INF/web.xml 中进行配置，但是它和 Filter 、Servlet 不同的地方在于完全不和前台页面打交道，所以不需要配置映射路径，只需要如下配置一下就可以了。

<listener>
<listener-class>xxxx</listener-class>
</listener>

监听 application 对象的创建和销毁

首先实现 javax.servlet.ServletContextListener 接口，重写它提供的两个方法。该接口源码如下，application 对象被创建的时候，就会调用此接口的contextInitialized()方法，此方法就相当于能够监听 application 对象的创建了。对象被销毁时就会调用contextDestroyed()方法，就拥有了监听对象销毁的能力。

public interface ServletContextListener extends EventListener {
    public default void contextInitialized(ServletContextEvent sce){}
    public default void contextDestroyed(ServletContextEvent sce){}
}

其中的参数就是封装了此次监听事件的 ServletContextEvent 类型的对象，通过它的getServletContext()方法就可以获得 application 对象的引用。该类源码如下，可见它的构造函数接收的是一个 ServletContext 接口类型的对象。这个事件对象是在对应被监听的内置对象中创建的，然后作为参数传递到监听器对应的方法来的。不负责任的猜测 application 对象中会有如下的代码：ServletContextListener.xxx(new ServletContextEvent(this))

public class ServletContextEvent extends java.util.EventObject {
    private static final long serialVersionUID = 1L;
    public ServletContextEvent(ServletContext source) {
        super(source);
    }
    public ServletContext getServletContext() {
        return (ServletContext) super.getSource();
    }
}

监听 application 对象属性的改变

首先实现 javax.servlet.ServletContextListener 接口，重写它提供的三个方法。该接口源码如下，一旦 application 对象添加了属性，该监听器的attributeAdded()方法就会被调用。属性被移除时attributeRemoved()方法就会被调用，属性被更改时attributeReplaced()方法会被调用。

public interface ServletContextAttributeListener extends EventListener {
    public default void attributeAdded(ServletContextAttributeEvent scae) {}
    public default void attributeRemoved(ServletContextAttributeEvent scae) {}
    public default void attributeReplaced(ServletContextAttributeEvent scae) {}
}

通过 ServletContextAttributeEvent 接口的getName()和getValue()方法得到的值，是 application 对象属性被更改之前的值，乍一看觉得很奇怪，如果真正理解了观察者模式，就会觉得这很正常了，查看该接口的源码就可以发现，这里的 name 和 value 都是作为构造函数的参数传递过来的。而且这样设计非常的符合逻辑啊，监听的是改变之前的内容才有意义啊，已经改变的内容直接通过 application 的getAttribute()方法就可以得到了，还需要监听吗？

public class ServletContextAttributeEvent extends ServletContextEvent {
    private static final long serialVersionUID = 1L;
    private final String name;
    private final Object value;
    public ServletContextAttributeEvent(ServletContext source, String name,
            Object value) {
        super(source);
        this.name = name;
        this.value = value;
    }
    public String getName() {
        return this.name;
    }
    public Object getValue() {
        return this.value;
    }
}

监听 application 对象，可以用来做一些需要 web 容器一启动就要立即完成的工作。从这里也可以看出监听器是最早需要被创建的对象，比 application 还早，这很正常啊，只有它先被创建，才能监听其他对象啊。然后是 ServletConfig 对象被创建、接着是 Filter 对象、最后才是其他内置对象和普通的 Servlet 类。

监听 session 内置对象

同样是有两个监听器接口，一个负责监听 session 内置对象的创建和销毁，另一个负责监听属性的改变，分别是 javax.servlet.http.HttpSessionListener 和 javax.servlet.http.HttpSessionAttributeListener ，具体使用规则和上面讲到的 application 对象是一模一样的，真的没有任何必要再写一遍了。

session 对象是在用户第一次访问动态组件的时候创建的，如果用户只是访问静态的 html 文件，web 容器是不会创建 session 对象的，因为静态资源分属于 http 服务器管理，不经过容器。

监听 session 内置对象，可以用来实现记录当前系统在线人数。实现这个功能还需要利用到 javascript 技术，利用它在浏览器关闭前给服务端发送最后一条请求，监听器获取后，就找到当前会话的 session 及时删除掉。如今的 js 真的已经很牛逼了，查看此文章：Javascript：一个屌丝的逆袭

监听 request 内置对象

同样是有两个监听器接口，一个负责监听 request 内置对象的创建和销毁，另一个负责监听属性的改变，分别是 javax.servlet.ServletRequestListener 和 javax.servlet.ServletRequestAttributeListener ，具体使用规则和上面讲到的 application 对象是一模一样的，真的没有任何必要再写一遍了。

监听 request 内置对象，可以用来记录用户的每次请求，实现系统日志的功能。