史上最全面‘java 监听器’解读，读完就能用进项目

Java架构师迁哥

关注

发布于: 2020 年 12 月 30 日

Web 监听器导图详解

　　监听器是 JAVA Web 开发中很重要的内容，其中涉及到的知识，可以参考下面导图：

一、Web 监听器

1. 什么是 web 监听器？

　　web 监听器是一种 Servlet 中的特殊的类，它们能帮助开发者监听 web 中的特定事件，比如 ServletContext,HttpSession,ServletRequest 的创建和销毁；变量的创建、销毁和修改等。可以在某些动作前后增加处理，实现监控。

2. 监听器常用的用途

　　通常使用 Web 监听器做以下的内容：

　　统计在线人数，利用 HttpSessionLisener

　　加载初始化信息：利用 ServletContextListener

　　统计网站访问量

　　实现访问监控

3. 接下来看看一个监听器的创建以及执行过程

　　首先需要创建一个监听器，实现某种接口，例如我想实现一个对在线人数的监控，可以创建如下的监听器：

public class MyListener implements HttpSessionListener{    private int userNumber = 0;    public void sessionCreated(HttpSessionEvent arg0) {        userNumber++;        arg0.getSession().setAttribute("userNumber", userNumber);    }    public void sessionDestroyed(HttpSessionEvent arg0) {        userNumber--;        arg0.getSession().setAttribute("userNumber", userNumber);    }}

复制代码

　　然后在 web.xml 中配置该监听器，在 web-app 中添加：

  <listener>      <listener-class>com.test.MyListener</listener-class>  </listener>

复制代码

　　在 JSP 中添加访问人数：

<body>    在线人数：<%=session.getAttribute("userNumber") %><br/></body>

复制代码

　　当我使用我的浏览器访问时，执行结果如下：

　　当打开另一个浏览器访问时：

　　由于打开另一个浏览器访问，相当于另一个会话，因此在线人数会增加。

　　对于 3.0 版本的 Servlet 来说，还支持使用注解的方式进行配置。

　　那么接下来看看都有哪些监听器以及方法吧！

二、监听器的分类

1. 按照监听的对象划分：

　　按照监听对象的不同可以划分为三种：

　　ServletContext 监控：对应监控 application 内置对象的创建和销毁。

　　当 web 容器开启时，执行 contextInitialized 方法；当容器关闭或重启时，执行 contextDestroyed 方法。

　　实现方式：直接实现 ServletContextListener 接口：

public class MyServletContextListener implements ServletContextListener{    public void contextDestroyed(ServletContextEvent sce) {
    }    public void contextInitialized(ServletContextEvent sce) {
    }}

复制代码

　　HttpSession 监控：对应监控 session 内置对象的创建和销毁。

　　当打开一个新的页面时，开启一个 session 会话，执行 sessionCreated 方法；当页面关闭 session 过期时，或者容器关闭销毁时，执行 sessionDestroyed 方法。

　　实现方式：直接实现 HttpSessionListener 接口：

public class MyHttpSessionListener implements HttpSessionListener{    public void sessionCreated(HttpSessionEvent arg0) {
    }    public void sessionDestroyed(HttpSessionEvent arg0) {
    }}

复制代码

　　ServletRequest 监控：对应监控 request 内置对象的创建和销毁。

　　当访问某个页面时，出发一个 request 请求，执行 requestInitialized 方法；当页面关闭时，执行 requestDestroyed 方法。

　　实现方式，直接实现 ServletRequestListener 接口：

public class MyServletRequestListener implements ServletRequestListener{    public void requestDestroyed(ServletRequestEvent arg0) {
    }    public void requestInitialized(ServletRequestEvent arg0) {
    }}

复制代码

2. 按照监听事件划分：

　　2.1 监听事件自身的创建和销毁：同上面的按对象划分。

　　2.2 监听属性的新增、删除和修改：

　　监听属性的新增、删除和修改也是划分成三种，分别针对于 ServletContext、HttpSession、ServletRequest 对象：

　　ServletContext，实现 ServletContextAttributeListener 接口：

　　通过调用 ServletContextAttribtueEvent 的 getName 方法可以得到属性的名称。

public class MyServletContextAttrListener implements ServletContextAttributeListener {	public void attributeAdded( ServletContextAttributeEvent hsbe )	{		System.out.println( "In servletContext added :name = " + hsbe.getName() );	}

	public void attributeRemoved( ServletContextAttributeEvent hsbe )	{		System.out.println( "In servletContext removed :name = " + hsbe.getName() );	}

	public void attributeReplaced( ServletContextAttributeEvent hsbe )	{		System.out.println( "In servletContext replaced :name = " + hsbe.getName() );	}}

复制代码

　　HttpSession，实现 HttpSessionAttributeListener 接口：

