本文为原创,如需转载,请注明作者和出处,谢谢!
源码与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类的对象实例压入ValueStack对象中(实际上,ValueStack对于相当一个栈),而ValueStack类的setValue和findValue方法可以设置和获得Action对象的属性值。Struts 2中的某些拦截器正是通过ValueStack类的setValue方法来修改Action类的属性值的。如params拦截器用于将请求参数值映射到相应成Action类的属性值。在params拦截器中在获得请求参数值后,会使用setValue方法设置相应的Action类的属性。
从这一点可以看出,ValueStack对象就象一个传送带,当客户端请求.action时,Struts 2在创建相应用Action对象后就将Action对象放到了ValueStack传送带上,然后ValueStack传送带会带着Action对象经过若干拦截器,在每一拦截器中都可以通过ValueStack对象设置和获得Action对象中的属性值。实际上,这些拦截器就相当于流水线作业。如果要对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配置参数或请求参数来干预最终究输出结果了。
下一篇:
Struts 2杂谈(2):如何向标签文件中的Struts 2标签传递参数值
新浪微博:http://t.sina.com.cn/androidguy 昵称:李宁_Lining