Struts2+JSON 实现AJAX 返回对象和列表

JSON 是一个插件,它允许我们在JavaScript中异步调用Action,它提供了一个json的返回结果类型(ResultType),只要为Action指定类型为

json返回结果类型,那么这个响应结果不需要返回给任何视图层,JSON会将Action里的状态信息序列化为JSON指定格式的数据,并将该数据返回

给JAVASCRIPT,这样可以完成AJAX的应用交互.
要应用 JSON 插件,首先需要到

 http://code.google.com/p/jsonplugin/downloads/list

下载最新JSON插件,我这里下载的是jsonplugin-

0.33.jar ,将该文件拷到WEB工程的LIB目录,当然还需要下载Struts2 类库,可以到http://struts.apache.org/download.cgi#struts2014

这里去下载,下载完后解压缩,将JAR拷到WEB工程的LIB目录,不能少于以下几个JAR文件(struts2-api-2.0.5.jar、struts2-core-2.0.5.jar、

ognl-2.6.9.jar、xwork-2.0.0.jar、commons-logging-1.1.jar、freemarker-2.3.8.jar,具体文件名视版本而定),接下来我们可以写个应用

来试验,本例程分为二步来写,第一步实现返回一个结果对象,第二步实现返回一个结果列表,首先来看下返回结果对象的实现.
我们需要先建立一个JavaBean 为值对象,用来将用户的基本数据封装进去,该实体在结果对象和结果列表中都会使用到
Users.java 代码如下:

Java代码  

1. package com.jsontostruts2.vo;  
2.   
3. /** 
4.  * <p> 
5.  * 创 建 人：ChenTao 
6.  * <p> 
7.  * 创建日期：2009-5-18 下午05:24:48 
8.  * <p> 
9.  */  
10. public class Users {  
11.   
12.     private Integer userId;  
13.   
14.     private String userName;  
15.   
16.     private String sex;  
17.   
18.     public Users() {  
19.   
20.     }  
21.     // get... set.... 略......  
22. }  

 

实现 UserAction.java 源码如下:

Java代码  

1. package com.jsontostruts2.action;  
2.   
3. import com.googlecode.jsonplugin.annotations.JSON;  
4. import com.jsontostruts2.vo.Users;  
5. import com.opensymphony.xwork2.ActionSupport;  
6.   
7. /** 
8.  * <p> 
9.  * 创 建 人：ChenTao 
10.  * <p> 
11.  * 创建日期：2009-5-18 下午05:22:50 
12.  * <p> 
13.  */  
14. @SuppressWarnings("serial")  
15. public class UserAction extends ActionSupport {  
16.   
17.     private Users users;  
18.       
19.     @JSON(name="USER")  
20.     public Users getUsers() {  
21.         return users;  
22.     }  
23.   
24.     public void setUsers(Users users) {  
25.         this.users = users;  
26.     }  
27.   
28.     @Override  
29.     public String execute() throws Exception {  
30.         users = new Users();  
31.         users.setUserId(1);  
32.         users.setUserName("ctojxzsycztao");  
33.         users.setSex("男人");  
34.         return SUCCESS;  
35.     }  
36.   
37. }  

 

接下来我们需要配置 struts.xml 文件,为了在现下面不再重复写该文件,这里我将结果对象和列表的请求控制一并贴上来,文件内容:

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <!DOCTYPE struts PUBLIC  
3.     "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"  
4.     "http://struts.apache.org/dtds/struts-2.0.dtd">  
5.   
6. <struts>  
7.     <!-- 注意这里扩展不再是 struts-default,而是 json-default -->  
8.     <package name="jsonManager" extends="json-default">  
9.         <!-- 返回结果类型为 json -->  
10.         <action name="userJson" class="com.jsontostruts2.action.UserAction">  
11.             <result type="json"/>  
12.         </action>  
13.         <!-- 该action在返回列表时添加进来的 -->  
14.         <action name="jsonlist" class="com.jsontostruts2.action.UserListAction">  
15.             <result type="json"/>  
16.         </action>  
17.           
18.     </package>  
19. </struts>  

 

