Listener總結(jié)(1)---域?qū)ο髣?chuàng)建和銷毀監(jiān)聽器

原創(chuàng)文章,轉(zhuǎn)載請注明出處

? 從開年到現(xiàn)在兩個月時間汰蜘,一直想慢慢開始寫點東西关霸,將工作以來學(xué)到的知識和技能進行總結(jié)催首。但是偏偏年后項目比較急殖属,一個集中刻錄項目就寫了一個月左右输虱,但是得到的收獲也不少。好不容易清明有了一點的空閑盈电,就將之前的一些筆記和開發(fā)中遇到的問題好好的總結(jié)一下吧沿癞。

? 萬事開頭難躁绸,能提筆開始寫這篇文章等缀,相信以后能養(yǎng)成定時總結(jié)的習(xí)慣枷莉,也希望能和大家進行探討,有錯誤和疏漏的地方還請不吝賜教尺迂。

? 廢話也就不多說了笤妙,今天主要總結(jié)一下 JavaWeb 開發(fā)中最基本的三大類:Listener、Filter與 Servlet中的 Listener噪裕。對于 JavaWeb 程序來講蹲盘,這三個類是維持其基本運作的基石,在現(xiàn)代開發(fā)中州疾,各種框架(最常見的 Spring辜限、Struts2皇拣、Hibernate等)為程序員搭建好了舒適的開發(fā)環(huán)境严蓖,以至于讓人忽略了之三大類能做到的許多事情⊙跫保互聯(lián)網(wǎng)時代每時每刻都在變化颗胡,但是這些變化也是基于一些不變的東西,學(xué)習(xí)一門技術(shù)也要從最基本的吩坝、不變的底層學(xué)起毒姨,往上才能開枝散葉,正所謂萬變不離其宗钉寝。

Listener

? Listener 是專門用來監(jiān)聽另一個 Java 對象方法的調(diào)用或?qū)傩愿淖兓∧牛瑢崿F(xiàn)了特定接口的特殊類 。剛好最近在閱讀有關(guān)設(shè)計模式的書籍嵌纲,而這里 Listener 正是通過觀察者模式進行實現(xiàn)的俘枫,而在前一個月做的項目中有多處都用到了這種設(shè)計模式。

? 在 JavaWeb 應(yīng)用中逮走,被監(jiān)聽的對象主要是:ServletContext鸠蚪、HttpSessionServletRequest

? 針對以上三個對象的操作茅信,Listener 又被劃分成為三種類型:

  • 域?qū)ο髣?chuàng)建和銷毀的事件監(jiān)聽器
  • 域?qū)ο笾袑傩愿淖兊氖录O(jiān)聽器
  • 綁定到 HttpSession域中的某個對象的狀態(tài)的事件監(jiān)聽器

域?qū)ο髣?chuàng)建和銷毀的事件監(jiān)聽器

? 這類Listener的作用是監(jiān)聽對象的創(chuàng)建和銷毀盾舌,自定義的Listener 類需要實現(xiàn)特定接口中的兩個方法:XXXInitialized,XXXDestroyed蘸鲸。下面的代碼顯示了針對不同的被監(jiān)聽對象的Listener實現(xiàn):

web.xml

<listener>
    <listener-class>com.yzhang.listener.test.MyServletContextListener</listener-class>
</listener>

<listener>
    <listener-class>com.yzhang.listener.test.MyHttpSessionListener</listener-class>
</listener>

<listener>
    <listener-class>com.yzhang.listener.test.MyServletRequestListener</listener-class>
</listener>

MyServletContextListener

//***
public class MyServletContextListener implements ServletContextListener {

    private static Logger logger = Logger.getLogger(MyServletContextListener.class);

    public void contextInitialized(ServletContextEvent sce) {
        logger.debug("servletContextInitialized");
    }

    public void contextDestroyed(ServletContextEvent sce) {
        logger.debug("servletContextDestroyed");
    }
}

