Servlet 监听

servlet监听器

文章分类:Java编程

概述：

Servlet监听器用于监听一些重要事件的发生，监听器对象可以在事情发生前、发生后可以做一些必要的处理。

接口：

目前Servlet2.4和JSP2.0总共有8个监听器接口和6个Event类，其中HttpSessionAttributeListener与

HttpSessionBindingListener 皆使用HttpSessionBindingEvent;HttpSessionListener和 HttpSessionActivationListener则都使用HttpSessionEvent;其余Listener对应的Event如下所 示：

Listener接口

Event类

ServletContextListener

ServletContextEvent

ServletContextAttributeListener

ServletContextAttributeEvent

HttpSessionListener

HttpSessionEvent

HttpSessionActivationListener

HttpSessionAttributeListener

HttpSessionBindingEvent

HttpSessionBindingListener

ServletRequestListener

ServletRequestEvent

ServletRequestAttributeListener

ServletRequestAttributeEvent

分别介绍：

一 ServletContext相关监听接口

补充知识：

通过ServletContext 的实例可以存取应用程序的全局对象以及初始化阶段的变量。

在JSP文件中，application 是 ServletContext 的实例，由JSP容器默认创建。Servlet 中调用 getServletContext()方法得到 ServletContext 的实例。

注意：

全局对象即Application范围对象，初始化阶段的变量指在web.xml中，经由<context-param>元素所设定的变量，它的范围也是Application范围，例如：

<context-param>

<param-name>Name</param-name>

<param-value>browser</param-value>

</context-param>

当容器启动时，会建立一个Application范围的对象，若要在JSP网页中取得此变量时：

String name = (String)application.getInitParameter("Name");

或者使用EL时：

${initPara.name}

若是在Servlet中，取得Name的值方法：

String name = (String)ServletContext.getInitParameter("Name");

1.ServletContextListener：

用于监听WEB 应用启动和销毁的事件，监听器类需要实现javax.servlet.ServletContextListener 接口。

ServletContextListener 是 ServletContext 的监听者，如果 ServletContext 发生变化，如服务器启动时 ServletContext 被创建，服务器关闭时 ServletContext 将要被销毁。

ServletContextListener接口的方法：

void contextInitialized(ServletContextEvent sce)

通知正在接受的对象，应用程序已经被加载及初始化。

void contextDestroyed(ServletContextEvent sce)

通知正在接受的对象，应用程序已经被载出。

ServletContextEvent中的方法：

ServletContext getServletContext()

取得ServletContext对象

2.ServletContextAttributeListener：用于监听WEB应用属性改变的事件，包括：增加属性、删除属性、修改属性，监听器类需要实现javax.servlet.ServletContextAttributeListener接口。

ServletContextAttributeListener接口方法：

void attributeAdded(ServletContextAttributeEvent scab)

若

有对象加入Application的范围，通知正在收听的对象

void attributeRemoved(ServletContextAttributeEvent scab)

若有对象从Application的范围移除，通知正在收听的对象

void attributeReplaced(ServletContextAttributeEvent scab)

若在Application的范围中，有对象取代另一个对象时，通知正在收听的对象

ServletContextAttributeEvent中的方法：

java.lang.String getName()

回传属性的名称

java.lang.Object getValue()

回传属性的值

二、HttpSession相关监听接口

1.HttpSessionBindingListener接口

注意：HttpSessionBindingListener接口是唯一不需要再web.xml中设定的Listener

当我们的类实现了HttpSessionBindingListener接口后，只要对象加入Session范围 （即调用HttpSession对象的setAttribute方法的时候）或从Session范围中移出（即调用HttpSession对象的 removeAttribute方法的时候或Session Time out的时候）时，容器分别会自动调用下列两个方法：

void valueBound(HttpSessionBindingEvent event)

void valueUnbound(HttpSessionBindingEvent event)

