一、監(jiān)聽器的概覽

監(jiān)聽器是指專門用于對(duì)其他對(duì)象身上發(fā)生的事件或狀態(tài)的改變進(jìn)行監(jiān)聽和相應(yīng)處理的對(duì)象，當(dāng)被監(jiān)視的對(duì)象發(fā)生變化時(shí)须鼎，立即采取相應(yīng)的行動(dòng)。比如統(tǒng)計(jì)用戶在線人數(shù)府蔗，監(jiān)聽人就是web應(yīng)用服務(wù)器晋控，被監(jiān)聽者就是session對(duì)象。
??web監(jiān)聽器是Servlet規(guī)范中定義的一種特殊類姓赤，用于監(jiān)聽ServletContext赡译、HttpSession和ServletRequest，可以在事件發(fā)生前不铆、發(fā)生后做一些必要的處理蝌焚。web監(jiān)聽器可以用于統(tǒng)計(jì)用戶在線人數(shù)和在線用戶裹唆、系統(tǒng)啟動(dòng)時(shí)加載初始化信息、統(tǒng)計(jì)網(wǎng)站訪問量等只洒。

二许帐、監(jiān)聽器的分類

按監(jiān)聽對(duì)象劃分

• 用于監(jiān)聽?wèi)?yīng)用程序環(huán)境(ServletContext)的事件監(jiān)聽器
• 用于監(jiān)聽用戶會(huì)話對(duì)象(HttpSession)的事件監(jiān)聽器
• 用于監(jiān)聽請(qǐng)求消息對(duì)象(ServletRequest)的事件監(jiān)聽器

按監(jiān)聽的事件劃分

• 監(jiān)聽域?qū)ο笞陨淼膭?chuàng)建和銷毀的事件監(jiān)聽器
• 監(jiān)聽域?qū)ο笾械膶傩缘脑黾雍蛣h除的事件監(jiān)聽器
• 監(jiān)聽綁定到HttpSession域中的某個(gè)對(duì)象的狀態(tài)的事件監(jiān)聽器

三、監(jiān)聽器的啟動(dòng)順序

四毕谴、監(jiān)聽器詳解

監(jiān)聽器在web容器中的配置方式
①web.xml中配置監(jiān)聽器：

<web-app...>
   ...
   <listener>
       <listener-class>com.listener.testListener</listener-class>
   </listener>
   <context-param>
       <param-name>initParam</param-name>
       <param-value>zoyoto</param-value>
   </context-param>
   ...
<web-app...>

Servelt容器先解析web.xml成畦，獲取Listener的值，通過反射生成監(jiān)聽器對(duì)象涝开。

②在監(jiān)聽器類上標(biāo)注@WebListener

@WebListener()
public class SomeSessionListener implements HttpSessionListener{...}

下面我們來看一下不同類別監(jiān)聽器的解析羡鸥。

(1)監(jiān)聽域?qū)ο笞陨淼膭?chuàng)建和銷毀的事件監(jiān)聽器

• ServletContext→ServletContextListener
• HttpSession→HttpSessionListener
• ServletRequest→ServletRequestListener

注意：上面三種監(jiān)聽器均要在web容器中注冊(cè)

a.ServletContextListener
??一個(gè)項(xiàng)目中只能定義一個(gè)ServletContext,但是一個(gè)ServletContext可以注冊(cè)多個(gè)ServletContextListener。ServletContextListener是對(duì)ServeltContext的一個(gè)監(jiān)聽忠寻，在ServeltContext生成或銷毀后才被調(diào)用惧浴。在方法里面調(diào)用event.getServletContext()可以獲取ServletContext。
??ServeltContext是一個(gè)上下文對(duì)象,它的數(shù)據(jù)供所有的應(yīng)用程序共享奕剃，所以ServletContextListener的主要用途就是：做定時(shí)器和全局屬性對(duì)象衷旅。下面我們看一下如何使用ServeltContext做定時(shí)器：

//ServletContextListener可以負(fù)責(zé)在應(yīng)用服務(wù)器啟動(dòng)時(shí)打開定時(shí)器
@WebListener()
public class taskListener implements ServletContextListener{
       private java.util.Timer timer = null;

       //ServletContext創(chuàng)建時(shí)調(diào)用     
       @Override
       public void contextDestroyed(ServletContextEvent event){
            timer = new java.util.Timer(true);
            event.getServletContext().log("定時(shí)器已啟動(dòng)"); 
            //schedule(TimerTask task, long delay, long period)方法設(shè)定指定任務(wù)task在指定延遲delay后進(jìn)行固定延遲peroid的執(zhí)行
            timer.schedule(new MyTask(event.getServletContext()), 0, 60*60*1000);
            event.getServletContext().log("已經(jīng)添加任務(wù)調(diào)度表");
       }

