java web Listener的簡單使用案例

1、web.xml的配置

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://java.sun.com/xml/ns/javaee" 
    xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" 
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0">
    <display-name>testServletListener</display-name>
    <listener>
        <listener-class>test_servlet_package.MyRequestListener</listener-class>
    </listener>
    <listener>
        <listener-class>test_servlet_package.MySessionListener</listener-class>
    </listener>
    <listener>
        <listener-class>test_servlet_package.MyServletContextListener</listener-class>
    </listener>
    <!-- 配置歡迎界面 -->
    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

2、RequestListener

package test_servlet_package;
import java.io.FileOutputStream;
import java.io.PrintWriter;
import javax.servlet.ServletRequest;
import javax.servlet.ServletRequestAttributeEvent;
import javax.servlet.ServletRequestAttributeListener;
import javax.servlet.ServletRequestEvent;
import javax.servlet.ServletRequestListener;
/*
Servlet事件監聽器
在Servlet技術中已經定義了一些事件，
並且我們可以針對這些事件來編寫相關的事件監聽器，從而對事件作出相應處理。
Servlet事件主要有3類：Servlet上下文事件、會話事件與請求事件
下面具體講解這3類事件的監聽器實現。

1．對Servlet上下文進行監聽
可以監聽ServletContext對象的創建和刪除以及屬性的添加、刪除和修改等操作。該監聽器需要使用到如下兩個接口類：
    ● ServletContextAttributeListener：監聽對ServletContext屬性的操作，如增加、刪除、修改操作。
    ● ServletContextListener：監聽ServletContext，
        當創建ServletContext時，激發contextInitialized (ServletContextEvent sce)方法。
        當銷毀ServletContext時，激發contextDestroyed(ServletContext- Event sce)方法。

2．監聽Http會話
可以監聽Http會話活動情況、Http會話中屬性設置情況，也可以監聽Http會話的active、paasivate情況等。該監聽器需要使用到如下多個接口類：
  ● HttpSessionListener：監聽HttpSession的操作。
        當創建一個Session時，激發session Created (SessionEvent se)方法；
        當銷毀一個Session時，激發sessionDestroyed (HttpSessionEvent se)方法。
  ● HttpSessionActivationListener：用於監聽Http會話active、passivate情況。
  ● HttpSessionAttributeListener：監聽HttpSession中屬性的操作。
        當在Session增加一個屬性時，激發attributeAdded(HttpSessionBindingEvent se) 方法；
        當在Session刪除一個屬性時，激發attributeRemoved(HttpSessionBindingEvent se)方法；
        當在Session屬性被重新設置時，激發attributeReplaced(HttpSessionBindingEvent se) 方法。
      
3．對客戶端請求進行監聽
對客戶端的請求進行監聽是在Servlet 2.4規范中新添加的一項技術，使用的接口類如下：
    ● ServletRequestListener接口類。
    ● ServletRequestAttrubuteListener接口類
  
*/
public class MyRequestListener implements ServletRequestListener,ServletRequestAttributeListener{
    public void requestDestroyed(ServletRequestEvent arg0) {
        //對銷毀客戶端請求進行監聽
        print("reqeust destroyed");
    }
    public void requestInitialized(ServletRequestEvent arg0) {
        //對實現客戶端請求進行監聽
        print("Request init");
        ServletRequest sr = arg0.getServletRequest(); //初始化客戶端請求
        print(sr.getRemoteAddr()); //獲得請求客戶端的地址
    }
    public void attributeAdded(ServletRequestAttributeEvent arg0) {
        //對屬性的添加進行監聽
        print("attributeAdded('"+arg0.getName()+"','"+arg0.getValue()+"')");
    }
    public void attributeRemoved(ServletRequestAttributeEvent arg0) {
        //對屬性的刪除進行監聽
        print("attributeRemoved('"+arg0.getName()+"','"+arg0.getValue()+"')");
    }
    public void attributeReplaced(ServletRequestAttributeEvent arg0) {
        //對屬性的更新進行監聽
        print("attributeReplaced('"+arg0.getName()+"','"+arg0.getValue()+"')");
    }
    private void print(String message){
        //調用該方法在txt文件中打印出message字符串信息
        PrintWriter out = null;
        try{
             out = new PrintWriter(new FileOutputStream("d:\\output.txt",true));
             out.println(new java.util.Date()+" RequestListener: "+message);
             out.close();
        }catch(Exception e){
            e.printStackTrace();
        }
    }
/*
對客戶端請求進行監聽的技術是在Servlet 2.4版本之后才出現的。一旦監聽程序能夠獲得客戶端請求，
就可以對所有客戶端請求進行統一處理。例如，一個Web程序如果在本機訪問，就可以不登錄，如果是遠程訪問，
即需要登錄。這是通過監聽客戶端請求，從請求中獲取到客戶端地址，並通過地址來作出相應的處理。
程序說明：該監聽器類實現了ServletRequestListener和ServletRequestAttributeListener兩接口類，
ServletRequestListener接口類中定義的兩個方法對客戶端請求的創建和銷毀進行監聽；
ServletRequestAttributeListener接口類對請求中的屬性添加、修改和刪除進行監聽。
*
*/
}

