1. 程式人生 > >SpringMVC原始碼解析與思考

SpringMVC原始碼解析與思考

首先要知道servletContext與servletConfig

servletContext是web應用級別,是jvm程序級別;servletConfig是servlet服務級別,是執行緒級別。

定義:

ServletConfig:Servlet的配置物件,容器在初始化Servlet時通過它傳遞資訊給Servlet。
ServletContext:上下文物件,提供了一系列方法供Servlet與Web容器互動。

建立時機:
ServletConfig:在容器初始化Servlet的時候,併為其提供上下文初始化引數的名/值對的引用。
ServletContext:容器啟動的時候,併為其提供Servlet初始化引數的名/值對的引用。

一個web應用一般對應一個WEB-INF資料夾:

web.xml就是web應用級別,在web.xml中配置多個servlet:

<web-app>  
    <servlet>
        <servlet-name>AcceptLink</servlet-name>    
        <servlet-class>labmanagement.AcceptLink</servlet-class>   
        <init-param>  
          <param-name>xmlLocations</param-name>  
          <param-value>one.xml,two.xml</param-value>  
        </init-param>  
</servlet>     		
    </servlet>
    <servlet>
        <servlet-name>HelloWorld</servlet-name>    
        <servlet-class>labmanagement.HelloWorld</servlet-class>   
        <init-param>  
          <param-name>xmlLocations</param-name>  
          <param-value>one.xml,two.xml</param-value>  
        </init-param>		
    </servlet>
    <servlet-mapping>
        <servlet-name>AcceptLink</servlet-name>
        <url-pattern>/AcceptLink</url-pattern>    
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>HelloWorld</servlet-name>
        <url-pattern>/HelloWorld</url-pattern>    
    </servlet-mapping>
</web-app>

ServletConfig物件:

在Servlet的配置檔案中,可以使用一個或多個<init-param>標籤為servlet配置一些初始化引數。(配置在某個servlet標籤或者整個web-app下)
當servlet配置了初始化引數後,web容器在建立servlet例項物件時,會自動將這些初始化引數封裝到ServletConfig物件中,並在呼叫servlet的init方法時,將ServletConfig物件傳遞給servlet。進而,程式設計師通過ServletConfig物件就可以得到當前servlet的初始化引數資訊。
首先,需要建立私有變數:private ServletConfig config = null;
其次,要重寫init方法,傳入config,令this.config = config;從而獲得ServletConfig物件
最後,就可以獲得<init-parm>中的配置資訊了
//獲取初始化引數
  String value1 =this.config.getInitParameter("x1");
//獲得配置文件中<init-param>標籤下name對應的value
  String vlaue2 =this.config.getInitParameter("x2");
  //2.獲取所有的初始化引數(用Enumeration接收)
  Enumeration e =this.config.getInitParameterNames();
  while(e.hasMoreElements()){
   String name =(String) e.nextElement();
   String value= this.config.getInitParameter(name);
   System.out.println(name+ "=" + value);
  }
   在開發中ServletConfig的作用有如下三個:
1)獲得字符集編碼
  String charset =this.config.getInitParameter("charset");
2)獲得資料庫連線資訊
  String url =this.config.getInitParameter("url");
  String username =this.config.getInitParameter("username");
  String password =this.config.getInitParameter("password");
3)獲得配置檔案
  String configFile =this.config.getInitParameter("config");

ServletContext物件:


WEB容器在啟動時,它會為每個WEB應用程式都建立一個對應的ServletContext物件,它代表當前web應用。
 1)ServletContext物件應用1:多個web元件之間使用它實現資料共享
 ServletConfig物件中維護了ServletContext物件的引用,開發人員在編寫servlet時,可以通過ServletConfig.getServletContext方法獲得ServletContext物件。由於一個WEB應用中的所有Servlet共享同一個ServletContext物件,因此Servlet物件之間可以通過ServletContext物件來實現通訊。ServletContext物件通常也被稱之為context域物件。