MyHttpSessionListener

//***
public class MyHttpSessionListener implements HttpSessionListener {

    private static Logger logger = Logger.getLogger(MyHttpSessionListener.class);

    public void sessionCreated(HttpSessionEvent se) {
        logger.debug("sessionCreated");
        logger.debug(se.getSession().getId());
    }

    public void sessionDestroyed(HttpSessionEvent se) {
        logger.debug("sessionDestroyed");
    }
}

MyServletRequestListener

public class MyServletRequestListener implements ServletRequestListener {

    private static Logger logger = Logger.getLogger(MyServletRequestListener.class);

    public void requestInitialized(ServletRequestEvent sre) {
        logger.debug("requestInitialized");
        HttpServletRequest request = (HttpServletRequest)sre.getServletRequest();
        logger.debug(request.getRequestURL());
    }

    public void requestDestroyed(ServletRequestEvent sre) {
        logger.debug("requestDestroyed");
    }
}

? ServletContextListener 監(jiān)視的是整個 Servlet 容器對象妖谴,當(dāng) Servlet 容器啟動時,監(jiān)聽器的contextInitialized方法被調(diào)用棚贾,當(dāng)這個方法被調(diào)用時窖维,其實傳達的是這么一條信息:我(Servlet 容器)已經(jīng)啟動完成,你(對應(yīng)的程序)可以開始你自己的工作了妙痹。所以在contextInitialized中往往做一些初始化的工作铸史,同理contextDestroyed在 Servlet 容器對象被銷毀時調(diào)用,可做一些收尾工作怯伊。

? HttpSessionListener監(jiān)視的是 Session 對象琳轿,在整個 web 應(yīng)用生命周期中,每當(dāng)有 Session 被創(chuàng)建和銷毀時耿芹,都會調(diào)用其中的sessionCreatedsessionDestroyed崭篡,在方法中可以通過HttpSessionEvent.getSession()來獲取 Session 的詳細信息。

? ServletRequestListener與 HttpSessionListener 大致相同吧秕,區(qū)別在于其監(jiān)視的是 ServletRequest 對象琉闪,通俗來講:每當(dāng)有一次頁面訪問請求到達,都會創(chuàng)建一個ServletRequest 對象砸彬,從而導(dǎo)致requestInitialized方法被調(diào)用颠毙,而當(dāng)這次請求返回以后,ServletRequest 對象被銷毀時砂碉,requestDestroyed方法將被調(diào)用蛀蜜。

? 進行一次實驗,啟動 Tomcat -> 訪問index.jsp 增蹭,將得到下面的輸出:

Tomcat 輸出1.png

? 很容易可以分析出各監(jiān)聽器的調(diào)用順序滴某,這里就不過多贅述。

ServletContextListener 的應(yīng)用——— Spring 的入口

? 大家肯定都記得在使用 Spring 的時候需要在 Web.xml 中配置一個 Spring 的監(jiān)聽器:

<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:/applicationContext.xml</param-value>
</context-param>

? context-param 是 Spring 的配置文件位置滋迈,在 Spring 啟動后會根據(jù)applicationContext.xml中的配置對 Bean 進行實例化霎奢,這里主要觀察org.springframework.web.context.ContextLoaderListener這個監(jiān)聽器。

? 當(dāng)我們進入到這個監(jiān)聽器內(nèi)部會發(fā)現(xiàn)饼灿,這個監(jiān)聽器正是實現(xiàn)了 ServletContextListener幕侠,這也符合之前所講:在contextInitialized中程序可以進行自己的初始化工作了。在這里Spring就會開始自己實際的工作赔退。

//...
public class ContextLoaderListener extends ContextLoader implements ServletContextListener {
    public ContextLoaderListener() {
    }

    public ContextLoaderListener(WebApplicationContext context) {
        super(context);
    }

