Struts 2中启用json ajax支持
JSON插件提供了一种名为json的ResultType,一旦为某个Action指定了一个类型为json的Result,则该Result无需映射到任何视图资源。因为JSON插件会负责将Action里的状态信息序列化成JSON格式的数据,并将该数据返回给客户端页面的JavaScript。
简单地说,JSON插件允许我们在JavaScript中异步调用Action,而且Action不再需要使用视图资源来显示该Action里的状态信息,而是由JSON插件负责将Action里的状态信息返回给调用页面——通过这种方式,就可以完成Ajax交互。
Struts2提供了一种可插拔方式来管理插件,安装Struts2的JSON插件与安装普通插件并没有太大的区别,一样只需要将Struts2插件的JAR文件复制到Web应用的WEB-INF/lib路径下即可。
安装JSON插件按如下步骤进行:
(1)登陆http://code.google.com/p/jsonplugin/downloads/list站点,下载Struts2的JSON插件的最新版本,当前最新版本是0.7,我们可以下载该版本的JSON插件。
(2)将下载到的jsonplugin-0.7.jar文件复制到Web应用的WEB-INF路径下,即可完成JSON插件的安装。
实现Actio逻辑
假设输入页面中包含了三个表单域,这三个表单域对于三个请求参数,因此应该使用Action来封装这三个请求参数。三个表单域的name分别为field1、field2和field3。
处理该请求的Action类代码如下:
publicclassJSONExample
{
//封装请求参数的三个属性
privateStringfield1;
privatetransientStringfield2;
privateStringfield3;
//封装处理结果的属性
privateint[]ints={10,20};
privateMapmap=newHashMap();
privateStringcustomname="custom";
//三个请求参数对应的setter和getter方法
publicStringgetField1(){
returnfield1;
}
publicvoidsetField1(Stringfield1){
this.field1=field1;
}
//此处省略了field1和field2两个字段的setter和getter方法
...
//封装处理结果的属性的setter和getter方法
publicint[]getInts(){
returnints;
}
publicvoidsetInts(int[]ints){
this.ints=ints;
}
publicMapgetMap(){
returnmap;
}
publicvoidsetMap(Mapmap){
this.map=map;
}
//使用注释语法来改变该属性序列化后的属性名
@JSON(name="newName")
publicStringgetCustomName(){
returnthis.customName;
}
publicStringexecute(){
map.put("name","yeeku");
returnAction.SUCCESS;
}
}
在上面代码中,使用了JSON注释,注释时指定了name域,name域指定Action属性被序列化成JSON对象的属性名。除此之外,JSON注释还支持如下几个域:
serialize:设置是否序列化该属性
deserialize:设置是否反序列化该属性。
format:设置用于格式化输出、解析日期表单域的格式。例如"yyyy-MM-dd'T'HH:mm:ss"。
配置该Action与配置普通Action存在小小的区别,应该为该Action配置类型为json的Result。而这个Result无需配置任何视图资源。
配置该Action的struts.xml文件代码如下:
<?xmlversion="1.0"encoding="GBK"?>
<!DOCTYPEstrutsPUBLIC
"-//ApacheSoftwareFoundation//DTDStrutsConfiguration2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
<constantname="struts.i18n.encoding"value="UTF-8"/>
<packagename="example"extends="json-default">
<actionname="JSONExample"class="lee.JSONExample">
<resulttype="json"/>
</action>
</package>
</struts>
在上面配置文件中有两个值得注意的地方:
第一个地方是配置struts.i18n.encoding常量时,不再是使用GBK编码,而是UTF-8编码,这是因为Ajax的POST请求都是以UTF-8的方式进行编码的。
第二个地方是配置包时,自己的包继承了json-default包,而不再继承默认的default包,这是因为只有在该包下才有json类型的Result。
实现JSP页面first.jsp:
为了简单地访问DOM节点,这里用了JavaScript框架Prototype.js.
<%@pagelanguage="java"contentType="text/html;charset=GBK"%>
<scriptsrc="prototype-1.4.0.js"type="text/javascript">
</script>
<scriptlanguage="JavaScript">
functiongotClick()
{
//请求的地址
varurl='JSONExample.action';
varparams=Form.serialize('form1');
//创建Ajax.Request对象,对应于发送请求
varmyAjax=newAjax.Request(
url,
{
//请求方式:POST
method:'post',
//请求参数
parameters:params,
//指定回调函数
onComplete:processResponse,
//是否异步发送请求
asynchronous:true
});
}
functionprocessResponse(request)
{
$("show").innerHTML=request.responseText;
}
</script>
<html>
<head>
<title>使用JSON插件</title>
</head>
<body>
<formid="form1"name="form1"method="post">
<INPUTTYPE="text"name="field1"id="field1"/><br>
<INPUTTYPE="text"name="field2"id="field2"/><br>
<INPUTTYPE="text"name="field3"id="field3"/><br>
<INPUTTYPE="button"value="提交"onClick="gotClick();"/>
</form>
<divid="show">
</div>
</body>
</html>
可以看出:服务器响应是整个Action实例的状态值,包括Action实例里的每个属性名以及对应的属性值。