JavaWeb——监听器

监听器简介

　　监听器是指专门用于在其他对象身上发生的事件或者状态改变进行监听和相应处理的对象，当被监听的对象发生变化时立即采取相应的行动。

　　例如我们要实现统计一个网站的在线人数，就可以在Web应用应用程序服务器上设置监听器用来监听session对象——设置一个全局变量，session创建的时候该变量加1，session销毁的时候该变量减1.（这个变量其实就是用户在线人数）。

　　Web监听器是Servlet规范定义的特殊类，可以监听客户端的请求和服务端的操作。监听的对象有：ServletContext、HttpSession、ServletRequest分别对应JSP9大内置对象中的application、session和request。用于监听ServletContext、HttpSession、ServletRequest等域对象的创建和销毁事件，监听域对象属性发生修改的事件。监听器对象可以在事件发生前、发生后做一些必要的处理。

监听器的主要用途

1. 统计在线人数和在线用户；
2. 系统启动时加载初始化信息；
3. 统计网站访问量；
4. 和Spring结合。

监听器的实现

1. 创建一个类实现监听器接口（ServletRequestListener、ServletContextListener、HttpSessionListener）；
2. 在web.xml中注册该监听器（配置非常简单只需要在web.xml中指定监听器所在的类名即可）。见如下：

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

监听器的启动顺序：

　　在一个web.xml中可以注册多个Servlet监听器，监听器的加载顺序是按照web.xml文件中的顺序加载的。

　　如果我们在web.xml文件中同时配置了监听器、过滤器和Servlet，那么它们的优先级是：

监听器的分类

　　按照监听的对象，可以将监听器划分为如下：

　　按照监听的事件可以划分为以下3种：

一、域对象自身的创建和销毁的监听器

　　1.ServletContextListener

　　　　该监听器中有2个方法（两个方法中都有ServletContextEvent参数。可以通过它获得当前应用的上下文对象ServletContext）：

public void contextInitialized(ServletContextEvent sce) // ServletContext创建时调用
public void contextDestroyed(ServletContextEvent sce)   // ServletContext销毁时调用

　　这个监听器的主要用途是做一些定时器、加载一些全局属性对象、创建全局的数据库连接、加载一些缓存信息。

package listener;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

public class FirstListener implements ServletContextListener {

    public void contextInitialized(ServletContextEvent servletContextEvent) {

        String initParam = servletContextEvent.getServletContext().getInitParameter("initParam");
        // 可以在这里通过Servlet的setAttribute（）方法设置全局的属性对象，从其他地方可以获取到这个属性对象
        servletContextEvent.getServletContext().setAttribute("name", "object");
        System.out.println("===========contextInitialized,initParam = " + initParam);
        
    }
    
    public void contextDestroyed(ServletContextEvent servletContextEvent) {
        System.out.println("=================contextDestroyed================");
        // 可以在这里关闭数据库连接
    }

}

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" 
    xmlns="http://java.sun.com/xml/ns/javaee" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
    http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
  <display-name></display-name>    
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
  
      <!-- 配置监听器 -->
    <listener>
        <listener-class>listener.FirstListener</listener-class>
    </listener>
    
    <!-- Servlet的初始化参数 -->
    <context-param>
        <param-name>initParam</param-name>
        <param-value>123456</param-value>
    </context-param>
    
</web-app>

　　将项目部署到Tomcat，运行：

HttpSessionListener

　　该监听器的主要作用是统计在线人数、记录访问日志【在后台统计访问时间、IP信息做一些统计数据】

package listener;

import java.util.Date;

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

public class MyHttpSessionListener implements HttpSessionListener {

    public void sessionCreated(HttpSessionEvent httpSessionEvent) {
        System.out.println("====================================");
        System.out.println("session创建于" + new Date());
    }