        //ServletContext銷毀時(shí)調(diào)用
        @Override
        public void contextInitialized(ServletContextEvent servletContextEvent){ 
            timer.cancel();
            event.getServletContext().log("定時(shí)器銷毀");
       }
}

//定時(shí)任務(wù)
public class MyTask extends TimerTask{

     private ServletContext context = null;
     private static boolean isRunning = false;
     private static final int STATISTICS_SCHEDULE_HOUR = 0;

     public MyTask(ServletContext context){
         this.context=context;
     }

     @Override
     public void run(){
          Calendar cal = Calendar.getInstance(); 
          if (!isRunning) {
               //查看是否為凌晨
              if (STATISTICS_SCHEDULE_HOUR == cal.get(Calendar.HOUR_OF_DAY)){
                  isRunning = true; 
                  context.log("開始執(zhí)行指定任務(wù)");

                  //TODO自定義添加任務(wù)詳情
                  executeTask();

                  //指定任務(wù)執(zhí)行結(jié)束
                  isRunning = false;
                  context.log("指定任務(wù)執(zhí)行結(jié)束"); 
               }
          }else{
                  context.log("上一次任務(wù)執(zhí)行還未結(jié)束");
          }
     }
}

b.HttpSessionListener
??一個(gè)HttpSession可以注冊(cè)多個(gè)HttpSessionListener。HttpSessionListener是對(duì)Session的監(jiān)聽纵朋，在Session生成或銷毀后被調(diào)用柿顶。HttpSessionListener主要用途是統(tǒng)計(jì)在線人數(shù)和記錄訪問日志。下面我們來看一下如何用該監(jiān)聽器統(tǒng)計(jì)在線人數(shù)：

@WebListener()
public class testListener implements HttpSessionListener{
       private static Integer userNumber = 0;
    
       public static int getCount(){
             return userNumber;
       }

       //session創(chuàng)建時(shí)調(diào)用
       @Override
       public void sessionCreated(HttpSessionEvent httpSessionEvent){
            System.out.println("sessionCreated");
            userNumber++:
       }

        //session銷毀時(shí)調(diào)用
        @Override
        public void sessionDestroyed(HttpSessionEvent httpSessionEvent){ 
            System.out.println("sessionDestroyed");
            userNumber--:
       }
}

啟動(dòng)服務(wù)器操软，然后在瀏覽器輸入U(xiǎn)RL嘁锯，就會(huì)發(fā)現(xiàn)控制臺(tái)輸出了sessionCreated；這時(shí)我們關(guān)掉瀏覽器聂薪，session并不會(huì)立刻就銷毀家乘，而是隔一段時(shí)間才銷毀。我們可以在web.xml中設(shè)置session-timeout藏澳，假如session-timeout為0仁锯，就說明這個(gè)session沒有超時(shí)的限制。我們?cè)O(shè)置為1翔悠，意思就是等一分鐘业崖，如果session沒有點(diǎn)擊的話，就會(huì)被銷毀蓄愁，就會(huì)打印出sessionDestroyed双炕。

<session-config>
     <session-timeout>1</session-timeout>
</session-config>

在HttpSessionListener監(jiān)聽器里面，我們可以用httpSessionEvent.getSession().getServletContext()得到上下文,因?yàn)閔ttpSessionEvent中只有g(shù)etSession()撮抓，沒有g(shù)etServletcontext()妇斤。

c.ServletRequestListener
??一個(gè)ServletRequest可以注冊(cè)多個(gè)ServletRequestListener。ServletRequestListener接口用于監(jiān)聽Web應(yīng)用程序中ServletRequest對(duì)象的創(chuàng)建和銷毀。ServletRequestListener主要用途是讀取參數(shù)和記錄訪問歷史趟济。

@WebListener()
public class testListener implements ServletRequestListener{
       //request創(chuàng)建時(shí)(發(fā)送請(qǐng)求)調(diào)用
       @Override
       public void requestInitialized(ServletRequestEvent servletRequestEvent){
            System.out.println("requestCreated");
       }

        //request處理完畢銷毀時(shí)調(diào)用
        @Override
        public void requestDestroyed(ServletRequestEvent servletRequestEvent){ 
            System.out.println("requestDestroyed");
       }
}

此監(jiān)聽器可以啟動(dòng)Tomcat發(fā)送請(qǐng)求進(jìn)行測(cè)試乱投。

