版權(quán)所有：(xiaodaoxiaodao)藍(lán)小刀
??
xiaodaoxiaodao@gmail.com
http://www.tkk7.com/xiaodaoxiaodao/archive/2007/04/26/113666.html
????
??
轉(zhuǎn)載請(qǐng)注明來(lái)源/作者
?
Struts
源碼學(xué)習(xí)之ActionServlet
(
一)
?
Struts
源碼最新版本為
struts-1.3.8-src.zip
（
12-Mar-2007 00:06
）
學(xué)習(xí)筆記使用struts-1.3.5-src.zip
的源碼，
下載地址：http://archive.apache.org/dist/struts/source/
1．?
在web.xml中通過(guò)下面定義把所有的*.do交給ActionServlet處理
?
<!-- Standard Action Servlet Configuration (with debugging) -->
<servlet>
??? <servlet-name>action</servlet-name>
??? <servlet-class>org.apache.struts.action.ActionServlet</servlet-class>
??? <init-param>
????? <param-name>config</param-name>
????? <param-value>
????????? /WEB-INF/struts-config.xml,
????????? /WEB-INF/struts-config-Wildcard.xml
?????? </param-value>
??? </init-param>
???
<load-on-startup>2</load-on-startup>
? </servlet>
?
? <!-- Standard Action Servlet Mapping -->
? <servlet-mapping>
??? <servlet-name>action</servlet-name>
??? <url-pattern>*.do</url-pattern>
? </servlet-mapping>
?
2．?
下面研究一下struts的源碼，由于servlet設(shè)置了load-on-startup，所以tomcat啟動(dòng)時(shí)會(huì)加載ActionServlet，也就是會(huì)執(zhí)行ActionServlet中的init()方法，Struts 的初始化實(shí)現(xiàn)就是在這里實(shí)現(xiàn)的。
?
注：
由于servlet的生命周期為 web容器加載和實(shí)例化類/init()初始化/service()請(qǐng)求處理/destroy()四個(gè)階段，而init()方法在tomcat啟動(dòng)后只執(zhí)行一次，所以如果想在tomcat啟動(dòng)后用debug模式查看ActionServlet中init()方法的執(zhí)行，可以把上面的<load-on-startup>2</load-on-startup>注釋掉就可以了（不過(guò)真正開(kāi)發(fā)時(shí)還是需要的）。
?
3．?
在ActionServlet中定義了一些常量，如下：
???
//
默認(rèn)的struts配置文件為/WEB-INF/struts-config.xml
??? protected String config = "/WEB-INF/struts-config.xml"; //
②
initOther();
⑤
initModuleConfig ();
?
???
//
默認(rèn)的鏈（定義了一個(gè)按順序執(zhí)行的處理流程）配置文件
protected String chainConfig = "org/apache/struts/chain/chain-config.xml";
//
④
initChain();
?
protected Digester configDigester = null; //
⑤
initModuleConfig ();
//
如convertNull
為true，Java包裝類（如java.lang.Integer）的初始值為null
protected boolean convertNull = false; //
②
initOther();
?
protected MessageResources internal = null; //
①
initInternal();
//
默認(rèn)的
struts-core-1.3.5.jar
包
中資源文件為ActionResources.properties
protected String internalName = "org.apache.struts.action.ActionResources";
//
①
initInternal();
?
//
一些文檔類型定義，用來(lái)驗(yàn)證相應(yīng)的配置文件如struts-config.xml是否正確
??? protected String[] registrations =
??????? {
??????????? "-//Apache Software Foundation//DTD Struts Configuration 1.0//EN",
??????????? "/org/apache/struts/resources/struts-config_1_0.dtd",
?????????
??"-//Apache Software Foundation//DTD Struts Configuration 1.1//EN",
??????????? "/org/apache/struts/resources/struts-config_1_1.dtd",
??????????? "-//Apache Software Foundation//DTD Struts Configuration 1.2//EN",
??????????? "/org/apache/struts/resources/struts-config_1_2.dtd",
??????????? "-//Apache Software Foundation//DTD Struts Configuration 1.3//EN",
??????????? "/org/apache/struts/resources/struts-config_1_3.dtd",
??????????? "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN",
??????????? "/org/apache/struts/resources/web-app_2_3.dtd"
??????? }; //
③
initServlet();
??? protected String servletMapping = null; //
③
initServlet();
protected String servletName = null; //
③
initServlet();
?
4．?
ActionServlet
中的init()方法執(zhí)行流程如下
?
?
① 內(nèi)部資源文件
ActionResources.properties
的初始化
initInternal();
protected MessageResources internal = null; //
①
initInternal();
protected String internalName = "org.apache.struts.action.ActionResources"; //
①
initInternal();
?
// initInternal
方法中通過(guò)下面得到一個(gè)MessageResources對(duì)象
internal = MessageResources.getMessageResources(internalName);
此資源文件主要包括一些消息信息的定義,具體可參考org.apache.struts.action下的ActionResources.properties文件
?
在MessageResources.java中的getMessageResources方法，
???????
if (defaultFactory == null) {
??????????? defaultFactory = MessageResourcesFactory.createFactory();
//
⑴
??????? }
??????? return defaultFactory.createResources(config); //
傳入internalName
//
⑵
?
⑴
MessageResourcesFactory.createFactory()
所做的工作：
protected static transient Class clazz = null;
protected static String factoryClass =
??????? "org.apache.struts.util.PropertyMessageResourcesFactory";
clazz = RequestUtils.applicationClass(factoryClass);
而RequestUtils.applicationClass通過(guò)classLoader加載一個(gè)
org.apache.struts.util.PropertyMessageResourcesFactory
?
⑵
defaultFactory.createResources(config)
所做的工作：
this.factory = factory;
("org.apache.struts.util.PropertyMessageResourcesFactory")
this.config = config;("org.apache.struts.action.ActionResources")
this.returnNull = returnNull;(true)
PropertyMessageResourcesFactory extends MessageResourcesFactory
返回一個(gè)MessageResources對(duì)象
?
?
② 調(diào)用
initOther();
從web.xml中加載ActionServlet的初始化參數(shù)，包括config/
convertNull
protected String config = "/WEB-INF/struts-config.xml"; //
②
initOther();
protected boolean convertNull = false; //
②
initOther();
?
//
得到web.xml中"config"參數(shù)
String value;
value = getServletConfig().getInitParameter("config");
if (value != null) {
??? config = value;
}
???
<servlet>
??????? <servlet-name>action</servlet-name>
??????? <servlet-class>org.apache.struts.action.ActionServlet</servlet-class>
??????? <init-param>
??????????? <param-name>config</param-name>?? <!--
得到"config"參數(shù)-->
??????????? <param-value>/WEB-INF/struts-config.xml</param-value>
??????? </init-param>
??????? <init-param>
??????????? <param-name>convertNull</param-name>? ?<!--
得到"convertNull"參數(shù)-->
??????????? <param-value>true</param-value>
??????? </init-param>
??????? .......
??? </servlet>
??
?
//
獲得convertNull的值（true/yes/on/y/1）
getServletConfig().getInitParameter("convertNull");
如果這個(gè)參數(shù)的值為 true
（true/yes/on/y/1）
,
數(shù)值型(BigDecimal/BigInteger/Boolean/Byte/Character/Double/Float/Integer/Long/Short)的Java 包裝類（比如java.lang.Integer）的初始值為null，而非0。缺省值[false]
?
使其初始值為null的方法如下：
//
將所有的轉(zhuǎn)換器注銷掉
ConvertUtils.deregister();
//
為指定類型clazz注冊(cè)轉(zhuǎn)換器converter
ConvertUtils.register(new BigDecimalConverter(null), BigDecimal.class);
ConvertUtils.register(new BigIntegerConverter(null),BigInteger.class);
.......
?
注：
ConvertUtils
用法如下
deregister
()
和
deregister
(java.lang.Class?clazz)
注銷轉(zhuǎn)換器，前者將所有的轉(zhuǎn)換器注銷掉，后者只注銷對(duì)應(yīng)于clazz的轉(zhuǎn)換器register(
Converter
?converter, java.lang.Class?clazz)
為指定類型clazz注冊(cè)轉(zhuǎn)換器converter。如果clazz已經(jīng)存在一個(gè)對(duì)應(yīng)的轉(zhuǎn)換器，那么converter覆蓋原來(lái)的轉(zhuǎn)換器。
?
?
③ 調(diào)用
initServlet();
從web.xml中加載ActionServlet的初始化參數(shù)如servlet-name，加載DTD文件并把其放入HashMap緩存，讀取并解析web.xml的內(nèi)容
// Remember our servlet name
getServletConfig().getServletName();
<servlet>
??????? <servlet-name>action</servlet-name>
??????? <servlet-class>org.apache.struts.action.ActionServlet</servlet-class>
??????? <init-param>
??????????? <param-name>config</param-name>?? <!--
得到"config"參數(shù)-->
??????????? <param-value>/WEB-INF/struts-config.xml</param-value>
??????? </init-param>
??????? <init-param>
??????????? <param-name>convertNull</param-name>? ?<!--
得到"convertNull"參數(shù)-->
??????????? <param-value>true</param-value>
??????? </init-param>
??????? .......
??? </servlet>
?
// Prepare a Digester to scan the web application deployment descriptor
Digester digester = new Digester();
//
把當(dāng)前的 ActionServlet 對(duì)象放入到解析堆棧中
digester.push(this);
//
指明要考慮命名空間
digester.setNamespaceAware(true);
//
缺省值[false]
，解析器只是檢查XML是否格式良好(well formed)
digester.setValidating(false);
?
// Register our local copy of the DTDs that we can find
//
struts
可使用
struts-core-1.3.5.jar
包
中的DTD中來(lái)處理struts配置文件，這樣可適用于那些沒(méi)有連接到internet的應(yīng)用環(huán)境
??????? for (int i = 0; i < registrations.length; i += 2) {
??????????? URL url = this.getClass().getResource(registrations[i + 1]);
?
??????????? if (url != null) {
???????????????
//
讀取DTD文件并把其放入
HashMap
緩存
??????????????? digester.register(registrations[i], url.toString());
??????????? }
??????? }
?
/************************************************************
//
一些文檔類型定義，用來(lái)驗(yàn)證相應(yīng)的配置文件如struts-config.xml是否正確
??? protected String[] registrations =
??????? {
??????????? "-//Apache Software Foundation//DTD Struts Configuration 1.0//EN",
??????????? "/org/apache/struts/resources/struts-config_1_0.dtd",
??????????? "-//Apache Software Foundation//DTD Struts Configuration 1.1//EN",
??????????? "/org/apache/struts/resources/struts-config_1_1.dtd",
??????????? "-//Apache Software Foundation//DTD Struts Configuration 1.2//EN",
??????????? "/org/apache/struts/resources/struts-config_1_2.dtd",
??????????? "-//Apache Software Foundation//DTD Struts Configuration 1.3//EN",
??????????? "/org/apache/struts/resources/struts-config_1_3.dtd",
??????????? "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN",
??????????? "/org/apache/struts/resources/web-app_2_3.dtd"
??????? }; //
③
initServlet();
************************************************************/
?
// Configure the processing rules that we need
//
運(yùn)行時(shí)，digester 就會(huì)調(diào)用 ActionServlet中的 addServletMapping() 方法，并傳入兩個(gè)參數(shù)
digester.addCallMethod("web-app/servlet-mapping", "addServletMapping", 2);
digester.addCallParam("web-app/servlet-mapping/servlet-name", 0);
digester.addCallParam("web-app/servlet-mapping/url-pattern", 1);
得到
<servlet-mapping>
??? <servlet-name>action</servlet-name>
??? <url-pattern>*.do</url-pattern>
</servlet-mapping>
?
/************************************************************
//
來(lái)判斷當(dāng)前
servlet
名稱是否為正在運(yùn)行的
servlet
名稱，如是，就把
url-pattern
作為
servletMapping
public void addServletMapping(String servletName, String urlPattern) {
??????? if (servletName == null) {
??????????? return;
??????? }
??????? if (servletName.equals(this.servletName)) {
??????????? if (log.isDebugEnabled()) {
??????????????? log.debug("Process servletName=" + servletName
??????????????????? + ", urlPattern=" + urlPattern);
??????????? }
??????????? this.servletMapping = urlPattern;
??????? }
}
************************************************************/
?
//
讀取配置文件web.xml的內(nèi)容
InputStream input = getServletContext().getResourceAsStream("/WEB-INF/web.xml");
//
如找不到/WEB-INF/web.xml文件，則報(bào)錯(cuò)
if (input == null) {
??? log.error(internal.getMessage("configWebXml"));
??? throw new ServletException(internal.getMessage("configWebXml"));
}
/************************************************************
//
報(bào)錯(cuò)信息定義在org\apache\struts\action\ActionResources.properties中
configWebXml=The /WEB-INF/web.xml was not found.
************************************************************/
?
//
解析input流文件，每讀到一個(gè)節(jié)點(diǎn)元素就觸發(fā)一個(gè)事件
digester.parse(input);
?
注：
Digester
是一個(gè)基于
DOM
的
SAX
實(shí)現(xiàn)的類，它是事件觸發(fā)的，可以將XML文件轉(zhuǎn)換為任意的Java對(duì)象，支持規(guī)則的對(duì)任意XML文檔的處理。原先是struts項(xiàng)目的一部分，后因其通用性而劃歸Commons子項(xiàng)目。
?
//
把servletMapping存儲(chǔ)到servletContext中，屬性名為Globals.SERVLET_KEY
（
"
org.apache.struts.action.SERVLET_MAPPING
"
）
if (servletMapping != null) {
??? getServletContext().setAttribute(Globals.SERVLET_KEY,servletMapping);
}
?
?
?
版權(quán)所有：(xiaodaoxiaodao)藍(lán)小刀
??
xiaodaoxiaodao@gmail.com
?