    public void sessionDestroyed(HttpSessionEvent httpSessionEvent) {
        System.out.println("====================================");
        System.out.println("session销毁于" + new Date());
    }

}

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" 
    xmlns="http://java.sun.com/xml/ns/javaee" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
    http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
  <display-name></display-name>    
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>

    <!-- 注册监听器 -->
    <listener>
        <listener-class>listener.MyHttpSessionListener</listener-class>
    </listener>
    <!-- 配置session的超时为1min -->
    <session-config>
        <session-timeout>1</session-timeout>
    </session-config>

</web-app>

　　

　　3.ServletRequestListener

　　　　该监听器的主要作用是：读取参数、记录访问历史。

package listener;

import java.util.Date;

import javax.servlet.ServletRequestEvent;
import javax.servlet.ServletRequestListener;

public class MyServletRequestListener implements ServletRequestListener {

    public void requestInitialized(ServletRequestEvent servletRequestEvent) {
        System.out.println("=================================");
        System.out.println("request创建于" + new Date());
        
        String name = servletRequestEvent.getServletRequest().getParameter("name");
        System.out.println("从URL中获得参数name,name = " + name);
    }
    
    public void requestDestroyed(ServletRequestEvent servletRequestEvent) {
        System.out.println("=================================");
        System.out.println("request销毁于" + new Date());

    }

}

　　　　在web.xml中配置以上监听器，运行程序：

二、属性的增加或者删除的事件监听器

　　有3种，分别是ServletContextAttributeListener、HttpSessionAttributeListener、ServletRequestAttributeListener接口，在各个接口中都有attributeAdded（）、attributeRemoved（）和attributeReplaced（）这3个方法。

　　分别创建3个类：

MyServletContextAttributeListener 继承自 ServletContextAttributeListener，
MyHttpSessionAttributeListener 继承自 HttpSessionAttributeListener，
MyServletRequestAttributeListener 继承自 ServletRequestAttributeListener。

　　并在web.xml中配置以上的3个监听器

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" 
    xmlns="http://java.sun.com/xml/ns/javaee" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
    http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
  <display-name></display-name>    
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>

    <listener>
        <listener-class>listener.MyServletRequestAttributeListener</listener-class>
    </listener>
    <listener>
        <listener-class>listener.MyHttpSessionAttributeListener</listener-class>
    </listener>
    <listener>
        <listener-class>listener.MyServletContextAttributeListener</listener-class>
    </listener> 
</web-app>

package listener;

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

public class MyServletContextAttributeListener implements
        ServletContextAttributeListener {

    public void attributeAdded(ServletContextAttributeEvent servletContextAttributeEvent) {
        System.out.println("ServletContext_attributeAdded:" + servletContextAttributeEvent.getName());
    }

    public void attributeRemoved(ServletContextAttributeEvent servletContextAttributeEvent) {
        System.out.println("ServletContext_attributeRemoved:" + servletContextAttributeEvent.getName());
    }

    public void attributeReplaced(ServletContextAttributeEvent servletContextAttributeEvent) {
        System.out.println("ServletContext_attributeReplaced:" + servletContextAttributeEvent.getName());
    }

}

package listener;

import javax.servlet.ServletRequestAttributeEvent;
import javax.servlet.ServletRequestAttributeListener;

public class MyServletRequestAttributeListener implements
        ServletRequestAttributeListener {

    public void attributeAdded(ServletRequestAttributeEvent servletRequestAttributeEvent) {
        System.out.println("ServletRequest_attributeAdded:" + servletRequestAttributeEvent.getName());
    }

    public void attributeRemoved(ServletRequestAttributeEvent servletRequestAttributeEvent) {
        System.out.println("ServletRequest_attributeRemoved:"+ servletRequestAttributeEvent.getName());
    }

    public void attributeReplaced(ServletRequestAttributeEvent servletRequestAttributeEvent) {
        System.out.println("ServletRequest_attributeReplaced:"+ servletRequestAttributeEvent.getName());
    }

}

package listener;

import javax.servlet.http.HttpSessionAttributeListener;
import javax.servlet.http.HttpSessionBindingEvent;

