java web Listener的简单使用案例

Posted 2020-09-21 耗子的烂代码

1、web.xml的配置

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 3     xmlns="http://java.sun.com/xml/ns/javaee" 
 4     xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" 
 5     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0">
 6     <display-name>testServletListener</display-name>
 7     <listener>
 8         <listener-class>test_servlet_package.MyRequestListener</listener-class>
 9     </listener>
10     <listener>
11         <listener-class>test_servlet_package.MySessionListener</listener-class>
12     </listener>
13     <listener>
14         <listener-class>test_servlet_package.MyServletContextListener</listener-class>
15     </listener>
16     <!-- 配置欢迎界面 -->
17     <welcome-file-list>
18         <welcome-file>index.jsp</welcome-file>
19     </welcome-file-list>
20 </web-app>

2、RequestListener

 1 package test_servlet_package;
 2 import java.io.FileOutputStream;
 3 import java.io.PrintWriter;
 4 import javax.servlet.ServletRequest;
 5 import javax.servlet.ServletRequestAttributeEvent;
 6 import javax.servlet.ServletRequestAttributeListener;
 7 import javax.servlet.ServletRequestEvent;
 8 import javax.servlet.ServletRequestListener;
 9 /*
10 Servlet事件监听器
11 在Servlet技术中已经定义了一些事件，
12 并且我们可以针对这些事件来编写相关的事件监听器，从而对事件作出相应处理。
13 Servlet事件主要有3类：Servlet上下文事件、会话事件与请求事件
14 下面具体讲解这3类事件的监听器实现。
15 
16 1．对Servlet上下文进行监听
17 可以监听ServletContext对象的创建和删除以及属性的添加、删除和修改等操作。该监听器需要使用到如下两个接口类：
18     ● ServletContextAttributeListener：监听对ServletContext属性的操作，如增加、删除、修改操作。
19     ● ServletContextListener：监听ServletContext，
20         当创建ServletContext时，激发contextInitialized (ServletContextEvent sce)方法。
21         当销毁ServletContext时，激发contextDestroyed(ServletContext- Event sce)方法。
22 
23 2．监听Http会话
24 可以监听Http会话活动情况、Http会话中属性设置情况，也可以监听Http会话的active、paasivate情况等。该监听器需要使用到如下多个接口类：
25   ● HttpSessionListener：监听HttpSession的操作。
26         当创建一个Session时，激发session Created (SessionEvent se)方法；
27         当销毁一个Session时，激发sessionDestroyed (HttpSessionEvent se)方法。
28   ● HttpSessionActivationListener：用于监听Http会话active、passivate情况。
29   ● HttpSessionAttributeListener：监听HttpSession中属性的操作。
30         当在Session增加一个属性时，激发attributeAdded(HttpSessionBindingEvent se) 方法；
31         当在Session删除一个属性时，激发attributeRemoved(HttpSessionBindingEvent se)方法；
32         当在Session属性被重新设置时，激发attributeReplaced(HttpSessionBindingEvent se) 方法。
33       
34 3．对客户端请求进行监听
35 对客户端的请求进行监听是在Servlet 2.4规范中新添加的一项技术，使用的接口类如下：
36     ● ServletRequestListener接口类。
37     ● ServletRequestAttrubuteListener接口类
38   
39 */
40 public class MyRequestListener implements ServletRequestListener,ServletRequestAttributeListener{
41     public void requestDestroyed(ServletRequestEvent arg0) {
42         //对销毁客户端请求进行监听
43         print("reqeust destroyed");
44     }
45     public void requestInitialized(ServletRequestEvent arg0) {
46         //对实现客户端请求进行监听
47         print("Request init");
48         ServletRequest sr = arg0.getServletRequest(); //初始化客户端请求
49         print(sr.getRemoteAddr()); //获得请求客户端的地址
50     }
51     public void attributeAdded(ServletRequestAttributeEvent arg0) {
52         //对属性的添加进行监听
53         print("attributeAdded(‘"+arg0.getName()+"‘,‘"+arg0.getValue()+"‘)");
54     }
55     public void attributeRemoved(ServletRequestAttributeEvent arg0) {
56         //对属性的删除进行监听
57         print("attributeRemoved(‘"+arg0.getName()+"‘,‘"+arg0.getValue()+"‘)");
58     }
59     public void attributeReplaced(ServletRequestAttributeEvent arg0) {
60         //对属性的更新进行监听
61         print("attributeReplaced(‘"+arg0.getName()+"‘,‘"+arg0.getValue()+"‘)");
62     }
63     private void print(String message){
64         //调用该方法在txt文件中打印出message字符串信息
65         PrintWriter out = null;
66         try{
67              out = new PrintWriter(new FileOutputStream("d:\\output.txt",true));
68              out.println(new java.util.Date()+" RequestListener: "+message);
69              out.close();
70         }catch(Exception e){
71             e.printStackTrace();
72         }
73     }
74 /*
75 对客户端请求进行监听的技术是在Servlet 2.4版本之后才出现的。一旦监听程序能够获得客户端请求，
76 就可以对所有客户端请求进行统一处理。例如，一个Web程序如果在本机访问，就可以不登录，如果是远程访问，
77 即需要登录。这是通过监听客户端请求，从请求中获取到客户端地址，并通过地址来作出相应的处理。
78 程序说明：该监听器类实现了ServletRequestListener和ServletRequestAttributeListener两接口类，
79 ServletRequestListener接口类中定义的两个方法对客户端请求的创建和销毁进行监听；
80 ServletRequestAttributeListener接口类对请求中的属性添加、修改和删除进行监听。
81 *
82 */
83 }