(2)監(jiān)聽域?qū)ο笾械膶傩缘脑黾雍蛣h除的事件監(jiān)聽器

• ServletContext→ServletContextAttributeListener
• HttpSession→HttpSessionAttributeListener
• ServletRequest→ServletRequestAttributeListener

注意：上面三種監(jiān)聽器均要在web容器中注冊(cè)

a.ServletContextAttributeListener
??此接口用于監(jiān)聽ServletContext屬性的變化。

@WebListener()
public class testListener implements ServletContextAttributeListener{
       //添加屬性
       @Override
       public void attributeAdded(ServletContextAttributeEvent e){
            System.out.println("attributeAdded"+e.getName());
       }

       //刪除屬性
       @Override
       public void attributeRemoved(ServletContextAttributeEvent e){
            System.out.println("attributeRemoved"+e.getName());
       }

       //修改屬性
       @Override
       public void attributeReplaced(ServletContextAttributeEvent e){ 
            System.out.println("attributeReplaced"+e.getName());
       }
}

b.HttpSessionAttributeListener
??此接口用于監(jiān)聽Session屬性的變化顷编。

@WebListener()
public class testListener implements HttpSessionAttributeListener{
       //session.setAttribute()
       @Override
       public void attributeAdded(HttpSessionBindingEvent e){
            System.out.println("attributeAdded"+e.getName());
       }

       //session.removeAttribute()
       @Override
       public void attributeRemoved(HttpSessionBindingEvent e){
            System.out.println("attributeRemoved"+e.getName());
       }

       //session.replaceAttribute()
       @Override
       public void attributeReplaced(HttpSessionBindingEvent e){ 
            System.out.println("attributeReplaced"+e.getName());
       }
}

c.ServletRequestAttributeListener
??此接口用于監(jiān)聽request屬性的變化戚炫。

@WebListener()
public class testListener implements ServletRequestAttributeListener{
        //request.setAttribute()
       @Override
       public void attributeAdded(HttpSessionBindingEvent e){
            System.out.println("attributeAdded"+e.getName());
       }

        //request.removeAttribute();
        @Override
        public void attributeRemoved(HttpSessionBindingEvent e){
            System.out.println("attributeRemoved"+e.getName());
       }

        //對(duì)已經(jīng)存在于request中的屬性再次調(diào)用request.setAttribute("user", "bbb")
        //如request.setAttribute("user", "aaa");request.setAttribute("user", "bbb");
        @Override
        public void attributeReplaced(HttpSessionBindingEvent e){ 
            System.out.println("attributeReplaced"+e.getName());
       }
}

(3)監(jiān)聽綁定到HttpSession域中的某個(gè)對(duì)象的狀態(tài)的事件監(jiān)聽器

HttpSession中的對(duì)象狀態(tài)：①綁定→解除綁定??②鈍化→活化

3.1鈍化與活化

鈍化：將session對(duì)象持久化到存儲(chǔ)設(shè)備上；
活化：將session從存儲(chǔ)設(shè)備上恢復(fù)

Session正常是放到服務(wù)器內(nèi)存當(dāng)中的媳纬，服務(wù)器會(huì)對(duì)每一個(gè)在線用戶創(chuàng)建一個(gè)Session對(duì)象双肤，如果當(dāng)前用戶很多，Session內(nèi)存的開銷是非常大的钮惠，影響性能茅糜。而Session的鈍化機(jī)制可以解決這個(gè)問題。
??鈍化的本質(zhì)就是把一部分比較長(zhǎng)時(shí)間沒有變動(dòng)的Session暫時(shí)序列化到系統(tǒng)文件或者數(shù)據(jù)庫(kù)系統(tǒng)當(dāng)中素挽，等該Session的用戶重新使用的時(shí)候蔑赘，服務(wù)器在內(nèi)存中找不到Session，就會(huì)到磁盤中去找预明，然后把Session反序列化到內(nèi)存中缩赛。整個(gè)過程由服務(wù)器自動(dòng)完成。
??注意撰糠，Session只有可以被序列化才能被鈍化酥馍。Session序列化時(shí)，服務(wù)器會(huì)把Session保存到硬盤中,以sessionID命名阅酪，以“.session”作為擴(kuò)展名旨袒。
??Session鈍化機(jī)制由SessionManager管理，Tomcat有兩種Session管理器：
①StandardManager(標(biāo)準(zhǔn)會(huì)話管理器)

<Manager className="org.apache.catalina.session.StandardManager" 
     maxInactiveInterval="7200"/>

