Spring MVC深入源碼之二FrameworkServlet上篇

上一篇講了Spring MVC中HttpServletBean的源碼,本篇會順著類的繼承結構來講一下HttpServletBean的子類FrameworkServlet。所有源碼都是基于spring-framework-4.3.5.RELEASE

前篇講的HttpServletBean功能上還沒有涉及到和Spring MVC框架有關的東西,而FrameworkServlet從名字上就可以推斷出,它已經和框架緊密結合在一起了。簡單來說,它有下面這些特性和作用:

  1. 它是Spring web framework的一個基礎servlet,提供了和Spring ApplicationContext的集成(關于ApplicationContext會在以后的文章中詳細解釋),它管理著一個WebApplicationContext的實例,會發布一個事件消息在處理完一個請求之后

  2. 它的子類必須實現doService方法來處理接受到的請求

  3. 它會檢測在web.xml中的servlet參數配置中是否存在contextClass,如果存在的話,就會實例化指定的context class,如果不存在就會使用默認的XmlWebApplicationContext

接下來,源碼伺候

public abstract class FrameworkServlet 
    extends HttpServletBean implements ApplicationContextAware {

FrameworkServlet除了繼承了HttpServletBean還實現了ApplicationContextAware接口,這個接口中定義了一個setApplicationContext的方法,這個方法留下了一個入口以便于框架在之后可以通過它setApplicationContext的實例。

接下來看看這個類中一些關鍵的靜態及成員變量

public static final String DEFAULT_NAMESPACE_SUFFIX = "-servlet";
public String getNamespace() {   
    return (this.namespace != null ? 
        this.namespace : getServletName() + DEFAULT_NAMESPACE_SUFFIX);
}

這里定義了一個常量DEFAULT_NAMESPACE_SUFFIX, 以及一個getNameSpace的方法,getNameSpace會返回你在web.xml中配置的servlet-name加上"-servlet",這個namespace會在之后application context加載spring配置文件時候用到,比如你給servlet取名叫MySpringServlet,那么當Spring初始化的時候,會去尋找名為/WEB-INF/MySpringServlet-servlet.xml的配置文件。

public static final Class<?> DEFAULT_CONTEXT_CLASS = 
    XmlWebApplicationContext.class;
private Class<?> contextClass = DEFAULT_CONTEXT_CLASS;

默認的applicationContext類,即XmlWebApplicationContext

這個類中最重要的一個成員方法是initServletBean, 這個方法是在父類HttpServletBean中的一個鉤子方法(hook method), 也就是定義是在父類中,但是實現是在子類。如果你看了上一篇文章就會知道在父類init的時候會調用這個鉤子方法。

這個方法其實非常簡單

  • 489行 調用initWebApplicationContext方法初始化一個WebApplicationContext,現在大家知道平時經常提到的application context是在哪里生成的了吧,沒錯,就是在這里。

  • 490行 調用initFrameworkServlet方法,這個方法又是一個鉤子方法,在當前類里只有一個空的實現,真正的實現是在子類DispatcherServlet中。

接下來我們著重看一下initWebApplicationContext方法

  • 523-524行 嘗試從ServletContext中尋找根上下文(root context),如果你在web.xml中定義過ContextLoaderListener,那么Spring framework就會先初始化一個根的application context并設置到ServletContext的一個attribute中,如果沒有定義,那這一步就會得到到一個null,不過沒有影響。

  • 527-538行 在代碼段開始會去判斷當前對方的一個webApplicationContext成員變量是不是有值,因為FrameworkServlet中有一個構造函數是允許傳入一個現成的applicationContext,所以如果存在的話就不需要再new一個applicationContext了。

  • 539-541行 如果wac變量仍然為null,就會嘗試在ServletContext中去查找是否存在一個已經初始化過的WebApplicationContext.

  • 542-544行 調用createWebApplicationContext方法(下文會繼續深入這個方法),這里就是真正去創建一個新的WebApplicationContext的地方了,并且會把上面獲取到的rootContext(可能為null)作為參數傳入。

  • 546-548行 可以看到有一個變量this.refreshEventReceived去標志類中的onRefresh方法是不是已經被調用過,如果沒有,那就調用onRefresh

  • 550-557行 通過變量this.publishContext來決定是不是要把初始化后的WebApplicationContext設置到ServletContext的attrbiute里去。

相信大家現在對FrameworkServlet這個class的職責有了更加深入的理解,Spring中最重要的applicationContext的初始化就是它來干的。

出于方便大家閱讀和理解(源碼這東西本來消化起來就不容易),我會把createWebApplicationContext方法的解釋放到下一篇文章里詳細說明。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,763評論 6 539
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,238評論 3 428
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,823評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,604評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,339評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,713評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,712評論 3 445
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,893評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,448評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,201評論 3 357
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,397評論 1 372
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,944評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,631評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,033評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,321評論 1 293
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,128評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,347評論 2 377

推薦閱讀更多精彩內容