思考：如何实现记录网站的客户登录日志， 统计在线人数？

2.HttpSessionAttributeListener接口

HttpSessionAttributeListener监听HttpSession中的属性的操作。

当 在Session增加一个属性时，激发attributeAdded(HttpSessionBindingEvent se) 方法；当在Session删除一个属性时，激发attributeRemoved(HttpSessionBindingEvent se)方法；当在Session属性被重新设置时，激发attributeReplaced(HttpSessionBindingEvent se) 方法。这和ServletContextAttributeListener比较类似。

3.HttpSessionListener接口

HttpSessionListener监听 HttpSession的操作。当创建一个Session时，激发session Created(HttpSessionEvent se)方法；当销毁一个Session时，激发sessionDestroyed (HttpSessionEvent se)方法。

4.HttpSessionActivationListener接口

主要用于同一个Session转移至不同的JVM的情形。

请注意HttpSessionAttributeListener与HttpSessionBindingListener的区别：

１．前者是需要在web.xml中进行描述的，后者不需要。

２．前者是在任何session的属生变化时都会触发执行其方法中的代码，而后者只是在实现它的对象被绑定到会话属性或被从会话属生中解除绑定时，才会触发执行那个对象的valueBound和valueUnboundy这两个方法的代码。比如说有两个对象A和B都实现了HttpSessionBindingListener接口,当Ａ被绑定到会话属性中时，只是Ａ的valueBound()方法被触发执行。

三、ServletRequest监听接口

1.ServletRequestListener接口

和ServletContextListener接口类似的，这里由ServletContext改为ServletRequest

2.ServletRequestAttributeListener接口

和ServletContextListener接口类似的，这里由ServletContext改为ServletRequest

下面说明如何在web.xml中布署事件监听器以实现对事件的处理，格式

如下：

<listener>

<listener-class>

fey.servlet.listener.CustomServletContextListener

</listener-class >

</listener>

其中fey.servlet.listener.CustomServletContextListener是实现上述各事件监听器接口的类名。当然，你需要将这些类放入Web容器的Web应用的classes或lib目录下以让Web容器可以找到。

另外说明一点，一个类可以一个或多个监听器接口。

有的listener可用于统计网站在线人数及访问量。 如下：

服务器启动时（实现ServletContextListener监听器contextInitialized方法），读取数据库，并将其用一个计数变量保存在application范围内

session创建时（实现HttpSessionListener监听器sessionCreated方法），读取计数变量加1并重新保存

服务器关闭时（实现ServletContextListener监听器contextDestroyed方法），更新数据库

简例一

监听用户上线与退出，显示在线用户

1、登陆页面 Login.jsp

<%@page pageEncoding="gb2312" contentType="text/html; charset=gb2312" %>

<%

session=request.getSession(false);

if(session!=null)session.invalidate();

%>

<html>

<head><title></title></head>

<body>

<form action="isOnline.jsp" method="post">

用户名：<input type="text" name="uName"/>

<input type="submit" value="上线">

</form>

</body>

</html>

2、控制页面（只是为了说明监听器问题，所以简单了点...） isOnline.jsp

<%@page pageEncoding="gb2312" contentType="text/html; charset=gb2312" %>

<html>

<head><title></title></head>

<body>

<%

session=request.getSession();

session.setAttribute("userName",request.getParameter("uName"));

response.sendRedirect("showOnline.jsp");

%>

</body>

</html>

3、显示页面 showOnline.jsp

<%@page pageEncoding="gb2312" contentType="text/html; charset=gb2312" import="java.util.ArrayList" %>

<html>

<head><title></title></head>

<body>

<%

ArrayList showList=(ArrayList)(getServletContext().getAttribute("list"));

out.print("在线人数 "+showList.size()+"<br>");

for(int i=0;i<showList.size();i++){

out.print(showList.get(i)+"在线"+"<br>");

}

%>

<br>

<a href="Login.jsp">退出</a>