• Tomcat6的默認(rèn)會(huì)話管理器术辐，用于非集群環(huán)境中對(duì)單個(gè)處于運(yùn)行狀態(tài)的Tomcat實(shí)例會(huì)話進(jìn)行管理砚尽。
• 當(dāng)運(yùn)行Tomcat時(shí)，StandardManager實(shí)例負(fù)責(zé)在內(nèi)存中管理Session术吗；但當(dāng)服務(wù)器關(guān)閉時(shí)尉辑，會(huì)將當(dāng)前內(nèi)存中的Session寫入到磁盤上的一個(gè)名叫SESSION.ser的文件帆精，等服務(wù)器再次啟動(dòng)時(shí)较屿，會(huì)重新載入這些Session。
• 另一種情況是Web應(yīng)用程序被重新加載時(shí)卓练，內(nèi)存中的Session對(duì)象也會(huì)被鈍化到服務(wù)器的文件系統(tǒng)中隘蝎。
• 鈍化后的文件默認(rèn)被保存在Tomcat的安裝路徑$CATALINA_HOME/work/Catalina/<hostname>/<webapp-name>/下的SESSIONS.ser文件中。

②PersistentManager(持久會(huì)話管理器)

• PersistentManager和StandardManager的區(qū)別在于PersistentManager自己實(shí)現(xiàn)了Store類襟企，使Session可以被保存到不同地方(Database,Redis等)嘱么，而不局限于只保存在SESSION.ser文件中。Store表示了管理session對(duì)的二級(jí)存儲(chǔ)設(shè)備顽悼。

 <ManagerclassName="org.apache.catalina.session.PersistentManager"
         debug="0"
         <!--當(dāng)Tomcat正常停止及重啟動(dòng)時(shí)曼振，是否要儲(chǔ)存及重載會(huì)話几迄。-->
         saveOnRestart="true"
         <!--可容許現(xiàn)行最大會(huì)話的最大數(shù)，-1代表無(wú)限制-->
         maxActiveSession="-1"
         <!--在調(diào)換會(huì)話至磁盤之前冰评，此會(huì)話必須閑置的最小時(shí)間-->
         minIdleSwap="0"
         <!--在文件交換之前映胁，此會(huì)話可以閑置的最大時(shí)間(以秒為單位)。-1表示會(huì)話不應(yīng)該被強(qiáng)迫調(diào)換至文件甲雅。-->
         maxIdleSwap="0"
         <!--在備份之前解孙，此會(huì)話必須閑置的最大時(shí)間。-1表示不進(jìn)行備份-->
         maxIdleBackup="-1"
         <!--保存在Reids中-->
         <Store className="com.cdai.test.RedisStore" host="192.168.1.1"port="6379"/>
</Manager>

• PersistentManager支持兩種鈍化驅(qū)動(dòng)類：org.apache.Catalina.FileStore和org.apache.Catalina.JDBCStore抛人，分別支持將會(huì)話保存至文件存儲(chǔ)(FileStore)或JDBC存儲(chǔ)(JDBCStore)中弛姜。

<!--保存到文件中-->
<Manager className="org.apache.catalina.session.PersistentManager" 
 saveOnRestart="true"> 
<!--每個(gè)用戶的會(huì)話會(huì)被保存至directory指定的目錄中的文件中-->
 <Store className="org.apache.catalina.session.FileStore" 
         directory="/data/tomcat-sessions"/> 
</Manager>

<!--保存到JDBCStore中-->
<Manager className="org.apache.catalina.session.PersistentManager" 
 saveOnRestart="true"> 
 <Store className="org.apache.catalina.session.JDBCStore" 
         driverName="com.mysql.jdbc.Driver" 
         connectionURL="jdbc:mysql://localhost:3306/mydb?user=root;password=123"/> 
</Manager>

• 在持久化管理器中，session可以被備份或換出到存儲(chǔ)器中妖枚。
• 換出：當(dāng)內(nèi)存中有過多的session對(duì)象時(shí)廷臼，持久化管理器會(huì)直接將session對(duì)象換出，直到當(dāng)前活動(dòng)對(duì)象等于maxActiveSession指定的值绝页。
• 備份：不是所有的session都會(huì)備份中剩，PersistentManager只會(huì)將那些空閑時(shí)間超過maxIdleBackup的session備份到文件或數(shù)據(jù)庫(kù)中。該任務(wù)由processMaxIdleBackups方法完成抒寂。
• 此時(shí)Tomcat只是在下面三種情況會(huì)將Session通過Store保存起來结啼。
• 當(dāng)Session的空閑時(shí)間超過minIdleSwap和maxIdleSwap時(shí)，會(huì)將Session換出
• 當(dāng)Session的空閑時(shí)間超過maxIdleBackup時(shí)屈芜，會(huì)將Session備份出去
• 當(dāng)Session總數(shù)大于maxActiveSession時(shí)郊愧，會(huì)將超出部分的空閑Session換出

