转：基于struts2实现ajax的2种标准方法

转自 - http://blog.sina.com.cn/s/blog_4b5bc0110101641r.html

基于struts2，有2种标准方法实现ajax 

共同的一点是，Action都需要将一个方法暴露出来，给前端javascript调用 

javascript的代码都是一样的： 

Js代码  

1. function testAjax() {  
2.   
3.     var $userNameInput = $("#ajax_username");  
4.     var userName = $userNameInput.val();  
5.   
6.     $.ajax({  
7.         url : "originAjax.action",  
8.         type : "GET",  
9.         data : "ajaxField=" + userName,  
10.         success : function(data, textStatus) {  
11.             alert(data);  
12.         }  
13.     });  
14. }  

这里originAjax.action，就是暴露出来供调用的地址 

下面分别介绍服务端的两种写法 

第一种是原生的写法，不需要依赖插件，也没有自行解析和拼装json串的功能 

Action： 

Java代码  

1. public void originAjax() throws IOException {  
2.         HttpServletResponse response = ServletActionContext.getResponse();  
3.         PrintWriter writer = response.getWriter();  
4.         writer.print("hello " + ajaxField);  
5.         writer.flush();  
6.         writer.close();  
7.     }  

struts.xml： 

Xml代码  " quality="high" allowscriptaccess="always" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer"> 

1. <action name="originAjax" class="bookAction" method="originAjax" />  

以上可以看到，写法是比较麻烦的。需要在Action里通过ServletActionContext的静态方法，获取到PrintWriter，然后直接写入响应 

这里的originAjax()方法的返回值类型是void，然后在struts.xml里，不需要配置<result>元素 

这种写法主要有2个缺陷，首先是与Servlet组件耦合，这在struts2应用里是不推荐的做法。其次是这个Action没有办法自动从请求中将json串解析为java的域，同样，如果需要将json串写入响应的话，也需要自行编码 

另一个办法，是使用struts2-json-plugin，将jar包拷贝入WEB-INF/lib就可以了 
Action： 

Java代码  

1. public String pluginAjax() {  
2.         ajaxField = "hello " + ajaxField;  
3.         return SUCCESS;  
4.     }  

struts.xml： 

Xml代码  true " quality="high" allowscriptaccess="always" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer"> 

1. <package name="bookManage" extends="json-default" namespace="/book">  
2.       
3.         <action name="pluginAjax" class="bookAction" method="pluginAjax">  
4.             <result type="json">  
5.                 <param name="excludeNullProperties">true</param>  
6.             </result>  
7.         </action>  
8.           
9.     </package>  

以上可以看到，Action里的写法变得非常简单，不过要注意的是，这个方法的返回值必须是String，而不是void 

在struts.xml中的配置，包要继承自json-default，然后resultType是json。这里还附加了一个参数excludeNullProperties，目的是不序列化Action里为null的字段。<result>元素没有name属性，也没有跳转值 

这里面其实还有一些规则，比如说没有getter方法的字段不会被序列化，注解为@Transient的字段不会被序列化等，另外param也不止excludeNullProperties一种。本文就不详细介绍了，可以看另外一篇博客：http://unmi.cc/struts2-json-plugin-guide，或者直接看官方的文档 

此外，因为这种响应ajax请求的方法，是需要放在json-default包里的，而一般的方法，只需要放在struts-default包里。但是由于业务组织的原因，很可能一个Action里，有些方法是响应ajax请求的方法，另一些方法是响应普通请求的方法。 

那么这种情况下，有一种方式，是将一个Action里的不同方法，放到不同的package里，不过这样好不好我还没有结论。另外一种方式，我感觉可以把所有的package都声明成extends json-default，经过试验，对普通的方法倒是没有造成影响，不过就是不知道会不会有什么隐藏的问题 

最后补充一点，json和ajax不是一回事。ajax只是一种异步请求的机制，刚才的pluginAjax.action和originAjax.action，同样是可以响应普通的请求的 

 

这样访问也没什么不可以，只是不太实用，相当于把Action当做加强版的Servlet来用了 

json只是一种数据格式，在同步请求中用json来交换数据，也是一种很常见的做法，并不一定用在ajax里 

所以struts2-json-plugin作为一个插件，是补充了struts2不能原生支持json的不足，将json格式作为数据交换的格式，这个设计是很合理的。 

但是struts2自身对ajax的支持就太不好了，比如我想在Action的一个方法里，直接输出一段普通文本来响应ajax请求，居然还要通过HttpServletResponse来做。我开始还不相信，在struts-default.xml里找到一个resultType，叫plainText，我以为就是这个了，想当然认为会有这种写法： 

Java代码  

1. public String plainText() {  
2.         return "my reponse for ajax";  
3.     }  

 

Xml代码  " quality="high" allowscriptaccess="always" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer"> 

1. <action name="plainText" class="bookAction" method="plainText">  
2.     <result type="plainText" />  
3. </action>  

我以为会有这样一种用法，来简单地提供对ajax的支持，结果发现plainText和我想的根本就不是一个东西，这是不是struts2一个设计不足的地方呢？