要完成这个功能,有很大程度上,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. 上面所有的规则可以同时使用。
拦截器的源代码:
packageinterceptors; importjava.util.Enumeration; importjava.util.Map; importjava.util.Properties; importjava.io.InputStream; importjava.io.FileInputStream; importcom.opensymphony.xwork2.ActionContext; importcom.opensymphony.xwork2.ActionInvocation; importcom.opensymphony.xwork2.config.entities.ActionConfig; importcom.opensymphony.xwork2.interceptor.AbstractInterceptor; importcom.opensymphony.xwork2.util.ValueStack; public class PropertyInterceptor extends AbstractInterceptor { private static final StringDEFAULT_PATH_KEY="path"; privatestaticfinalStringDEFAULT_ENCODING_KEY="encoding"; privatestaticfinalStringDEFAULT_SEPARATOR_KEY="separator"; protectedStringpathKey=DEFAULT_PATH_KEY; protectedStringencodingKey=DEFAULT_ENCODING_KEY; protectedStringseparatorKey=DEFAULT_SEPARATOR_KEY; publicvoidsetPathKey(StringpathKey) { this.pathKey=pathKey; } publicvoidsetEncodingKey(StringencodingKey) { this.encodingKey=encodingKey; } publicvoidsetSeparatorKey(StringseparatorKey) { this.separatorKey=separatorKey; } @Override public String intercept(ActionInvocationinvocation)throwsException { ActionConfigconfig=invocation.getProxy().getConfig(); Map<String,String>parameters=config.getParams(); if(parameters.containsKey(pathKey)) { Stringpath=parameters.get(pathKey); Stringencoding=parameters.get(encodingKey); Stringseparator=parameters.get(separatorKey); if(encoding==null) encoding="UTF-8"; if(separator==null) separator=""; path=invocation.getAction().getClass().getResource(path) .getPath(); Propertiesproperties=newProperties(); InputStreamis=newFileInputStream(path); java.io.Readerreader=newjava.io.InputStreamReader(is,encoding); properties.load(reader); ActionContextac=invocation.getInvocationContext(); ValueStackstack=ac.getValueStack(); System.out.println(stack.hashCode()); Enumerationnames=properties.propertyNames(); while(names.hasMoreElements()) { // 下面会使用setValue方法修改ValueStack对象中的相应属性值 Stringname=names.nextElement().toString(); if(!name.contains(".")) stack.setValue(name,properties.get(name)); StringnewName=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)); } } returninvocation.invoke(); } }
用于测试的Action类的源代码:
packageactions; public class MyAction { privateStringname; privateIntegerprice; privateStringlog4jappenderstdout; privateStringlog4j_rootLogger; privateStringconversionPattern; public String getName() { returnname; } publicvoidsetName(Stringname) { this.name=name; } publicIntegergetPrice() { returnprice; } publicvoidsetPrice(Integerprice) { this.price=price; } publicStringgetLog4jappenderstdout() { returnlog4jappenderstdout; } publicvoidsetLog4jappenderstdout(Stringlog4jappenderstdout) { this.log4jappenderstdout=log4jappenderstdout; } publicStringgetLog4j_rootLogger() { returnlog4j_rootLogger; } publicvoidsetLog4j_rootLogger(Stringlog4j_rootLogger) { this.log4j_rootLogger=log4j_rootLogger; } publicStringgetConversionPattern() { returnconversionPattern; } publicvoidsetConversionPattern(StringconversionPattern) { this.conversionPattern=conversionPattern; } publicStringexecute() { 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); returnnull; } }
Action类的配置代码如:
<?xmlversion="1.0"encoding="UTF-8"?> <!DOCTYPEstrutsPUBLIC "-//ApacheSoftwareFoundation//DTDStrutsConfiguration2.1//EN" "http://struts.apache.org/dtds/struts-2.1.dtd"> <struts> <packagename="struts"extends="struts-default"> <interceptors> <interceptorname="property" class="interceptors.PropertyInterceptor"/> <interceptor-stackname="myStack"> <interceptor-refname="defaultStack"/> <interceptor-refname="property"/> </interceptor-stack> </interceptors> <actionname="test"class="actions.MyAction"> <interceptor-refname="myStack"/> <paramname="path">/log4j.properties</param> <paramname="encoding">UTF-8</param> <paramname="separator">_</param> <paramname="log4jappenderstdoutlayoutConversionPattern"> conversionPattern </param> </action> </package> </struts>
请将log4j.properties文件复制到WEB-INFclasses目录,并在该文件中加入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配置参数或请求参数来干预最终究输出结果了。