    public void contextInitialized(ServletContextEvent event) {
        this.initWebApplicationContext(event.getServletContext());
    }

    public void contextDestroyed(ServletContextEvent event) {
        this.closeWebApplicationContext(event.getServletContext());
        ContextCleanupListener.cleanupAttributes(event.getServletContext());
    }
}

? 而在initWebApplicationContext方法中將會進行 Bean 的初始化等工作橙依。


? 下面看一個在項目中實際遇到過的問題证舟,新手常常會犯這種錯誤,如果沒有理解 Listener 的作用時間和范圍窗骑,往往不能很快找出錯誤原因女责。

在一個刻錄系統(tǒng)需要維護多條線程,每條線程分別與不同的刻錄機服務(wù)通過 WebService 進行通信创译。在程序啟動時抵知,需要從數(shù)據(jù)庫中獲取用戶配置過的刻錄機信息,并啟動相應(yīng)的線程软族。這里可以很快想到的做法是實現(xiàn)一個 ServletContextListener刷喜,并在contextInitialized中調(diào)用PrinterService.listAllLivePrinter()方法獲取活躍的刻錄機列表,然后開啟線程立砸。

? 然而事與愿違掖疮,在程序啟動時報錯:找不到 PrinterService。問題就出在自己實現(xiàn)的ServletContextListener和 Spring 的ContextLoaderListener同樣都是對 Servlet 容器的監(jiān)聽颗祝,那么誰先執(zhí)行呢浊闪?結(jié)論是在 web.xml中誰排在前面誰先執(zhí)行。

? 這里犯的第一個錯誤就是將自定義的 ServletContextListener放在了 Spring 的 Listener 之前螺戳。在進一步的測試中搁宾,把自定義 Listener 放到 Spring 的 Listener 之后,并且在contextInitialized方法中以如下形式調(diào)用:

private UserService userService;
private WebApplicationContext springContext;

public void contextInitialized(ServletContextEvent sce) {
        logger.debug("servletContextInitialized");
        springContext = WebApplicationContextUtils.getWebApplicationContext(sce.getServletContext());
        if (springContext!=null){
            logger.debug("get Spring ApplicationContext success");
            userService = (UserService) springContext.getBean("userService");
        }else{
            logger.error("get SpringContext failed");
            return;
        }
        userService.listAllAlive();
        logger.debug("call userService.listAllAlive() success");
    }

? WebApplicationContext 描述的是 Web 應(yīng)用中的Spring上下文倔幼,這里需要通過直接獲取 bean 的方式得到 userService 實例對象盖腿。修改以后的控制臺輸出:

自定義 listener.png

? 可以看到,在自定義的 Listener 中成功獲取到userService 并調(diào)用了userService.listAllAlive()损同。稍作總結(jié)翩腐,在這個例子中,想要在程序初始化時做一些工作揖庄,有兩點值得我們注意的地方:

  1. 在自定義的 ServiceContextListener 中獲取 Spring 裝配的實例對象栗菜,必須要將自定義 Listener 寫到 Spring 的 ContextLoaderListener 之后欠雌。
  2. 新手可能直接會在自定義 Listener中new UserService()蹄梢,這么做說明根本沒有理解 Spring 的IoC,new出來的對象與 Spring Bean 工廠生成的根本不是同一個實例富俄,其中的各種 dao 必然沒有注入禁炒,當(dāng)調(diào)用需要 dao 的方法時(往往是必然的)則會報 NPE。