能后创建web.xml 和 userjson.jsp:

Xml代码  

1. web.xml ：  
2. <?xml version="1.0" encoding="UTF-8"?>  
3. <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"  
4.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
5.     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee   
6.     http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">  
7.   
8.     <filter>  
9.         <filter-name>Struts2</filter-name>  
10.         <filter-class>  
11.             org.apache.struts2.dispatcher.FilterDispatcher  
12.         </filter-class>  
13.     </filter>  
14.     <filter-mapping>  
15.         <filter-name>Struts2</filter-name>  
16.         <url-pattern>*.action</url-pattern>  
17.     </filter-mapping>  
18.     <filter-mapping>  
19.         <filter-name>Struts2</filter-name>  
20.         <url-pattern>*.jsp</url-pattern>  
21.     </filter-mapping>  
22.   
23.     <welcome-file-list>  
24.         <welcome-file>index.jsp</welcome-file>  
25.     </welcome-file-list>  
26. </web-app>  

 

userjson.jsp :

Html代码  

1. <%@ page language="java" contentType="text/html;charset=UTF-8"%>  
2. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">  
3. <html>  
4.   <head>  
5.     <title>json 返回对象处理</title>  
6.     <script language="javascript">  
7.         var xmlHttp = false;  
8.         try{  
9.             xmlHttp = new ActiveXObject("msxml2.XMLHTTP");  
10.         }catch(e1){  
11.             try{  
12.                 xmlHttp = new ActiveXObject("microsoft.XMLHTTP");  
13.             }catch(e2){  
14.                 try{  
15.                     xmlHttp = new XMLHttpRequest();  
16.                 }catch(e3){  
17.                     xmlHttp = false;  
18.                 }  
19.             }  
20.         }  
21.         if(!xmlHttp){  
22.             alert("create xmlHttpRequest fail");  
23.         }  
24.         function jsonResult(){  
25.             xmlHttp.onreadystatechange = function(){  
26.                 if(xmlHttp.readyState == 4) {  
27.                 // 将 JSON 对象转换为JSON字符串,需要注意调用eval函数时必须使用"("和")"将JSON字符串括起来,否  
28.   
29. 则会出错  
30.                 var userObj = eval('(' + xmlHttp.responseText + ')');  
31.                 var userStr = "<table border=0>";  
32.                     userStr += '<tr><td><b>userId</b></td><td>' + userObj.USER.userId + '</td></tr>';  
33.                     userStr += ('<tr><td><b>userName</b></td><td>' + userObj.USER.userName + '</td></tr>');  
34.                     userStr += ('<tr><td><b>sex</b></td><td>' + userObj.USER.sex + '</td></tr>');  
35.                     userStr += "</table>";  
36.                     document.getElementById('jsonDiv').innerHTML = userStr;  
37.                 }  
38.             }  
39.             xmlHttp.open("POST","userJson.action",true);  
40.             xmlHttp.send(null);  
41.         }  
42.     </script>  
43.   </head>  
44.   <body>  
45.     <div id="jsonDiv"></div>  
46.     <input type="button" value="show" onclick="jsonResult();">  
47.   </body>  
48. </html>  

 

现在你可以将应用发布到你的容器当中输入 http://localhost:8080/struts2ToJson/userjson.jsp 点show,这个时候你可以看到你想要的结

果,接来实现下返回列表的做法,当然与返回对象会有所不同,我们需要将一个List对象转换为一个JSON规范的字符串,能后发送给客户端的JS,

首先建立一个将List 转换为指定字符串的工具类,该工具是在一个无意间从网上看到就拿来用了,经过少许修改,为了减少代码行数我将只贴

出适用于本示例的代码:
JsonUtil.java :