public class MyHttpSessionAttributeListener implements
        HttpSessionAttributeListener {

    public void attributeAdded(HttpSessionBindingEvent httpSessionBindingEvent) {
        System.out.println("HttpSession_attributeAdded:" + httpSessionBindingEvent.getName());
    }

    public void attributeRemoved(HttpSessionBindingEvent httpSessionBindingEvent) {
        System.out.println("HttpSession_attributeRemoved:" + httpSessionBindingEvent.getName());
    }

    public void attributeReplaced(HttpSessionBindingEvent httpSessionBindingEvent) {
        System.out.println("HttpSession_attributeReplaced:" + httpSessionBindingEvent.getName());
    }

}

<%@ page language="java" import="java.util.*" contentType="text/html; charset=utf-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <base href="<%=basePath%>">
    <title>主页</title>
  </head>
  
  <body>
    <h1>这是主页</h1>
    <a href="init.jsp">跳转到init.jsp分别向ServletRequest、HttpSession、ServletContext中设置值</a><br />
    <a href="destroy.jsp">跳转到destroy.jsp销毁向ServletRequest、HttpSession、ServletContext中设置的值</a>
  </body>
</html>

<%@ page language="java" import="java.util.*" contentType="text/html; charset=utf-8"%>
<%
    String path = request.getContextPath();
    String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
    
    // 初始化值【添加属性】，监听器将会执行各自的attributeAdded方法
    request.setAttribute("requestName", "requestValue");
    request.getSession().setAttribute("sessionName", "sessionValue");
    request.getSession().getServletContext().setAttribute("contextName", "contextValue");
    
%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <base href="<%=basePath%>">
    <title>该页面用于初始化值</title>
  </head>
  
  <body>
    <h1>这是初始化值的界面！</h1>
    <a href="init.jsp">跳转到init.jsp分别向ServletRequest、HttpSession、ServletContext中设置值</a><br />
    <a href="destroy.jsp">跳转到destroy.jsp销毁向ServletRequest、HttpSession、ServletContext中设置的值</a>
  </body>
</html>

<%@ page language="java" import="java.util.*" contentType="text/html; charset=utf-8"%>
<%
    String path = request.getContextPath();
    String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
    
    // 删除属性，监听器将会执行各自的attributeRemoved方法
    request.removeAttribute("requestName");
    request.getSession().removeAttribute("sessionName");
    request.getSession().getServletContext().removeAttribute("contextName");
%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <base href="<%=basePath%>">
    <title>销毁界面</title>
  </head>
  
  <body>
    <h1>销毁界面</h1>
    <a href="init.jsp">跳转到init.jsp分别向ServletRequest、HttpSession、ServletContext中设置值</a><br />
    <a href="destroy.jsp">跳转到destroy.jsp销毁向ServletRequest、HttpSession、ServletContext中设置的值</a>
  </body>
</html>

三、绑定到HttpSession域中的对象的状态的事件监听器

　HttpSession的状态如下图所示：

session的钝化机制

　　一般情况下session是保存在服务器内存的，服务器为每一个在线用户保存session对象，当在线用户很多时，session内存的开销将是非常巨大的——直接导致web服务器性能的降低。session的钝化机制就是将不经常使用的session对象序列化存储到文件系统或者是数据库中。需要使用这些session的时候进行反序列化到内存中。整个过程由服务器自动完成。

　　Tomcat中存在2种session钝化管理器。session钝化机制由SessionManger管理

org.apache.catalina.session.StandarManger

1. 当Tomcat服务器被关闭或重启时，Tomcat服务器会将当前内存中的Session对象钝化到服务器的文件系统中；
2. Web应用程序被重新加载（修改了web.xml）时，内存中的Session对象也会被钝化到服务器的文件系统中；
3. 可以配置主流内存的Session对象数目，将不常使用的session对象保存到文件系统或者数据库，用的时候重新加载。

　　钝化后的文件的位置：Tomcat安装路径/work/Catalina/hostname/applicationname/SESSIONS.ser

　　默认情况下，Tomcat提供两个钝化驱动类：

org.apache.Catalina.FileStore和org.apache.Catalina.JDBCStore

　　在Servlet规范中提供了两个接口HttpSessionBindingListener和HttpSessionActivationListener分别对应绑定-解除绑定方法和钝化-活化方法。这两个监听器不需要在web.xml中注册。