? 通過這個例子可以對 ServletContextListener 有更深的認識霍比,而對于其他兩個 Listener幕袱,除了監(jiān)聽的對象不同,在用法上都是大同小異悠瞬,在理解了其調(diào)用關(guān)系之后應(yīng)該能夠很快上手使用们豌。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末涯捻,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子望迎,更是在濱河造成了極大的恐慌障癌,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,029評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件辩尊,死亡現(xiàn)場離奇詭異涛浙,居然都是意外死亡,警方通過查閱死者的電腦和手機摄欲,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,395評論 3 385
  • 文/潘曉璐 我一進店門轿亮,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人胸墙,你說我怎么就攤上這事我注。” “怎么了迟隅?”我有些...
    開封第一講書人閱讀 157,570評論 0 348
  • 文/不壞的土叔 我叫張陵仓手,是天一觀的道長。 經(jīng)常有香客問我玻淑,道長嗽冒,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,535評論 1 284
  • 正文 為了忘掉前任补履,我火速辦了婚禮添坊,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘箫锤。我一直安慰自己贬蛙,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 65,650評論 6 386
  • 文/花漫 我一把揭開白布谚攒。 她就那樣靜靜地躺著阳准,像睡著了一般。 火紅的嫁衣襯著肌膚如雪馏臭。 梳的紋絲不亂的頭發(fā)上野蝇,一...
    開封第一講書人閱讀 49,850評論 1 290
  • 那天,我揣著相機與錄音括儒,去河邊找鬼绕沈。 笑死,一個胖子當(dāng)著我的面吹牛帮寻,可吹牛的內(nèi)容都是我干的乍狐。 我是一名探鬼主播,決...
    沈念sama閱讀 39,006評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼固逗,長吁一口氣:“原來是場噩夢啊……” “哼浅蚪!你這毒婦竟也來了藕帜?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,747評論 0 268
  • 序言:老撾萬榮一對情侶失蹤惜傲,失蹤者是張志新(化名)和其女友劉穎耘戚,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體操漠,經(jīng)...
    沈念sama閱讀 44,207評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡收津,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,536評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了浊伙。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片撞秋。...
    茶點故事閱讀 38,683評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖嚣鄙,靈堂內(nèi)的尸體忽然破棺而出吻贿,到底是詐尸還是另有隱情,我是刑警寧澤哑子,帶...
    沈念sama閱讀 34,342評論 4 330
  • 正文 年R本政府宣布舅列,位于F島的核電站,受9級特大地震影響卧蜓,放射性物質(zhì)發(fā)生泄漏帐要。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,964評論 3 315
  • 文/蒙蒙 一弥奸、第九天 我趴在偏房一處隱蔽的房頂上張望榨惠。 院中可真熱鬧,春花似錦盛霎、人聲如沸赠橙。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,772評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽期揪。三九已至,卻和暖如春规个,著一層夾襖步出監(jiān)牢的瞬間凤薛,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,004評論 1 266
  • 我被黑心中介騙來泰國打工绰姻, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留枉侧,地道東北人引瀑。 一個月前我還...
    沈念sama閱讀 46,401評論 2 360
  • 正文 我出身青樓狂芋,卻偏偏與公主長得像,于是被迫代替她去往敵國和親憨栽。 傳聞我的和親對象是個殘疾皇子帜矾,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,566評論 2 349

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理翼虫,服務(wù)發(fā)現(xiàn),斷路器屡萤,智...
    卡卡羅2017閱讀 134,633評論 18 139
  • 本文包括:1珍剑、Listener簡介2、Servlet監(jiān)聽器3死陆、監(jiān)聽三個域?qū)ο髣?chuàng)建和銷毀的事件監(jiān)聽器4招拙、監(jiān)聽三個域?qū)?..
    廖少少閱讀 6,043評論 6 28
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,773評論 6 342
  • 監(jiān)聽器(listener) 監(jiān)聽器簡介 :監(jiān)聽器就是一個實現(xiàn)特定接口的普通java程序,這個程序?qū)iT用于監(jiān)聽另一個...
    奮斗的老王閱讀 2,500評論 0 53
  • 僅作為自己學(xué)習(xí)記錄使用措译,文章來自: 1别凤、http://blog.csdn.net/csh624366188/art...
    BakerZhang閱讀 1,010評論 1 5