Java代码  

1. package com.jsontostruts2.util;  
2.   
3. import java.beans.IntrospectionException;  
4. import java.beans.Introspector;  
5. import java.beans.PropertyDescriptor;  
6. import java.util.List;  
7.   
8. /** 
9.  * <p> 
10.  * @author ChenTao 
11.  * <p> 
12.  * @Date 2009-5-18 下午05:47:27 
13.  * <p> 
14.  */  
15. public class JsonUtil {  
16.   
17.     /** 
18.      * @param object 
19.      *            任意对象 
20.      * @return java.lang.String 
21.      */  
22.     public static String objectToJson(Object object) {  
23.         StringBuilder json = new StringBuilder();  
24.         if (object == null) {  
25.             json.append("\"\"");  
26.         } else if (object instanceof String || object instanceof Integer) {  
27.             json.append("\"").append((String)object).append("\"");  
28.         } else {  
29.             json.append(beanToJson(object));  
30.         }  
31.         return json.toString();  
32.     }  
33.   
34.     /** 
35.      * 功能描述:传入任意一个 javabean 对象生成一个指定规格的字符串 
36.      *  
37.      * @param bean 
38.      *            bean对象 
39.      * @return String 
40.      */  
41.     public static String beanToJson(Object bean) {  
42.         StringBuilder json = new StringBuilder();  
43.         json.append("{");  
44.         PropertyDescriptor[] props = null;  
45.         try {  
46.             props = Introspector.getBeanInfo(bean.getClass(), Object.class)  
47.                     .getPropertyDescriptors();  
48.         } catch (IntrospectionException e) {  
49.         }  
50.         if (props != null) {  
51.             for (int i = 0; i < props.length; i++) {  
52.                 try {  
53.                     String name = objectToJson(props[i].getName());  
54.                     String value = objectToJson(props[i].getReadMethod().invoke(bean));  
55.                     json.append(name);  
56.                     json.append(":");  
57.                     json.append(value);  
58.                     json.append(",");  
59.                 } catch (Exception e) {  
60.                 }  
61.             }  
62.             json.setCharAt(json.length() - 1, '}');  
63.         } else {  
64.             json.append("}");  
65.         }  
66.         return json.toString();  
67.     }  
68.   
69.     /** 
70.      * 功能描述:通过传入一个列表对象,调用指定方法将列表中的数据生成一个JSON规格指定字符串 
71.      *  
72.      * @param list 
73.      *            列表对象 
74.      * @return java.lang.String 
75.      */  
76.     public static String listToJson(List<?> list) {  
77.         StringBuilder json = new StringBuilder();  
78.         json.append("[");  
79.         if (list != null && list.size() > 0) {  
80.             for (Object obj : list) {  
81.                 json.append(objectToJson(obj));  
82.                 json.append(",");  
83.             }  
84.             json.setCharAt(json.length() - 1, ']');  
85.         } else {  
86.             json.append("]");  
87.         }  
88.         return json.toString();  
89.     }  
90. }  

 

UserListAction.java:

Java代码  