View Code

3、ServletContextListener

 1 package test_servlet_package;
 2 
 3 import java.io.FileOutputStream;
 4 import java.io.PrintWriter;
 5 
 6 import javax.servlet.ServletContext;
 7 import javax.servlet.ServletContextAttributeEvent;
 8 import javax.servlet.ServletContextAttributeListener;
 9 import javax.servlet.ServletContextEvent;
10 import javax.servlet.ServletContextListener;
11 
12 public class MyServletContextListener implements ServletContextListener,ServletContextAttributeListener{
13     private ServletContext context = null; //定义一个ServletContext对象变量，赋为null  
14     public void contextInitialized(ServletContextEvent s) {
15         //TODO 该方法实现了ServletContextListener接口定义的方法，对ServletContext进行初始化  
16         this.context = s.getServletContext(); //初始化一个ServletContext对象  
17         print("ServletContext初始化......"); //打印出该方法的操作信息
18     }  
19     public void contextDestroyed(ServletContextEvent s) {
20         //TODO 该方法实现了ServletContextListener接口类定义方法，用于释放ServletContext对象  
21         this.context = null;
22         print("ServletContext被释放......");
23     }  
24     public void attributeAdded(ServletContextAttributeEvent sa) {
25         //TODO 当上下文添加属性时，将调用该方法。这里只是将添加的属性信息打印出来
26         print("增加ServletContext对象的一个属性：attributeAdded(‘"+sa.getName()+"‘,‘ "+sa.getValue()+"‘)");
27     }  
28     public void attributeRemoved(ServletContextAttributeEvent sa) {
29         //TODO 当把ServletContext中的某个属性删除时，调用该方法  
30         print("删除ServletContext对象的某一个属性：attributeRemoved(‘"+sa.getName()+"‘");  
31     }  
32     public void attributeReplaced(ServletContextAttributeEvent sa) {
33         //TODO 当上下文进行属性值更新时，将调用该方法  
34         print("更改ServletContext对象的某一个属性：attributeReplaced(‘"+sa.getName()+"‘,‘"+sa.getValue()+"‘)");
35     }          
36     private void print(String message){
37         //调用该方法在txt文件中打印出message字符串信息  
38         PrintWriter out = null;  
39         try{ 
40             out = new PrintWriter(new FileOutputStream("D:\\output.txt",true));  
41             out.println(new java.util.Date()+" ContextListener: "+message);
42             out.close();
43         }catch(Exception e){  
44             e.printStackTrace();
45         }
46     }
47 /*
48     程序说明：该监听器类实现了ServletContextAttributeListener和ServletContextListener两个接口类中的5个方法：
49         ● contextInitialized(ServletContextEvent s)方法用来初始化ServletContext对象。
50         ● contextDestroyed(ServletContextEvent s)方法在上下文中删除某个属性时调用。
51         ● attributeAdded(ServletContextAttributeEvent sa)方法在上下文中添加一个新的属性时调用。
52         ● attributeReplaced(ServletContextAttributeEvent sa)方法在更新属性时调用。
53         ● attributeRemoved(ServletContextAttributeEvent sa)方法在上下文中删除某个属性时会被调用。
54     在使用这个监听器之前还需要在Web模块中的web.xml配置文件中进行声明，代码如下：
55     <listener>
56         <listener-class>servlet.MyServletContextListener</listener-class>
57     </listener>
58  * */
59 
60 
61 }

