源碼與jar包下載(將rar改成jar,直接放在WEB_INF\lib目錄中即可)
眾所周知,Strut 2的Action類通過屬性可以獲得所有相關的值,如請求參數、Action配置參數、向其他Action傳遞屬性值(通過chain結果)等等。要獲得這些參數值,我們要做的唯一一件事就是在Action類中聲明與參數同名的屬性,在Struts 2調用Action類的Action方法(默認是execute方法)之前,就會為相應的Action屬性賦值。
要完成這個功能,有很大程度上,Struts 2要依賴於ValueStack對象。這個對象貫穿整個Action的生命周期(每個Action類的對象實例會擁有一個ValueStack對象)。當Struts 2接收到一個.action的請求後,會先建立Action類的對象實例,但並不會調用Action方法,而是先將Action類的相應屬性放到ValueStack對象的頂層節點(ValueStack對象相當於一個棧)。只是所有的屬性值都是默認的值,如String類型的屬性值為null,int類型的屬性值為0等。
在處理完上述工作後,Struts 2就會調用攔截器鏈中的攔截器,當調用完所有的攔截器後,最後會調用Action類的Action方法,在調用Action方法之前,會將ValueStack對象頂層節點中的屬性值賦給Action類中相應的屬性。大家要注意,在這裡就給我們帶來了很大的靈活性。也就是說,在Struts 2調用攔截器的過程中,可以改變ValueStack對象中屬性的值,當改變某個屬性值後,Action類的相應屬性值就會變成在攔截器中最後改變該屬性的這個值。
從上面的描述很容易知道,在Struts 2的的Action類可以獲得與屬性同名的參數值就是通過不同的攔截器來處理的,如獲得請求參數的攔截器是params,獲得Action的配置參數的攔截器是staticParams等。在這些攔截器內部讀取相應的值,並更新ValueStack對象頂層節點的相應屬性的值。而ValueStack對象就象一個傳送帶,將屬性值從一個攔截器傳到了另一個攔截器(當然,在這其間,屬性值可能改變),最後會傳到Action對象,並將ValueStack對象中的屬性的值終值賦給Action類的相應屬性。
也許有的讀者會看出來一個問題,如果有多個攔截器都改變同一個屬性值,那麼在後面引用的攔截器將覆蓋之前引用的攔截器改變的屬性值。由於在defaultStack攔截器棧中staticParams是在params之前引用的,因此,如果某個請求參數與Action類的配置參數同名的話,請求參數值將覆蓋配置參數值。
下面我們使用一個例子來演示這個過程。在這個例子中實現了一個攔截器,該攔截器的功能是將一個屬性文件中的key-value對映射成相應的屬性的值。如下面是一個屬性文件的內容:
name = 超人
price = 10000
我們可以在Action類中定義name和price屬性,在Action中引用這個攔截器後,就會自動為屬性賦值。
在使用該攔截器有如下規則:
1. 攔截器讀取的屬性文件路徑由path參數指定。
2. 屬性文件的編碼格式由encoding參數指定,默認值是UTF-8。
3. 如果某個key中包含有“.”(該符號不能出現在標識符中),則有如下處理方法:
(1)將Action類的屬性名定義為去掉“.”的key。例如,key為person.name,而屬性名可定義為personname。
(2)將Action類的屬性名定義為將“.”替換成其他字符的表示符號。例如,key為person.name,而屬性名可定義為person_name,其中“_”由separator參數指定。
4. 如果key太長,也可以直接使用Action參數進行映射,例如,key為country.person.name,可做如下映射:
<param name="countrypersonname">name</param>
要注意的是,name屬性值不能包含“.”,因此,應將key值中的“.”去掉。現在就可以直接在Action類中定義名為name的屬性的,name屬性的值會與key值相同。
5. 上面所有的規則可以同時使用。
攔截器的源代碼:
package interceptors; import java.util.Enumeration; import java.util.Map; import java.util.Properties; import java.io.InputStream; import java.io.FileInputStream; import com.opensymphony.xwork2.ActionContext; import com.opensymphony.xwork2.ActionInvocation; import com.opensymphony.xwork2.config.entities.ActionConfig; import com.opensymphony.xwork2.interceptor.AbstractInterceptor; import com.opensymphony.xwork2.util.ValueStack; public class PropertyInterceptor extends AbstractInterceptor { private static final String DEFAULT_PATH_KEY = "path"; private static final String DEFAULT_ENCODING_KEY = "encoding"; private static final String DEFAULT_SEPARATOR_KEY = "separator"; protected String pathKey = DEFAULT_PATH_KEY; protected String encodingKey = DEFAULT_ENCODING_KEY; protected String separatorKey = DEFAULT_SEPARATOR_KEY; public void setPathKey(String pathKey) { this.pathKey = pathKey; } public void setEncodingKey(String encodingKey) { this.encodingKey = encodingKey; } public void setSeparatorKey(String separatorKey) { this.separatorKey = separatorKey; } @Override public String intercept(ActionInvocation invocation) throws Exception { ActionConfig config = invocation.getProxy().getConfig(); Map<String, String> parameters = config.getParams(); if (parameters.containsKey(pathKey)) { String path = parameters.get(pathKey); String encoding = parameters.get(encodingKey); String separator = parameters.get(separatorKey); if (encoding == null) encoding = "UTF-8"; if (separator == null) separator = ""; path = invocation.getAction().getClass().getResource(path) .getPath(); Properties properties = new Properties(); InputStream is = new FileInputStream(path); java.io.Reader reader = new java.io.InputStreamReader(is, encoding); properties.load(reader); ActionContext ac = invocation.getInvocationContext(); ValueStack stack = ac.getValueStack(); System.out.println(stack.hashCode()); Enumeration names = properties.propertyNames(); while (names.hasMoreElements()) { // 下面會使用setValue方法修改ValueStack對象中的相應屬性值 String name = names.nextElement().toString(); if (!name.contains(".")) stack.setValue(name, properties.get(name)); String newName = null; newName = parameters.get(name.replaceAll("\\.", "")); if (newName != null) stack.setValue(newName, properties.get(name)); if (!separator.equals("")) { newName = name.replaceAll("\\.", ""); stack.setValue(newName, properties.get(name)); } newName = name.replaceAll("\\.", separator); stack.setValue(newName, properties.get(name)); } } return invocation.invoke(); } }
用於測試的Action類的源代碼:
package actions; public class MyAction { private String name; private Integer price; private String log4jappenderstdout; private String log4j_rootLogger; private String conversionPattern; public String getName() { return name; } public void setName(String name) { this.name = name; } public Integer getPrice() { return price; } public void setPrice(Integer price) { this.price = price; } public String getLog4jappenderstdout() { return log4jappenderstdout; } public void setLog4jappenderstdout(String log4jappenderstdout) { this.log4jappenderstdout = log4jappenderstdout; } public String getLog4j_rootLogger() { return log4j_rootLogger; } public void setLog4j_rootLogger(String log4j_rootLogger) { this.log4j_rootLogger = log4j_rootLogger; } public String getConversionPattern() { return conversionPattern; } public void setConversionPattern(String conversionPattern) { this.conversionPattern = conversionPattern; } public String execute() { System.out.println("name:" + name); System.out.println("price:" + price); System.out.println("log4jappenderstdout:" + log4jappenderstdout); System.out.println("log4j_rootLogger:" + log4j_rootLogger); System.out.println("conversionPattern:" + conversionPattern); return null; } }
Action類的配置代碼如:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.1//EN" "http://struts.apache.org/dtds/struts-2.1.dtd"> <struts> <package name="struts" extends="struts-default"> <interceptors> <interceptor name="property" class="interceptors.PropertyInterceptor" /> <interceptor-stack name="myStack"> <interceptor-ref name="defaultStack" /> <interceptor-ref name="property" /> </interceptor-stack> </interceptors> <action name="test" class="actions.MyAction"> <interceptor-ref name="myStack" /> <param name="path">/log4j.properties</param> <param name="encoding">UTF-8</param> <param name="separator">_</param> <param name="log4jappenderstdoutlayoutConversionPattern"> conversionPattern </param> </action> </package> </struts>
請將log4j.properties文件復制到WEB-INF\classes目錄,並在該文件中加入name和price屬性。
測試結果:
name:中國
price:34
log4jappenderstdout:org.apache.log4j.ConsoleAppender
log4j_rootLogger:error,stdout
conversionPattern:%d{ABSOLUTE}%5p%c{1}:%L-%m%n
由於property攔截器在defaultStack後引用,因此,在該攔截器中設置的屬性值是最終結果,如果將property攔截器放在defaultStack前面(將兩個<interceptor-ref>元素掉換一下),就可以通過同名勝Action配置參數或請求參數來干預最終究輸出結果了。