3.2接口規(guī)范
??servlet規(guī)范中提供的兩種接口用以監(jiān)聽session內(nèi)的對(duì)象：

HttpSessionBindingListener                 HttpSessionActivationListener
          |                                             |
         / \                                           / \
valueBound  valueUnBound            sessionWillPassivate sessionDidActivate
  (綁定)     (解除綁定)                    (鈍化)             (活化)

以上接口皆不需要在web容器中注冊(cè)。

(1)綁定和解綁接口
??當(dāng)對(duì)象被放到session里執(zhí)行或從session里移除就會(huì)執(zhí)行HttpSessionBindingListener內(nèi)的方法井佑，但是對(duì)象必須實(shí)現(xiàn)該Listener接口属铁。需要注意的是，我們創(chuàng)建的這個(gè)類并不是創(chuàng)建一個(gè)監(jiān)聽器躬翁，而是創(chuàng)建一個(gè)被監(jiān)聽器綁定的Javabean焦蘑。

public class User implements HttpSessionBindingListener{
       private String userName;
       private String password;

       //對(duì)象被放進(jìn)session時(shí)觸發(fā)，如session.setAttribute("user",user);
       @Override
       public void valueBound(HttpSessionBindingEvent e){ 
          //getName()方法可以取得屬性設(shè)定或移除時(shí)指定的名稱
          System.out.println(this + "被綁定到session \"" + e.getSession.getId() + "\"的" +e.getName()+ "屬性上);
       }

        //從session移除后觸發(fā)盒发，
        @Override
        public void valueUnBound(HttpSessionBindingEvent e){ 
          System.out.println(this + "被從session \"" + e.getSession.getId() + "\"的" +e.getName()+ "屬性上移除);       
       }

       //此處省略getter和setter
}

valueUnbound方法將被以下任一條件觸發(fā)：
a. 執(zhí)行session.setAttribute("uocl", 非uocl對(duì)象) 時(shí)例嘱。
b. 執(zhí)行session.removeAttribute("uocl") 時(shí)。
c. 執(zhí)行session.invalidate()時(shí)宁舰。
d. session超時(shí)后拼卵。

(2)鈍化和活化接口
??服務(wù)器內(nèi)存對(duì)session進(jìn)行鈍化或者活化時(shí)你會(huì)收到監(jiān)聽事件。什么時(shí)候序列化和反序列化完全由容器決定蛮艰，我們只能用HttpSessionActivationListener接口監(jiān)聽器監(jiān)聽對(duì)象是否被鈍化腋腮。

//要注意只有實(shí)現(xiàn)Serializable接口才能被鈍化
public class User implements HttpSessionActivationListener，Serializable{
       private String userName;
       private String password;

       //被鈍化時(shí)調(diào)用
       @Override
       public void sessionWillPassivate(HttpSessionEvent e){
          System.out.println(this + "即將保存到硬盤。sessionId: " + e.getSession.getId());       
       }

        //被活化時(shí)調(diào)用
        @Override
        public void sessionDidActivate(HttpSessionEvent e){ 
          System.out.println(this + "已經(jīng)成功從硬盤中加載即寡。sessionId: " + e.getSession.getId());      
       }

       //此處省略getter和setter
}

測(cè)試的時(shí)候先把Tomcat關(guān)掉徊哑，就會(huì)發(fā)現(xiàn)控制臺(tái)輸出了

sessionWillPassivate org.apache.catalina.session.StandardSessionFacade@4f2d26d2

也就是session已經(jīng)被鈍化了，此時(shí)在Tomcat安裝路徑下會(huì)發(fā)現(xiàn)SESSION.er文件聪富。然后我們?cè)賮碇貑omcat实柠，發(fā)現(xiàn)控制臺(tái)輸出：

sessionDidActivate org.apache.catalina.session.StandardSessionFacade@4f2d26d2

此時(shí)會(huì)發(fā)現(xiàn)在Tomcat安裝路徑下的SESSION.er文件消失了，也就說明session已經(jīng)被活化了善涨。
??同樣的窒盐，如果我們?cè)O(shè)定了maxIdleeSwap="1"，當(dāng)用戶開著瀏覽器一分鐘不操作頁(yè)面的話服務(wù)器就會(huì)將session鈍化钢拧，將session生成文件放在tomcat工作目錄下蟹漓，直到再次訪問才會(huì)被激活。