View Code

4、SessionBindingListener

 1 package test_servlet_package;
 2 
 3 import javax.servlet.http.HttpSessionBindingEvent;
 4 import javax.servlet.http.HttpSessionBindingListener;
 5 
 6 public class MySessionBindingListener implements HttpSessionBindingListener{
 7 
 8     @Override
 9     public void valueBound(HttpSessionBindingEvent arg0) {
10         // TODO Auto-generated method stub
11         System.out.println(arg0.getName() + arg0.getValue());
12     }
13 
14     @Override
15     public void valueUnbound(HttpSessionBindingEvent arg0) {
16         // TODO Auto-generated method stub
17         System.out.println(arg0.getName() + arg0.getValue());
18     }
19 
20 }

View Code

5、SessionListener

 1 package test_servlet_package;
 2 import java.io.FileOutputStream;
 3 import java.io.PrintWriter;
 4 import javax.servlet.ServletContext;
 5 import javax.servlet.ServletContextEvent;
 6 import javax.servlet.ServletContextListener;
 7 import javax.servlet.http.HttpSessionActivationListener;
 8 import javax.servlet.http.HttpSessionAttributeListener;
 9 import javax.servlet.http.HttpSessionBindingEvent;
10 import javax.servlet.http.HttpSessionEvent;
11 import javax.servlet.http.HttpSessionListener;
12 public class MySessionListener implements HttpSessionActivationListener,HttpSessionAttributeListener,HttpSessionListener,ServletContextListener{
13     ServletContext context = null;
14     int users = 0;
15     public void sessionWillPassivate(HttpSessionEvent arg0) {
16         //监听Http会话的passivate情况
17         print("sessionWillPassivate("+arg0.getSession().getId()+")");
18     }
19     public void sessionDidActivate(HttpSessionEvent arg0) {
20         //监听Http会话的active情况
21         print("sessionDidActivate("+arg0.getSession().getId()+")");
22     }
23     public void attributeAdded(HttpSessionBindingEvent arg0) {
24         //监听Http会话中的属性添加
25         print("attributeAdded(‘"+arg0.getSession().getId()+"‘,‘"+arg0.getName()+"‘,‘"+arg0.getValue()+"‘)");
26     }
27     public void attributeRemoved(HttpSessionBindingEvent arg0) {
28         //监听Http会话中的属性删除
29         print("attributeRemoved(‘"+arg0.getSession().getId()+"‘,‘"+arg0.getName()+"‘,‘"+arg0.getValue()+"‘)");
30     }
31     public void attributeReplaced(HttpSessionBindingEvent arg0) {
32         //监听Http会话中的属性更改操作
33         print("attributeReplaced(‘"+arg0.getSession().getId()+"‘,‘"+arg0.getName()+"‘,‘"+arg0.getValue()+"‘)");
34     }  
35     public void sessionCreated(HttpSessionEvent arg0) {
36         //Http会话的创建监听
37         users++; //创建一个会话，把users变量加1
38         print("sessionCreated(‘"+arg0.getSession().getId()+"‘),目前拥有"+users+"个用户");
39         context.setAttribute("users",new Integer(users)); //把会话数设置到ServletContext的属性users中
40     }
41     public void sessionDestroyed(HttpSessionEvent arg0) {
42         //Http会话的释放监听
43         users--;//释放一个会话，把users变量减1
44         print("sessionDestroyed(‘"+arg0.getSession().getId()+"‘),目前拥有"+users+"个用户");
45         context.setAttribute("users",new Integer(users));        //把会话数设置到ServletContext的属性users中
46     }
47     public void contextInitialized(ServletContextEvent arg0) {
48         //该方法实现了ServletContextListener接口定义的方法，对ServletContext进行初始化
49         this.context = arg0.getServletContext();//初始化ServletContext对象
50         print("ServletContext初始化......");//打印出该方法的操作信息
51     }
52     public void contextDestroyed(ServletContextEvent arg0) {
53         //监听Servlet上下文被释放
54         this.context = null; //释放ServletContext对象
55         print("ServletContext被释放......");//打印出该方法的操作信息
56     }
57     private void print(String message){
58         //调用该方法在txt文件中打印出message字符串信息
59         PrintWriter out = null;
60         try{
61             out = new PrintWriter(new FileOutputStream("d:\\output.txt",true));
62             out.println(new java.util.Date()+" SessionListener: "+message);
63             out.close();
64         }catch(Exception e){
65             e.printStackTrace();
66         }
67     }
68 /*
69     (1)该程序实现了HttpSessionListener接口类中的两个方法：
70         ● sessionCreated(HttpSessionEvent arg0)方法进行Http会话创建的监听，如果Http会话被创建将调用该方法。
71         ● sessionDestroyed(HttpSessionEvent arg0)方法对Http会话销毁进行监听，如果某个Http会话被释放将调用该方法。
72     (2)实现HttpSessionActivationListener接口类中的如下两个方法：
73         ● sessionDidActivate(HttpSessionEvent arg0)方法对Http会话处于active情况进行监听。
74         ● sessionWillPassivate(HttpSessionEvent arg0)方法对Http会话处于passivate情况进行监听。
75     (3)实现HttpSessionAttributeListener接口类中的如下3种方法：
76         ● attributeAdded(HttpSessionBindingEvent arg0)方法对Http会话中属性添加进行监听。
77         ● attributeReplaced(HttpSessionBindingEvent arg0)方法对Http会话中属性修改进行监听。
78         ● attributeRemoved(HttpSessionBindingEvent arg0)方法对Http会话中属性删除进行监听。
79     (4)另外，该程序中还实现了ServletContextListener接口类，该类的实现方法已经在12.2.1小节中有所介绍。
80         同样需要在web.xml配置文件进行该监听器的声明，该监听器实现了在线会话人数的统计，
81         当一个会话创建时，users变量将加1；当销毁一个会话对象的时候，users变量将减1。
82 */
83 
84 }

