在Action中以Struts2的方式输出JSON数据

下面是整个Action的完整代码:

 

Java代码  

1. package cn.ysh.studio.struts2.json.demo.action;  
2.   
3. import java.io.IOException;  
4. import java.io.PrintWriter;  
5. import java.util.HashMap;  
6. import java.util.Map;  
7.   
8. import javax.servlet.http.HttpServletResponse;  
9.   
10. import org.apache.struts2.ServletActionContext;  
11.   
12. import net.sf.json.JSONObject;  
13.   
14. import cn.ysh.studio.struts2.json.demo.bean.User;  
15.   
16. import com.opensymphony.xwork2.ActionSupport;  
17.   
18. public class UserAction extends ActionSupport {  
19.   
20.     /** 
21.      *  
22.      */  
23.     private static final long serialVersionUID = 1L;  
24.   
25.     //将会被Struts2序列化为JSON字符串的对象  
26.     private Map<String, Object> dataMap;  
27.   
28.     /** 
29.      * 构造方法 
30.      */  
31.     public UserAction() {  
32.         //初始化Map对象  
33.         dataMap = new HashMap<String, Object>();  
34.     }  
35.   
36.     /** 
37.      * 测试通过action以视图方式返回JSON数据 
38.      * @return 
39.      */  
40.     public String testByJSP() {  
41.         User user = new User();  
42.         user.setId("123");  
43.         user.setName("JSONActionJSP");  
44.         user.setPassword("123");  
45.         user.setSay("Hello world !");  
46.         JSONObject jsonObject=new JSONObject();  
47.         jsonObject.accumulate("user", user);  
48.         jsonObject.accumulate("success", true);  
49.         //这里在request对象中放了一个data，所以struts的result配置中不能有type="redirect"  
50.         ServletActionContext.getRequest().setAttribute("data", jsonObject.toString());  
51.         return SUCCESS;  
52.     };  
53.   
54.     /** 
55.      * 测试通过action以Struts2默认方式返回JSON数据 
56.      * @return 
57.      */  
58.     public String testByAction() {  
59.         // dataMap中的数据将会被Struts2转换成JSON字符串，所以这里要先清空其中的数据  
60.         dataMap.clear();  
61.         User user = new User();  
62.         user.setId("123");  
63.         user.setName("JSONActionStruts2");  
64.         user.setPassword("123");  
65.         user.setSay("Hello world !");  
66.         dataMap.put("user", user);  
67.         // 放入一个是否操作成功的标识  
68.         dataMap.put("success", true);  
69.         // 返回结果  
70.         return SUCCESS;  
71.     }  
72.   
73.     /** 
74.      * 通过action是以传统方式返回JSON数据 
75.      * @throws IOException 
76.      */  
77.     public void doAction() throws IOException{  
78.         HttpServletResponse response=ServletActionContext.getResponse();  
79.         //以下代码从JSON.java中拷过来的  
80.         response.setContentType("text/html");  
81.         PrintWriter out;  
82.         out = response.getWriter();  
83.         //将要被返回到客户端的对象  
84.         User user=new User();  
85.         user.setId("123");  
86.         user.setName("JSONActionGeneral");  
87.         user.setPassword("JSON");  
88.         user.setSay("Hello , i am a action to print a json!");  
89.         JSONObject json=new JSONObject();  
90.         json.accumulate("success", true);  
91.         json.accumulate("user", user);  
92.         out.println(json.toString());  
93. //      因为JSON数据在传递过程中是以普通字符串形式传递的，所以我们也可以手动拼接符合JSON语法规范的字符串输出到客户端  
94. //      以下这两句的作用与38-46行代码的作用是一样的，将向客户端返回一个User对象，和一个success字段  
95. //      String jsonString="{\"user\":{\"id\":\"123\",\"name\":\"JSONActionGeneral\",\"say\":\"Hello , i am a action to print a json!\",\"password\":\"JSON\"},\"success\":true}";  
96. //      out.println(jsonString);  
97.         out.flush();  
98.         out.close();  
99.     }  
100.       
101.     /** 
102.      * Struts2序列化指定属性时，必须有该属性的getter方法，实际上，如果没有属性，而只有getter方法也是可以的 
103.      * @return 
104.      */  
105.     public Map<String, Object> getDataMap() {  
106.         return dataMap;  
107.     }  
108.   
109. }  

 

完整的struts.xml配置文件如下:

 

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"   
3.     "http://struts.apache.org/dtds/struts-2.0.dtd">  
4. <struts>  
5.     <package name="json" extends="json-default" namespace="/test">  
6.         <action name="testByAction"  
7.             class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="testByAction">  
8.             <result type="json">  
9.                 <!-- 这里指定将被Struts2序列化的属性，该属性在action中必须有对应的getter方法 -->  
10.                 <!-- 默认将会序列所有有返回值的getter方法的值，而无论该方法是否有对应属性 -->  
11.                 <param name="root">dataMap</param>  
12.                 <!-- 指定是否序列化空的属性 -->  
13.                 <!-- 
14.                 <param name="excludeNullProperties">true</param> 
15.                 -->  
16.                 <!-- 这里指定将序列化dataMap中的那些属性 -->  
17.                 <!--   
18.                 <param name="includeProperties">  
19.                     userList.*  
20.                 </param>  
21.                  -->  
22.                 <!-- 这里指定将要从dataMap中排除那些属性，这些排除的属性将不被序列化，一半不与上边的参数配置同时出现 -->  
23.                 <!--   
24.                 <param name="excludeProperties">  
25.                     SUCCESS  
26.                 </param>  
27.                 -->  
28.             </result>  
29.         </action>  
30.     </package>  
31.     <package name="default" extends="struts-default" namespace="/">  
32.         <action name="testJSONFromActionByGeneral"  
33.             class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="doAction">  
34.         </action>  
35.         <action name="testByJSP"  
36.             class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="testByJSP">  
37.             <result name="success">/actionJSP.jsp</result>  
38.         </action>  
39.     </package>  
40. </struts>