　　HttpSessionBandingListener接口：

　　创建一个User实体类（普通的javabean）实现HttpSessionBandingListener接口。

package entity;

import javax.servlet.http.HttpSessionBindingEvent;
import javax.servlet.http.HttpSessionBindingListener;

public class User implements HttpSessionBindingListener {

    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 httpSessionBindingEvent) {
        System.out.println("绑定，属性名："+ httpSessionBindingEvent.getName());

    }

    public void valueUnbound(HttpSessionBindingEvent httpSessionBindingEvent) {
        System.out.println("解除绑定，属性名："+ httpSessionBindingEvent.getName());

    }

}

　　在init.jsp中向session中设置对象：

<% request.getSession().setAttribute("currentUser", new User()); %>

　　在destroy.jsp中销毁设置的对象：

<%    request.getSession().removeAttribute("currentUser"); %>

　　运行结果：

　　接下来我们继续为以上的User类实现HttpSessionActivationListener接口和Serializable接口。

/** 活化 */
public void sessionDidActivate(HttpSessionEvent httpSessionEvent) {
    System.out.println("活化：" + httpSessionEvent.getSource());
    
}

/** 钝化 */
public void sessionWillPassivate(HttpSessionEvent httpSessionEvent){
    System.out.println("钝化：" + httpSessionEvent.getSource());
    
}

　　运行程序，可以发现向session中设置了User对象，在session没有过期的时候，服务器重启的时候会执行钝化方法，将当前的session保存在项目目录下的SESSIONS.ser。当服务器重启的时候会执行激活方法，将序列化为文件的session读入内存，并删除SESSIONS.ser。即：服务器重启不会丢失用户数据。

Servlet 3.0中监听器的应用

　　使用注解将监听器类声明为一个监听器，不需要在web.xml中注册监听器，但是这样做有一个弊端：无法设置监听器的顺序。@WebListener Annotation只有一个value属性【String类型】——用于描述该监听器。

　　见如下代码：

package listener;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
@WebListener(value = "这是Servlet 3.0 的监听器")
public class MyServletContextListener implements ServletContextListener {

    @Override
    public void contextDestroyed(ServletContextEvent servletContextEvent) {
        System.out.println("============== contextDestroyed ============");

    }

    @Override
    public void contextInitialized(ServletContextEvent servletContextEvent) {
        System.out.println("============== contextInitialized ============");

    }

}

　　运行结果：

实战项目——统计在线用户及人数：

　　该项目使用J2EE6.0创建。

　　1. 创建一个类继承自HttpSessionListenr。并加上@WebListener Annotation。

package listener;

import javax.servlet.annotation.WebListener;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;
@WebListener
public class MyHttpSessionListener implements HttpSessionListener {

    private static int userNumber = 0; // 用户在线人数
    
    @Override
    public void sessionCreated(HttpSessionEvent httpSessionEvent) {
        // 每创建一个session，在线人数加1
        userNumber++;
        // 把在线人数放入上下文环境中，便于在整个web应用中都可以获得在线人数
        httpSessionEvent.getSession().getServletContext().setAttribute("userNumber", userNumber);
    }

    @Override
    public void sessionDestroyed(HttpSessionEvent httpSessionEvent) {
        userNumber--;
        httpSessionEvent.getSession().getServletContext().setAttribute("userNumber", userNumber);
    }

}

　　2.在index.jsp中显示在线人数：

当前在线人数：${userNumber}

　　以上程序就完成了一个简单的在线人数的统计。session并不能获取用户的IP地址，request对象可以获取ip地址。如果我们想要看到各个访客的来源IP，就必须做以下改进：

package listener;

import java.util.ArrayList;

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

import util.SessionUtil;

import entity.User;
@WebListener
public class MyHttpSessionListener implements HttpSessionListener {

    private static int userNumber = 0; // 用户在线人数
    