View Code

6、测试

 1 <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
 2 <%@ page import="test_servlet_package.MySessionBindingListener"%>
 3 <%@ page import="java.util.*"%>
 4 <html>
 5 <head>
 6     <title>index.jsp</title>
 7 </head>
 8 <body>
 9     <%
10         out.println("Test ServletContextListener");
11         application.setAttribute("userid", "zzb"); //添加一个属性  
12         application.setAttribute("userid", "zzb2"); //替换掉已经添加的属性  
13         application.removeAttribute("userid"); //删除该属性
14     %>
15     <%
16         out.println("Test SessionListener");
17         session.setAttribute("username", "zzb1"); //在Http会话中设置一个用户username属性  
18         session.setAttribute("username", "zzb2"); //修改之上添加的username属性  
19 
20         session.removeAttribute("username"); //删除创建的username属性  
21         MySessionBindingListener mySessionBindingListener = new MySessionBindingListener();
22         session.setAttribute("onlineUserListener", mySessionBindingListener);
23 
24         session.invalidate(); //passivate Http会话
25     %>
26     <%
27         out.println("Test RequestListener");
28         request.setAttribute("username", "zzb1"); //在请求中设置一个用户username属性
29         request.setAttribute("username", "zzb2"); //修改之上添加的username属性
30         request.removeAttribute("username");
31     %>
32 </body>
33 </html>

总结：测试监听器的小案例、方便查询复习