在serlvet中,可以使用如下語句來設定資料共享
  ServletContext context =this.getServletContext(); //servletContext域物件
  context.setAttribute("data","共享資料"); //向域中存了一個data屬性
在另一個servlet中,可以使用如下語句來獲取域中的data屬性
  ServletContext context =this.getServletContext();
  String value = (String)context.getAttribute("data");  //獲取域中的data屬性
  System.out.println(value);
 2)通過servletContext物件獲取到整個web應用的配置資訊
  String url =this.getServletContext().getInitParameter("url");
  String username =this.getServletContext().getInitParameter("username");
  String password =this.getServletContext().getInitParameter("password");
  3)通過servletContext物件實現servlet轉發
由於servlet中的java資料不易設定樣式,所以serlvet可以將java資料轉發到JSP頁面中進行處理
 this.getServletContext().setAttribute("data","serlvet資料轉發");
  RequestDispatcher rd =this.getServletContext().getRequestDispatcher("/viewdata.jsp");
  rd.forward(request,response);
 4)通過servletContext物件讀取資原始檔
 在實際開發中,用作資原始檔的檔案型別,通常是:xml、properties,而讀取xml檔案必然要進行xml文件的解析,所以以下例子只對properties檔案進行讀取(在一個web工程中,只要涉及到寫地址,建議最好以/開頭)
 在web工程中,我們一般來說,是不能採用傳統方式讀取配置檔案的,因為相對的是jvm的啟動目錄(tomcat的bin目錄),所以我們要使用web絕對目錄來獲取配置檔案的地址
  讀取資原始檔的三種方式:
 第一種:使用ServletContext的getResourceAsStream方法:返回資原始檔的讀取位元組流
  InputStream in =this.getServletContext().getResourceAsStream("/WEB-INF/classes/db.properties");
  Properties prop = newProperties();  
  prop.load(in);
  String url =prop.getProperty("url");
 第二種:使用ServletContext的getRealPath方法,獲得檔案的完整絕對路徑path,再使用位元組流讀取path下的檔案
  String path =this.getServletContext().getRealPath("/WEB-INF/classes/db.properties");
  String filename =path.substring(path.lastIndexOf("\\")+1); 
  //相比第一種方法的好處是:除了可以獲取資料,還可以獲取資原始檔的名稱
  FileInputStream in = newFileInputStream(path);
  Properties prop = newProperties();
  prop.load(in);
  String url =prop.getProperty("url");
 第三種:使用ServletContext的getResource方法,獲得一個url物件,呼叫該類的openStream方法返回一個位元組流,讀取資料
  URL url =this.getServletContext().getResource("/WEB-INF/classes/db.properties");
  InputStream in =url.openStream();
  Properties prop = newProperties();
  prop.load(in);
  String url1 =prop.getProperty("url");
  5)web工程中,不同位置的資原始檔的讀取方式
  一、當資原始檔在包下面時
  InputStream in =this.getServletContext().getResourceAsStream("/WEB-INF/classes/cn/itcast/context/db.properties");
  System.out.println(in);

 二、資原始檔在web-inf下
  in =this.getServletContext().getResourceAsStream("/WEB-INF/db.properties");
  System.out.println(in);
  
  三、資原始檔在web工程中
  in =this.getServletContext().getResourceAsStream("/db.properties");
  System.out.println(in);

******************************************************************************************************************

SpringMVC載入WEB-INF中web.xml之後,web容器會建立一個servletContext物件,這個物件會載入web.xml中配置的資訊。其中包含servlet資訊,webApplicationContext類資訊,和重要的ContextLoaderListener類資訊。

web.xml中配置如下:

<context-param>
	<param-name>contextClass</param-name>
	<param-value>com.web.controller.env.MyWebApplicationContext</param-value>
</context-param>

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

<servlet>
		<servlet-name>authStatusServlet</servlet-name>
		<servlet-class>com.ids.client.AuthStatusServlet</servlet-class>
		<load-on-startup>1</load-on-startup>
</servlet>