1. package com.jsontostruts2.action;  
2.   
3. import java.util.ArrayList;  
4. import java.util.List;  
5.   
6. import com.googlecode.jsonplugin.annotations.JSON;  
7. import com.jsontostruts2.util.JsonUtil;  
8. import com.jsontostruts2.vo.Users;  
9. import com.opensymphony.xwork2.ActionSupport;  
10.   
11. /** 
12.  * <p> 
13.  * 创 建 人：ChenTao 
14.  * <p> 
15.  * 创建日期：2009-5-18 下午05:45:42 
16.  * <p> 
17.  */  
18. @SuppressWarnings("serial")  
19. public class UserListAction extends ActionSupport {  
20.       
21.     /* 用于存放JSON生成后的字符串结果 */  
22.     private String jsonResult;  
23.   
24.     @JSON(name="JSONRESULT")  
25.     public String getJsonResult() {  
26.         return jsonResult;  
27.     }  
28.   
29.     public void setJsonResult(String jsonResult) {  
30.         this.jsonResult = jsonResult;  
31.     }  
32.   
33.     @Override  
34.     public String execute() throws Exception {  
35.         List<Users> userList = new ArrayList<Users>();  
36.         Users users = new Users();  
37.         users.setUserId(1);  
38.         users.setUserName("ctojxzsycztao");  
39.         users.setSex("男人");  
40.         userList.add(users);  
41.         users = null;  
42.         users = new Users();  
43.         users.setUserId(2);  
44.         users.setUserName("rain");  
45.         users.setSex("女人");  
46.         userList.add(users);  
47.         users = null;  
48.         users = new Users();  
49.         users.setUserId(3);  
50.         users.setUserName("mimi");  
51.         users.setSex("女人");  
52.         userList.add(users);  
53.         jsonResult = JsonUtil.listToJson(userList);  
54.         System.out.println(jsonResult);  
55.         return SUCCESS;  
56.     }  
57. }  

 

接下来将要写一个jsonList.JSP页面来将结果承现给用户

Html代码  

1. <%@ page language="java" contentType="text/html;charset=UTF-8"%>  
2. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">  
3. <html>  
4.   <head>  
5.     <title>json 返回列表处理</title>  
6.     <script language="javascript">  
7.         var xmlHttp = false;  
8.         try{  
9.             xmlHttp = new ActiveXObject("msxml2.XMLHTTP");  
10.         }catch(e1){  
11.             try{  
12.                 xmlHttp = new ActiveXObject("microsoft.XMLHTTP");  
13.             }catch(e2){  
14.                 try{  
15.                     xmlHttp = new XMLHttpRequest();  
16.                 }catch(e3){  
17.                     xmlHttp = false;  
18.                 }  
19.             }  
20.         }  
21.         if(!xmlHttp){  
22.             alert("create xmlHttpRequest fail");  
23.         }  
24.         function jsonListResult(){  
25.             xmlHttp.onreadystatechange = function(){  
26.                 if(xmlHttp.readyState == 4) {  
27.                     var userList = eval('(' + xmlHttp.responseText + ')');  
28.                     var user = eval(userList.JSONRESULT);  
29.                     var result = "<table border=0>";  
30.                     result += "<tr><td>userId</td><td>userName</td><td>sex</td></tr>";  
31.                     for(var i=0;i<user.length;i++) {  
32.                         result += "<tr>";  
33.                         result += "<td>"+user[i].userId +"</td>";  
34.                         result += "<td>"+user[i].userName+"</td>";  
35.                         result += "<td>"+user[i].sex+"</td>";  
36.                         result += "</tr>";  
37.                     }  
38.                     result += "</table>";  
39.                     document.getElementById('jsonDiv').innerHTML = result;  
40.                 }  
41.             }  
42.             xmlHttp.open("POST","jsonlist.action",true);  
43.             xmlHttp.send(null);  
44.         }  
45.     </script>  
46.   </head>  
47.   <body>  
48.     <div id="jsonDiv"></div>  
49.     <input type="button" value="show list" onclick="jsonListResult();">  
50.   </body>  
51. </html>  

 现在将工程重复部署到WEB容器,启动:在浏览器中输入 http://localhost:8080/struts2ToJson/jsonList.jsp 点 show list按钮,看看结果

是否正确,如果不正确请参考本例程,看看有没漏掉部分没有配置进去,在以上代码中我们都有看到 @JSON 的注解,该注解可以改变JSON返回结果的属性名,好了文章就写到这里,需要下载示例的朋友可在附件中下载,里面包含有该文章的源代码和相应的 JAR

• struts2ToJson.zip (3.2 MB)
• 下载次数: 3103

转载自:    http://ctojxzsycztao.iteye.com/blog/390949