3、ServletContextListener

package test_servlet_package;

import java.io.FileOutputStream;
import java.io.PrintWriter;

import javax.servlet.ServletContext;
import javax.servlet.ServletContextAttributeEvent;
import javax.servlet.ServletContextAttributeListener;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

public class MyServletContextListener implements ServletContextListener,ServletContextAttributeListener{
    private ServletContext context = null; //定義一個ServletContext對象變量，賦為null  
    public void contextInitialized(ServletContextEvent s) {
        //TODO 該方法實現了ServletContextListener接口定義的方法，對ServletContext進行初始化  
        this.context = s.getServletContext(); //初始化一個ServletContext對象  
        print("ServletContext初始化......"); //打印出該方法的操作信息
    }  
    public void contextDestroyed(ServletContextEvent s) {
        //TODO 該方法實現了ServletContextListener接口類定義方法，用於釋放ServletContext對象  
        this.context = null;
        print("ServletContext被釋放......");
    }  
    public void attributeAdded(ServletContextAttributeEvent sa) {
        //TODO 當上下文添加屬性時，將調用該方法。這里只是將添加的屬性信息打印出來
        print("增加ServletContext對象的一個屬性：attributeAdded('"+sa.getName()+"',' "+sa.getValue()+"')");
    }  
    public void attributeRemoved(ServletContextAttributeEvent sa) {
        //TODO 當把ServletContext中的某個屬性刪除時，調用該方法  
        print("刪除ServletContext對象的某一個屬性：attributeRemoved('"+sa.getName()+"'");  
    }  
    public void attributeReplaced(ServletContextAttributeEvent sa) {
        //TODO 當上下文進行屬性值更新時，將調用該方法  
        print("更改ServletContext對象的某一個屬性：attributeReplaced('"+sa.getName()+"','"+sa.getValue()+"')");
    }          
    private void print(String message){
        //調用該方法在txt文件中打印出message字符串信息  
        PrintWriter out = null;  
        try{ 
            out = new PrintWriter(new FileOutputStream("D:\\output.txt",true));  
            out.println(new java.util.Date()+" ContextListener: "+message);
            out.close();
        }catch(Exception e){  
            e.printStackTrace();
        }
    }
/*
    程序說明：該監聽器類實現了ServletContextAttributeListener和ServletContextListener兩個接口類中的5個方法：
        ● contextInitialized(ServletContextEvent s)方法用來初始化ServletContext對象。
        ● contextDestroyed(ServletContextEvent s)方法在上下文中刪除某個屬性時調用。
        ● attributeAdded(ServletContextAttributeEvent sa)方法在上下文中添加一個新的屬性時調用。
        ● attributeReplaced(ServletContextAttributeEvent sa)方法在更新屬性時調用。
        ● attributeRemoved(ServletContextAttributeEvent sa)方法在上下文中刪除某個屬性時會被調用。
    在使用這個監聽器之前還需要在Web模塊中的web.xml配置文件中進行聲明，代碼如下：
    <listener>
        <listener-class>servlet.MyServletContextListener</listener-class>
    </listener>
 * */


}

4、SessionBindingListener

package test_servlet_package;

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

public class MySessionBindingListener implements HttpSessionBindingListener{

    @Override
    public void valueBound(HttpSessionBindingEvent arg0) {
        // TODO Auto-generated method stub
        System.out.println(arg0.getName() + arg0.getValue());
    }

    @Override
    public void valueUnbound(HttpSessionBindingEvent arg0) {
        // TODO Auto-generated method stub
        System.out.println(arg0.getName() + arg0.getValue());
    }

}

5、SessionListener

