listener介绍
当Web 应用在Web 容器中运行时, Web 应用内部会不断地发生各种事件: 如Web 应用被启动、
Web 应用被停止,用户session 开始、用户session 结束、用户请求到达等, 通常来说,这些Web 事件
对开发者是透明的。
实际上, Servlet API 提供了大量监昕器来监昕 Web 应用的内部事件, 从而允许当 Web 内部事件发生时回调事件监昕器内的方法。
使用 Listener 只需要两个步骤。
1、定义 Listener 实现类。
2、通过注解或在 web.xml 文件中配置 Listerner。
1、实现Listener类
与 AWT 事件编程完全相似, 监听不同引向事件的监昕器也不相同。 常用的 Web 事件监昕器接门有如下几个。
》ServletContextListener:用于监昕 Web 应用的启动和关闭。
》ServletContextAttributeListener:用于监昕 ServletContext 范围( application )内属性的改变。
》ServletRequestListener:用于监昕用户请求。
》ServletRequestAttributeListener:用于监听 ServletRequest 范围 (request )内属性的改变。
》HttpSessionListener:用于监昕用户 session 的开始和结束。
》HttpSessionAttributeListener:用于监昕 HttpSession 范围 (session )内属性的改变。
下面先以 ServletContextListener 为例来介绍 Listener 的开发和使用, ServletContextListener 用于监听
Web 应用的启动和关闭。 该 Listener 类必须实现 ServletContextListener 接口, 该接口包含如下两个方法。
》contextlnitialized(ServletContextEvent see): 启动 Web 应用时, 系统调用 Listener 的该方法。
》contextDestroyed(ServletContextEvent see): 关闭 Web 应用时, 系统调用 Listener 的该方法。
通过上面的介绍不难看出, ServletContextListener 的作用有点类似于 load-on-startup Servlet,都可川于在 Web 应用启动时-, 回调方法来启动某些后台程序, 这些后台程序负责为系统运行提供支持。
package listener; import java.sql.Connection; import java.sql.DriverManager; import java.sql.SQLException; import javax.servlet.ServletContext; import javax.servlet.ServletContextEvent; import javax.servlet.ServletContextListener; import javax.servlet.annotation.WebListener; @WebListener public class GetConnListener implements ServletContextListener{ @Override public void contextDestroyed(ServletContextEvent sce) { ServletContext application = sce.getServletContext(); Connection conn = (Connection) application.getAttribute("conn"); if(conn != null) { try { conn.close(); } catch (SQLException e) { e.printStackTrace(); } } } @Override public void contextInitialized(ServletContextEvent sce) { try { ServletContext application = sce.getServletContext(); Class.forName("com.mysql.jdbc.Driver"); Connection conn = DriverManager.getConnection("jdbc:mysql://localhost:3306/hello?serverTimezone=UTC&useSSL=false", "root", "lidian1234"); application.setAttribute("conn", conn); System.out.println("数据库连接成功"); } catch (Exception e) { e.printStackTrace(); } } }
上面的程序中粗体字代码重写了 ServletContextListener 的 contextlnitialized()、 contextDestroyed()方法, 这两个方法分别在应用启动、 关闭时被触发。 上面 ServletContextListener 的两个方法分别实现获取数据库连接、 关闭数据库连接的功能, 这些功能都是为整个 Web 应用提供服务的。
程序中, contextlnitialized()方法中粗体字代码用于获取配置参数, 细心的读者可能已经发现 ServletContextListener 获取的是 Web 应用的配置参数, 而不是像 Serviet 和 Filter 获取本身的配置参数。这是因为配置 Listener 时十分简单, 只要简单地指定 Listener 实现类即可, 不能配置初始化参数。
2、配置Listener
配置 Listener 只要向 Web 应用注册 Listener 实现类即可,无须配置参数之类的东西,因此十分简单。 为 Web 应用配置 Listener 也有两种方式。
》使用@WebListener 修饰 Listener 实现类即可。
》在 web.xml 文档中使用<listener.. ./>元素进行配置。
使用@WebListener 时通常无须指定任何属性, 只要使用该注解修饰 Listener 实现类即可向 Web应用注册该监听器。
在 web.xml 中使用<listener.. ./>元素进行配置时只要配置如下子元素即可。
》 listener-class:指定 Listener 实现类。
<!-- 指定listener的实现类 --> <listener> <listener-class>listener.GetConnListener</listener-class> </listener>
3、使用ServletContextAttributeListener
Serv letContextA ttri buteListener 用于监昕ServletContext (application )范围内属性的变化, 实现该按
口的监昕器需要实现如下三个方法。
>>attributeAdded(ServletContextAttributeEvent event): 当程序把一个属性存入application 范围时触发该方法。
>>attributeRemoved(ServletContextAttributeEvent event): 当程序把一个属性从application 范围删除时触发该方法。
>>attributeReplaced(ServletContextAttributeEvent event): 当程序替换application 范围内的属性时将触发该方法。
下面是一个监听ServletContext范围内属性改变的Listener 。
package listener; import javax.servlet.ServletContext; import javax.servlet.ServletContextAttributeEvent; import javax.servlet.ServletContextAttributeListener; import javax.servlet.annotation.WebListener; @WebListener public class MyServletContextAttributeListener implements ServletContextAttributeListener{ @Override public void attributeAdded(ServletContextAttributeEvent scab) { ServletContext application = scab.getServletContext(); String name = scab.getName(); Object value = scab.getValue(); System.out.println(application+"范围内添加了name:"+name+",value:"+value); } @Override public void attributeRemoved(ServletContextAttributeEvent scab) { ServletContext application = scab.getServletContext(); String name = scab.getName(); Object value = scab.getValue(); System.out.println(application+"范围内的name:"+name+",value:"+value+"被删除了"); } @Override public void attributeReplaced(ServletContextAttributeEvent scab) { ServletContext application = scab.getServletContext(); String name = scab.getName(); Object value = scab.getValue(); System.out.println(application+"范围内的name:"+name+",value:"+value+"被更改了"); } }
上面的 ServletContextAttributeListener 使用了@WebListener 注解修饰,这就是向 Web 应用中注册了
该 Listener,该 Listener 实现了 attributeAdded、 attributeRemoved、 attributeReplaced 方法,因此当 application
范围内的属性被添加、 删除、 替换时, 这些对应的监昕器方法将会被触发。
4、使用 ServletRequestlistener 和 ServletRequestAttributelistener
ServletRequestListener 用于监昕用户请求的到达, 实现该接口的监昕器需要实现如下两个方法。
>> requestlnitialized(ServletRequestEvent sre): 用户请求到达、被初始化时触发该方法。
>> requestDestroyed(ServletRequestEvent sre): 用户请求结束、被销毁时触发该方法。
ServletRequestAttributeListener 则用于监昕ServletRequest (request )范围内属性的变化, 实现该接
口的监听器需要实现attributeAdded()、attributeRemoved()、attributeReplaced()三个方法。由此可见,
ServletRequestAttributeListener 与ServletContextAttributeListener 的作用相似, 都用于监昕属性的改变,
只是ServI etRequestA ttri buteListener 监昕request 范围内属性的改变, 而ServletContextAttributeListener
监听的是application范围内属性的改变。
5、使用HttpSessionListener和HttpSessionAttributelistener
HttpSessionListener 用于监昕用户session 的创建和销毁, 实现该接口的监昕器需要实现如下两个
方法。
》sessionCreated(HttpSessionEvent se): 用户与服务器的会话开始、创建时触发该方法。
》sessionDestroyed(HttpSessionEvent se): 用户与服务器的会话断开、销毁日才触发该方法。
HttpSessionAttributeListener 则用于监昕HttpSession (session )范围内属性的变化, 实现该接口的;监听器
需要实现attributeAdded()、attributeRemoved()、attributeReplaced()三个方法。由此可见,
HttpSessionAttributeListener 与ServletContextAttributeListener 的作用相似, 都用于监昕属性的改变,
是HttpSessionAttributeListener 监昕session 范围内属性的改变,而ServletContextAttributeListener 监昕的
是application 范围内属性的改变。
实现HttpSessionListener 接口的监昕器可以监昕每个用户会话的开始和断开, 因此应用可以通过该
监昕器监昕系统的在线用户。