</body>

</html>

4、配置页面 web.xml

<?xml version="1.0" encoding="gb2312"?>

<!DOCTYPE web-app

PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"

"http://java.sun.com/dtd/web-app_2_3.dtd">

<web-app>

<listener>

<listener-class>org.xiosu.listener.onlineListener</listener-class>

</listener>

</web-app>

5、监听器 onlineListener.java

package org.xiosu.listener;

import java.util.ArrayList;

import javax.servlet.ServletContext;

import javax.servlet.http.HttpSessionAttributeListener;

import javax.servlet.http.HttpSessionBindingEvent;

import javax.servlet.http.HttpSessionEvent;

import javax.servlet.http.HttpSessionListener;

public class onlineListener implements HttpSessionL

istener,

HttpSessionAttributeListener {

// 参数

ServletContext sc;

ArrayList list = new ArrayList();

// 新建一个session时触发此操作

public void sessionCreated(HttpSessionEvent se) {

sc=se.getSession().getServletContext();

System.out.println("新建一个session");

}

// 销毁一个session时触发此操作

public void sessionDestroyed(HttpSessionEvent se) {

System.out.println("销毁一个session");

if (!list.isEmpty()) {

list.remove((String) se.getSession().getAttribute("userName"));

sc.setAttribute("list", list);

}

}

// 在session中添加对象时触发此操作，在list中添加一个对象

public void attributeAdded(HttpSessionBindingEvent sbe) {

list.add((String) sbe.getValue());

sc.setAttribute("list", list);

}

// 修改、删除session中添加对象时触发此操作

public void attributeRemoved(HttpSessionBindingEvent arg0) {

}

public void attributeReplaced(HttpSessionBindingEvent arg0) {

}

}

在Web开发中关于监听器的应用

首先，也要在web.xml配置文件中进行声明：

在web.xml文件中的声明如下：(声明片断) 要放在filter过滤器声明和filter-mapping声明后面

<listener>

<listener-class>markchen.web.listener.MySessionListener</listener-class>

</listener>

<listener>

<listener-class>markchen.web.listener.MyServletContextListener</listener-class>

</listener>

//这两个java类的内容都和简单，仅仅是为了演示说明而已

//MySessionListener.java文件的内容如下

//Web应用程序中会话的生命周期监听器实现

package markchen.web.listener;

import javax.servlet.http.HttpSession;

import javax.servlet.http.HttpSessionEvent;

import javax.servlet.http.HttpSessionListener;

public class MySessionListener implements HttpSessionListener {

//在会话一创建时该方法被调用,可以在此处编写自己需要做特殊处理的程序代码

public void sessionCreated(HttpSessionEvent event) {

HttpSession session = event.getSession();

String sessionId=session.getId();

System.out.println("Session::::::"+sessionId+"******Created******");

}

//在会话即将销毁时该方法被调用,可以在此处编写自己需要做特殊处理的程序代码

public void sessionDestroyed(HttpSessionEvent event) {

HttpSession session = event.getSession();

String sessionId=session.getId();

System.out.println("Session::::::"+sessionId+"******Destroyed******");

}

}

注意：在sessionDestroyed()方法中一定不要再调用session.invalidate()方法了

因为每调用一次session.invalidate()方法都会触发sessionDestroyed()方法的调用

进而形成死循环，最终使Web应用程序意外终止

//MyServletContextListener.java

//Web应用程序的生命周期监听器实现

package markchen.web.listener;

import javax.servlet.ServletContextEvent;

import javax.servlet.ServletContextListener;

public class MyServletContextListener implements ServletContextListener {

//在Web应用程序初始化后该方法被调用

public void contextInitialized(ServletContextEvent event) {

System.out.println("******Application started******");

}

//在Web应用程序销毁时该方法被调用

public void contextDestroyed(ServletContextEvent event) {

System.out.println("******Application ended******");

}

}