public class MyHttpSessionAttrListener implements HttpSessionAttributeListener {	public void attributeAdded( HttpSessionBindingEvent hsbe )	{		System.out.println( "In httpsession added:name = " + hsbe.getName() );	}

	public void attributeRemoved( HttpSessionBindingEvent hsbe )	{		System.out.println( "In httpsession removed:name = " + hsbe.getName() );	}

	public void attributeReplaced( HttpSessionBindingEvent hsbe )	{		System.out.println( "In httpsession replaced:name = " + hsbe.getName() );	}}

复制代码

　　ServletRequest，实现 ServletRequestAttributeListener 接口：

public class MyServletRequestAttrListener implements ServletRequestAttributeListener {	public void attributeAdded( ServletRequestAttributeEvent hsbe )	{		System.out.println( "In servletrequest added :name = " + hsbe.getName() );	}

	public void attributeRemoved( ServletRequestAttributeEvent hsbe )	{		System.out.println( "In servletrequest removed :name = " + hsbe.getName() );	}

	public void attributeReplaced( ServletRequestAttributeEvent hsbe )	{		System.out.println( "In servletrequest replaced :name = " + hsbe.getName() );	}}

复制代码

　　2.3 监听对象的状态：

　　针对某些 POJO 类，可以通过实现 HttpSessionBindingListener 接口，监听 POJO 类对象的事件。例如：

public class User implements HttpSessionBindingListener,Serializable{
    private String username;    private String password;
    public String getUsername() {        return username;    }
    public void setUsername(String username) {        this.username = username;    }
    public String getPassword() {        return password;    }
    public void setPassword(String password) {        this.password = password;    }
    public void valueBound(HttpSessionBindingEvent hsbe) {        System.out.println("valueBound name: "+hsbe.getName());    }
    public void valueUnbound(HttpSessionBindingEvent hsbe) {        System.out.println("valueUnbound name: "+hsbe.getName());    }
}

复制代码

　　Session 数据的钝化与活化：

　　由于 session 中保存大量访问网站相关的重要信息，因此过多的 session 数据就会服务器性能的下降，占用过多的内存。因此类似数据库对象的持久化，web 容器也会把不常使用的 session 数据持久化到本地文件或者数据中。这些都是有 web 容器自己完成，不需要用户设定。

　　不用的 session 数据序列化到本地文件中的过程，就是钝化；

　　当再次访问需要到该 session 的内容时，就会读取本地文件，再次放入内存中，这个过程就是活化。

　　类似的，只要实现 HttpSeesionActivationListener 接口就是实现钝化与活化事件的监听：

public class User implements HttpSessionBindingListener,HttpSessionActivationListener,Serializable{
    private String username;    private String password;
    public String getUsername() {        return username;    }
    public void setUsername(String username) {        this.username = username;    }
    public String getPassword() {        return password;    }
    public void setPassword(String password) {        this.password = password;    }
    public void valueBound(HttpSessionBindingEvent hsbe) {        System.out.println("valueBound name: "+hsbe.getName());    }
    public void valueUnbound(HttpSessionBindingEvent hsbe) {        System.out.println("valueUnbound name: "+hsbe.getName());    }
    public void sessionDidActivate(HttpSessionEvent hsbe) {        System.out.println("sessionDidActivate name: "+hsbe.getSource());    }
    public void sessionWillPassivate(HttpSessionEvent hsbe) {        System.out.println("sessionWillPassivate name: "+hsbe.getSource());    }
}

复制代码

三、Servlet 版本与 Tomcat 版本

　　首先看一下 Tomcat 官网给出的匹配：

　　如果版本不匹配，那么 tomcat 是不能发布该工程的，首先看一下版本不匹配时，会发生什么！

　　我试图创建一个 web 工程，并且选取了 Servlet3.0 版本：

　　然后我想要在 tomcat6 中发布，可以看到报错了！

　　JDK 版本不对....这是在平时开发如果对 Servlet 不熟悉的 web 新手，常犯的错误。

解决方法：

　　1 在创建时，直接发布到 Tomcat 容器中，此时 Servlet 仅仅会列出 Tomcat 支持的版本：

　　2 修改工程 Servlet 版本配置信息，文件为：工作目录\SessionExample.settings\org.eclipse.wst.common.project.facet.core.xml

<?xml version="1.0" encoding="UTF-8"?><faceted-project>  <runtime name="Apache Tomcat v6.0"/>  <fixed facet="java"/>  <fixed facet="wst.jsdt.web"/>  <fixed facet="jst.web"/>  <installed facet="java" version="1.7"/>  <installed facet="jst.web" version="2.5"/>  <installed facet="wst.jsdt.web" version="1.0"/></faceted-project>

复制代码