<servlet-mapping>
		<servlet-name>authStatusServlet</servlet-name>
		<url-pattern>/authStatus</url-pattern>
</servlet-mapping>

<servlet>
		<servlet-name>popupLoginSuccessServlet</servlet-name>
		<servlet-class>com.ids.client.PopupLoginSuccessServlet</servlet-class>
		<load-on-startup>2</load-on-startup>
</servlet>

<servlet-mapping>
		<servlet-name>popupLoginSuccessServlet</servlet-name>
		<url-pattern>/popupLoginSuccess</url-pattern>
</servlet-mapping>


接著根據webApplicationContext資訊建立webApplicationContext的監聽和初始化。

ContextLoaderListener就是ServletContextListener是監聽servlet前期工作,比如建立beanFactory,載入servlet載入需要的bean。


web.xml中註冊監聽器:

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

initWebApplicationContext如下:


initWebApplicationContext方法結束!!!


webApplicationContext:


Class<?> contextClass    determineContextClass(ServletContextservletContext )方法如下:



到此只是講述了spring中,servletContext->servletContextListernner->webApplicationContext.

說到這裡,對於springMVC中除了很基礎的web.xml(web應用基礎配置)還有兩個很重要的和spring相關的配置檔案,分別是applicationcontext.xml和spring-servlet.xml。這兩個配置檔案在web.xml中都要宣告,而且要使用applicationcontext.xml,servletContextListernner必須宣告,servletContextListernner的其中很重要的工作就是載入applicationcontext.xml,並且建立BeanFactory.載入applicationcontext.xml(用來宣告全域性的bean物件)中全域性的bean物件到webApplicationContext中。

webApplicationContext中包含了applicationcontext資訊,servlet資訊等。然後webApplicationContext載入其含有的servlet資訊,並對servlet內部的spring-servlet進行解析。

web.xml中applicationcontext.xml和spring-servlet.xml配置:

 <!-- 初始化Spring容器並載入Spring配置檔案applicationContext.xml,預設在WebRoot/WEB-INF目錄下面 ,
 可以通過<context-param>的contextConfigLocation屬性指定路徑-->
    <context-param>
         <param-name>contextConfigLocation</param-name>
         <param-   value>classpath:com/lince/config/applicationContext.xml</param-value>
    </context-param> 
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
<!-- 載入DispatcherServlet並載入其的配置檔案spring3-servlet.xml,預設也是在WEB-INF目錄下 -->
    <servlet>
        <servlet-name>spring3</servlet-name>        <!-- 預設找到的是spring3-servlet.xml -->
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
         <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:com/lince/config/spring3-servlet.xml</param-value>
        </init-param> 
        <load-on-startup>1</load-on-startup>
    </servlet>

到此還沒有載入servlet.下面繼續講

spring中的servlet是DispacherServlet不過也是繼承httpServlet,然後對init,post,get等方法進行了封裝。

首先我們寫自己servlet然後在web.xml中宣告,很明顯我們的selfServlet要整合httpServlet


spring 的核心就是DispacherServlet,然後對init,post,get,put等方法進行封裝,其中init也是spring實現的核心關鍵方法。

servletContext(載入web.xml)->載入和建立servletContextListernner->載入web.xml中webApplicationContext類資訊

建立webApplicationContext->載入servlet資訊->呼叫init()方法->建立servletConfig資訊->建立servlet

spring中init方法:



到此init方法結束!!!

這段程式碼主要建立servletConfig和initServletBean

servletConfig 建立對應ServletConfigPropertyValue():


initServletBean:



這裡又再次呼叫了initWebApplicationContext 是對之前的WebApplicationContext 的建立或者補充,並對servlet使用的例項進行初始化:



spring-servlet中聲明瞭servlet的controller和service等掃描資訊,記錄了攔截器鏈的攔截路徑資訊(mapping),記錄servlet Mappling資訊和對應controller的Mapping資訊。


onrefresh()中對servlet的Mapping和根據controller建立攔截鏈,建立對應的handler。