    @Override
    public void sessionCreated(HttpSessionEvent httpSessionEvent) {
        // 每创建一个session，在线人数加1
        userNumber++;
        // 把在线人数放入上下文环境中，便于在整个web应用中都可以获得在线人数
        httpSessionEvent.getSession().getServletContext().setAttribute("userNumber", userNumber);
    }

    @Override
    public void sessionDestroyed(HttpSessionEvent httpSessionEvent) {
        userNumber--;
        httpSessionEvent.getSession().getServletContext().setAttribute("userNumber", userNumber);
        
        ArrayList<User>userList = null;
        
        userList = (ArrayList<User>) httpSessionEvent.getSession().getServletContext().getAttribute("userList");//在线用户list
        User user = SessionUtil.getUserBySessionId(userList, httpSessionEvent.getSession().getId());
        if (user!=null) {
            userList.remove(user);//在session销毁时从在线的用户列表中移除该用户
        }
    }

}

package listener;

import java.util.ArrayList;
import java.util.Date;

import javax.servlet.ServletRequestEvent;
import javax.servlet.ServletRequestListener;
import javax.servlet.annotation.WebListener;
import javax.servlet.http.HttpServletRequest;

import util.SessionUtil;

import entity.User;
@WebListener
public class MyServletRequestListener implements ServletRequestListener {

    private ArrayList<User>userList; //在线用户列表
    
    @Override
    public void requestInitialized(ServletRequestEvent servletRequestEvent) {
        
        userList = (ArrayList<User>) servletRequestEvent.getServletContext().getAttribute("userList");
        if (userList==null) {
            userList = new ArrayList<User>();//首次用户请求的时候创建一个新的在线用户列表
        }
        
        HttpServletRequest request = (HttpServletRequest) servletRequestEvent.getServletRequest();
        String sessionId = request.getSession().getId();
        
        // 如果当前用户没有在在线用户列表中，将其加入
        if (SessionUtil.getUserBySessionId(userList, sessionId)==null) {
            User user = new User();
            user.setSessionId(sessionId);
            user.setIp(request.getRemoteAddr());
            user.setFirstAccseeTime(new Date());
            userList.add(user);
        }
        servletRequestEvent.getServletContext().setAttribute("userList", userList);//将在线用户的列表保存到应用的上下文对象
    }
    
    @Override
    public void requestDestroyed(ServletRequestEvent servletRequestEvent) {

    }

}

package util;

import java.util.ArrayList;

import entity.User;

public class SessionUtil {
    
    /** 根据用户的sessionId从在线用户列表中找出用户 */
    public static User getUserBySessionId(ArrayList<User>userList,String sessionId){
        
        for (User user : userList) {
            if (user.getSessionId().equals(sessionId)) {
                return user;
            }
        }
        return null;
    }
    
}

package entity;

import java.util.Date;

public class User {

    private String sessionId; // sessionID
    private String ip; // IP
    private Date firstAccseeTime;// 第一次访问时间

    public String getSessionId() {
        return sessionId;
    }

    public void setSessionId(String sessionId) {
        this.sessionId = sessionId;
    }

    public String getIp() {
        return ip;
    }

    public void setIp(String ip) {
        this.ip = ip;
    }

    public Date getFirstAccseeTime() {
        return firstAccseeTime;
    }

    public void setFirstAccseeTime(Date firstAccseeTime) {
        this.firstAccseeTime = firstAccseeTime;
    }

}

<%@page import="entity.User"%>
<%@ page language="java" import="java.util.*" contentType="text/html; charset=utf-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <base href="<%=basePath%>">
    <title>主页</title>
  </head>
  
  <body>
    当前在线人数：${userNumber}<br />
    <%
        ArrayList<User>userList =(ArrayList<User>) request.getServletContext().getAttribute("userList");
  
        if(userList!=null){
            for(User user:userList){
    %>
                IP:<%=user.getIp() %>，sessionID:<%=user.getSessionId() %>，第一次访问的时间：<%=user.getFirstAccseeTime() %><br />
    <%                
            }
        }
    %>
  </body>
</html>

　　项目地址：https://git.oschina.net/gaopengfei/CountTheOnlineUser.git