package test_servlet_package;
import java.io.FileOutputStream;
import java.io.PrintWriter;
import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.http.HttpSessionActivationListener;
import javax.servlet.http.HttpSessionAttributeListener;
import javax.servlet.http.HttpSessionBindingEvent;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;
public class MySessionListener implements HttpSessionActivationListener,HttpSessionAttributeListener,HttpSessionListener,ServletContextListener{
    ServletContext context = null;
    int users = 0;
    public void sessionWillPassivate(HttpSessionEvent arg0) {
        //監聽Http會話的passivate情況
        print("sessionWillPassivate("+arg0.getSession().getId()+")");
    }
    public void sessionDidActivate(HttpSessionEvent arg0) {
        //監聽Http會話的active情況
        print("sessionDidActivate("+arg0.getSession().getId()+")");
    }
    public void attributeAdded(HttpSessionBindingEvent arg0) {
        //監聽Http會話中的屬性添加
        print("attributeAdded('"+arg0.getSession().getId()+"','"+arg0.getName()+"','"+arg0.getValue()+"')");
    }
    public void attributeRemoved(HttpSessionBindingEvent arg0) {
        //監聽Http會話中的屬性刪除
        print("attributeRemoved('"+arg0.getSession().getId()+"','"+arg0.getName()+"','"+arg0.getValue()+"')");
    }
    public void attributeReplaced(HttpSessionBindingEvent arg0) {
        //監聽Http會話中的屬性更改操作
        print("attributeReplaced('"+arg0.getSession().getId()+"','"+arg0.getName()+"','"+arg0.getValue()+"')");
    }  
    public void sessionCreated(HttpSessionEvent arg0) {
        //Http會話的創建監聽
        users++; //創建一個會話，把users變量加1
        print("sessionCreated('"+arg0.getSession().getId()+"'),目前擁有"+users+"個用戶");
        context.setAttribute("users",new Integer(users)); //把會話數設置到ServletContext的屬性users中
    }
    public void sessionDestroyed(HttpSessionEvent arg0) {
        //Http會話的釋放監聽
        users--;//釋放一個會話，把users變量減1
        print("sessionDestroyed('"+arg0.getSession().getId()+"'),目前擁有"+users+"個用戶");
        context.setAttribute("users",new Integer(users));        //把會話數設置到ServletContext的屬性users中
    }
    public void contextInitialized(ServletContextEvent arg0) {
        //該方法實現了ServletContextListener接口定義的方法，對ServletContext進行初始化
        this.context = arg0.getServletContext();//初始化ServletContext對象
        print("ServletContext初始化......");//打印出該方法的操作信息
    }
    public void contextDestroyed(ServletContextEvent arg0) {
        //監聽Servlet上下文被釋放
        this.context = null; //釋放ServletContext對象
        print("ServletContext被釋放......");//打印出該方法的操作信息
    }
    private void print(String message){
        //調用該方法在txt文件中打印出message字符串信息
        PrintWriter out = null;
        try{
            out = new PrintWriter(new FileOutputStream("d:\\output.txt",true));
            out.println(new java.util.Date()+" SessionListener: "+message);
            out.close();
        }catch(Exception e){
            e.printStackTrace();
        }
    }
/*
    (1)該程序實現了HttpSessionListener接口類中的兩個方法：
        ● sessionCreated(HttpSessionEvent arg0)方法進行Http會話創建的監聽，如果Http會話被創建將調用該方法。
        ● sessionDestroyed(HttpSessionEvent arg0)方法對Http會話銷毀進行監聽，如果某個Http會話被釋放將調用該方法。
    (2)實現HttpSessionActivationListener接口類中的如下兩個方法：
        ● sessionDidActivate(HttpSessionEvent arg0)方法對Http會話處於active情況進行監聽。
        ● sessionWillPassivate(HttpSessionEvent arg0)方法對Http會話處於passivate情況進行監聽。
    (3)實現HttpSessionAttributeListener接口類中的如下3種方法：
        ● attributeAdded(HttpSessionBindingEvent arg0)方法對Http會話中屬性添加進行監聽。
        ● attributeReplaced(HttpSessionBindingEvent arg0)方法對Http會話中屬性修改進行監聽。
        ● attributeRemoved(HttpSessionBindingEvent arg0)方法對Http會話中屬性刪除進行監聽。
    (4)另外，該程序中還實現了ServletContextListener接口類，該類的實現方法已經在12.2.1小節中有所介紹。
        同樣需要在web.xml配置文件進行該監聽器的聲明，該監聽器實現了在線會話人數的統計，
        當一個會話創建時，users變量將加1；當銷毀一個會話對象的時候，users變量將減1。
*/

}

6、測試

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@ page import="test_servlet_package.MySessionBindingListener"%>
<%@ page import="java.util.*"%>
<html>
<head>
    <title>index.jsp</title>
</head>
<body>
    <%
        out.println("Test ServletContextListener");
        application.setAttribute("userid", "zzb"); //添加一個屬性  
        application.setAttribute("userid", "zzb2"); //替換掉已經添加的屬性  
        application.removeAttribute("userid"); //刪除該屬性
    %>
    <%
        out.println("Test SessionListener");
        session.setAttribute("username", "zzb1"); //在Http會話中設置一個用戶username屬性  
        session.setAttribute("username", "zzb2"); //修改之上添加的username屬性  

        session.removeAttribute("username"); //刪除創建的username屬性  
        MySessionBindingListener mySessionBindingListener = new MySessionBindingListener();
        session.setAttribute("onlineUserListener", mySessionBindingListener);

        session.invalidate(); //passivate Http會話
    %>
    <%
        out.println("Test RequestListener");
        request.setAttribute("username", "zzb1"); //在請求中設置一個用戶username屬性
        request.setAttribute("username", "zzb2"); //修改之上添加的username屬性
        request.removeAttribute("username");
    %>
</body>
</html>

總結：測試監聽器的小案例、方便查詢復習