首先来看一下JSON官方对于“JSON”的解释：
JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。易于人阅读和编写。同时也易于机器解析和生成。它基于JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999的一个子集。 JSON采用完全独立于语言的文本格式，但是也使用了类似于C语言家族的习惯（包括C, C++, C#, Java, JavaScript, Perl, Python等）。这些特性使JSON成为理想的数据交换语言。(更多内容请参见JSON官网http://json.org/json-zh.html)
JSON建构于两种结构：
“名称/值”对的集合（A collection of name/value pairs）。
{ "firstName": "Brett", "lastName":"McLaughlin", "email": "aaaa" }
不同的语言中，它被理解为对象（object），纪录（record），结构（struct），字典（dictionary），哈希表（hash table），有键列表（keyed list），或者关联数组 （associative array）。
值的有序列表（An ordered list of values）。在大部分语言中，它被理解为数组（array）。
{ "people": [
{ "firstName": "Brett", "lastName":"McLaughlin", "email": "aaaa" },
{ "firstName": "Jason", "lastName":"Hunter", "email": "bbbb"},
{ "firstName": "Elliotte", "lastName":"Harold", "email": "cccc" }
]}
因为JSON中的值（value）可以是双引号括起来的字符串（string）、数值(number)、true、false、 null、对象（object）或者数组（array），且这些结构可以嵌套，这种特性给予JSON表达数据以无限的可能：它既可以表达一个简单的 key/value，也可以表达一个复杂的Map或List，而且它是易于阅读和理解的。
Struts2中JSON的用武之地
因为JSON是脱离语言的理想的数据交换格式，所以它被频繁的应用在客户端与服务器的通信过程中，这一点是毋庸置疑的。而在客户端与服务器的通信过程中，JSON数据的传递又被分为服务器向客户端传送JSON数据，和客户端向服务器传送JSON数据，前者的核心过程中将对象转换成JSON，而后者的核心是将JSON转换成对象，这是本质的区别。另外，值得一提的是，JSON数据在传递过程中，其实就是传递一个普通的符合JSON语法格式的字符串而已，所谓的“JSON对象”是指对这个JSON字符串解析和包装后的结果，这一点请牢记，因为下面的内容会依赖这一点。
Struts2返回JSON数据到客户端
这是最常见的需求，在AJAX大行其道的今天，向服务器请求JSON数据已成为每一个WEB应用必备的功能。抛开Struts2暂且不提，在常规WEB应用中由服务器返回JSON数据到客户端有两种方式：一是在Servlet中输出JSON串，二是在JSP页面中输出JSON串。上文提到，服务器像客户端返回JSON数据，其实就是返回一个符合JSON语法规范的字符串，所以在上述两种 方法中存在一个共同点，就是将需要返回的数据包装称符合JSON语法规范的字符串后在页面中显示。如下所示
使用Servlet返回JSON数据到客户端：
import java.io.IOException; import java.io.PrintWriter; import javax.servlet.ServletException; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import net.sf.json.JSONObject; import cn.ysh.studio.struts2.json.demo.bean.User; public class JSON extends HttpServlet { /** * */ private static final long serialVersionUID = 1L; /** * The doGet method of the servlet. <br> * * This method is called when a form has its tag value method equals to get. * * @param request the request send by the client to the server * @param response the response send by the server to the client * @throws ServletException if an error occurred * @throws IOException if an error occurred */ public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { response.setContentType("text/html"); PrintWriter out = response.getWriter(); //将要被返回到客户端的对象 User user=new User(); user.setId("123"); user.setName("JSONServlet"); user.setPassword("JSON"); user.setSay("Hello , i am a servlet !"); JSONObject json=new JSONObject(); json.accumulate("success", true); json.accumulate("user", user); out.println(json.toString()); // 因为JSON数据在传递过程中是以普通字符串形式传递的，所以我们也可以手动拼接符合JSON语法规范的字符串输出到客户端 // 以下这两句的作用与38-46行代码的作用是一样的，将向客户端返回一个User对象，和一个success字段 // String jsonString="{\"user\":{\"id\":\"123\",\"name\":\"JSONServlet\",\"say\":\"Hello , i am a servlet !\",\"password\":\"JSON\"},\"success\":true}"; // out.println(jsonString); out.flush(); out.close(); } /** * The doPost method of the servlet. <br> * * This method is called when a form has its tag value method equals to post. * * @param request the request send by the client to the server * @param response the response send by the server to the client * @throws ServletException if an error occurred * @throws IOException if an error occurred */ public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } }
再回到Struts，在Struts的MVC模型中，Action替代Servlet担当了Model的角色，所以对于Struts而言，返回 JSON数据到客户端，跟传统的WEB应用一样，存在两种方式，即在Action中输出JSON数据，和在视图资源中输出JSON数据。再往下细分的话，在Action中输出JSON数据又分为两种方式，一是使用传统方式输出自己包装后的JSON数据，二是使用Struts自带的JSON数据封装功能来自动包装并返回JSON数据。
在视图资源中输出JSON数据
Action处理完用户请求后，将数据存放在某一位置，如request中，并返回视图，然后Struts将跳转至该视图资源，在该视图中，我们需要做的是将数据从存放位置中取出，然后将其转换为JSON字符串，输出在视图中。这跟传统WEB应用中在JSP页面输出JSON数据的做法如出一辙:
public String testByJSP() { User user = new User(); user.setId("123"); user.setName("Struts2"); user.setPassword("123"); user.setSay("Hello world !"); JSONObject jsonObject=new JSONObject(); jsonObject.accumulate("user", user); //这里在request对象中放了一个data，所以struts的result配置中不能有type="redirect" ServletActionContext.getRequest().setAttribute("data", jsonObject.toString()); return SUCCESS; };
在Action中以传统方式输出JSON数据
这一点跟传统的Servlet的处理方式基本上一模一样，代码如下
public void doAction() throws IOException{ HttpServletResponse response=ServletActionContext.getResponse(); //以下代码从JSON.java中拷过来的 response.setContentType("text/html"); PrintWriter out; out = response.getWriter(); //将要被返回到客户端的对象 User user=new User(); user.setId("123"); user.setName("JSONActionGeneral"); user.setPassword("JSON"); user.setSay("Hello , i am a action to print a json!"); JSONObject json=new JSONObject(); json.accumulate("success", true); json.accumulate("user", user); out.println(json.toString()); // 因为JSON数据在传递过程中是以普通字符串形式传递的，所以我们也可以手动拼接符合JSON语法规范的字符串输出到客户端 // 以下这两句的作用与38-46行代码的作用是一样的，将向客户端返回一个User对象，和一个success字段 // String jsonString="{\"user\":{\"id\":\"123\",\"name\":\"JSONActionGeneral\",\"say\":\"Hello , i am a action to print a json!\",\"password\":\"JSON\"},\"success\":true}"; // out.println(jsonString); out.flush(); out.close(); }
struts.xml中的配置:
<package name="default" extends="struts-default" namespace="/"> <action name="testJSONFromActionByGeneral" class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="doAction"> </action> </package>
注意:这个action没有result，且doAction方法没有返回值!
在Action中以Struts2的方式输出JSON数据
本着“不重复发明轮子”的原则，我们将转换JSON数据的工作交给Struts2来做，那么相对于在Action中以传统方式输出JSON不同的是，Action是需要将注意力放在业务处理上，而无需关心处理结果是如何被转换成JSON被返回客户端的——这些 工作通过简单的配置，Struts2会帮我们做的更好。
public String testByAction() { // dataMap中的数据将会被Struts2转换成JSON字符串，所以这里要先清空其中的数据 dataMap.clear(); User user = new User(); user.setId("123"); user.setName("JSONActionStruts2"); user.setPassword("123"); user.setSay("Hello world !"); dataMap.put("user", user); // 放入一个是否操作成功的标识 dataMap.put("success", true); // 返回结果 return SUCCESS; }
struts.xml中action的配置:
<package name="json" extends="json-default" namespace="/test"> <action name="testByAction" class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="testByAction"> <result type="json"> <!-- 这里指定将被Struts2序列化的属性，该属性在action中必须有对应的getter方法 --> <param name="root">dataMap</param> </result> </action> </package>
凡是使用Struts2序列化对象到JSON的action，所在的package必须继承自json-default，注意，这里唯一的result，没有指定name属性。
上面很详细的说明了在WEB应用中如何返回JSON数据到客户端，讲了那么多种方式，涉及的技术核心无非只有两点：
1、将对象转换成符合JSON语法格式的字符串；
2、将符合JSON语法格式的字符串返回客户端；
第二点是整个实现过程的本质，但却不难做到；第一点其实也不难，他甚至有两种做法，一是通过字符串拼接方式，而是通过JSONObject以对象方式转换。看下面的一个例子：
import cn.ysh.studio.struts2.json.demo.bean.User; import net.sf.json.JSONObject; public class JSONTest { /** * 将普通的pojo转换成JSON字符串 * @return */ public JSONObject bean2json() { User user = new User(); user.setId("JSONTest"); user.setName("JSONTest"); user.setPassword("JSON"); user.setSay("Hello,i am JSONTest.java"); JSONObject jsonObject = new JSONObject(); jsonObject.accumulate("user", user); System.out.println("User转换后的字符串:"+jsonObject.toString()); return jsonObject; } /** * 从JSONObject对象中反向解析出User对象 * @param jsonObject */ public void json2bean(JSONObject jsonObject) { User user=(User)JSONObject.toBean((JSONObject)jsonObject.get("user"),User.class); System.out.println("转换得到的User对象的Name为:"+user.getName()); } public static void main(String[] s) { JSONTest tester=new JSONTest(); tester.json2bean(tester.bean2json()); } }
JSON格式的字符串返回到客户端后，客户端会将其解析并封装成真正的JSON对象，以供JS调用。
总结上述，其实只要明白了服务器返回JSON数据到客户端的原理，做起来就游刃有余了，他甚至有非常多的可选方案，但既然是基于 Struts2的实现，那么肯定还是要用Struts2的方式来做啦，因为这样确实可以省很多事。另外，在文章的最后，说明一下返回JSON数据时在 result中配置的参数的含义及其常见常见配置吧：
<result type="json"> <!-- 这里指定将被Struts2序列化的属性，该属性在action中必须有对应的getter方法 --> <!-- 默认将会序列所有有返回值的getter方法的值，而无论该方法是否有对应属性 --> <param name="root">dataMap</param> <!-- 指定是否序列化空的属性 --> <param name="excludeNullProperties">true</param> <!-- 这里指定将序列化dataMap中的那些属性 --> <param name="includeProperties"> userList.* </param> <!-- 这里指定将要从dataMap中排除那些属性，这些排除的属性将不被序列化，一半不与上边的参数配置同时出现 --> <param name="excludeProperties"> SUCCESS </param> </result>
值得一提的是通过Struts2来返回JSON数据，在IE中会提示下载，这个不用关心，换个浏览器就能正常展示JSON数据，而在JS调用中，更是毫无影响。
下面是整个Action的完整代码:
import java.io.IOException; import java.io.PrintWriter; import java.util.HashMap; import java.util.Map; import javax.servlet.http.HttpServletResponse; import org.apache.struts2.ServletActionContext; import net.sf.json.JSONObject; import cn.ysh.studio.struts2.json.demo.bean.User; import com.opensymphony.xwork2.ActionSupport; public class UserAction extends ActionSupport { /** * */ private static final long serialVersionUID = 1L; //将会被Struts2序列化为JSON字符串的对象 private Map<String, Object> dataMap; /** * 构造方法 */ public UserAction() { //初始化Map对象 dataMap = new HashMap<String, Object>(); } /** * 测试通过action以视图方式返回JSON数据 * @return */ public String testByJSP() { User user = new User(); user.setId("123"); user.setName("JSONActionJSP"); user.setPassword("123"); user.setSay("Hello world !"); JSONObject jsonObject=new JSONObject(); jsonObject.accumulate("user", user); jsonObject.accumulate("success", true); //这里在request对象中放了一个data，所以struts的result配置中不能有type="redirect" ServletActionContext.getRequest().setAttribute("data", jsonObject.toString()); return SUCCESS; }; /** * 测试通过action以Struts2默认方式返回JSON数据 * @return */ public String testByAction() { // dataMap中的数据将会被Struts2转换成JSON字符串，所以这里要先清空其中的数据 dataMap.clear(); User user = new User(); user.setId("123"); user.setName("JSONActionStruts2"); user.setPassword("123"); user.setSay("Hello world !"); dataMap.put("user", user); // 放入一个是否操作成功的标识 dataMap.put("success", true); // 返回结果 return SUCCESS; } /** * 通过action是以传统方式返回JSON数据 * @throws IOException */ public void doAction() throws IOException{ HttpServletResponse response=ServletActionContext.getResponse(); //以下代码从JSON.java中拷过来的 response.setContentType("text/html"); PrintWriter out; out = response.getWriter(); //将要被返回到客户端的对象 User user=new User(); user.setId("123"); user.setName("JSONActionGeneral"); user.setPassword("JSON"); user.setSay("Hello , i am a action to print a json!"); JSONObject json=new JSONObject(); json.accumulate("success", true); json.accumulate("user", user); out.println(json.toString()); // 因为JSON数据在传递过程中是以普通字符串形式传递的，所以我们也可以手动拼接符合JSON语法规范的字符串输出到客户端 // 以下这两句的作用与38-46行代码的作用是一样的，将向客户端返回一个User对象，和一个success字段 // String jsonString="{\"user\":{\"id\":\"123\",\"name\":\"JSONActionGeneral\",\"say\":\"Hello , i am a action to print a json!\",\"password\":\"JSON\"},\"success\":true}"; // out.println(jsonString); out.flush(); out.close(); } /** * Struts2序列化指定属性时，必须有该属性的getter方法，实际上，如果没有属性，而只有getter方法也是可以的 * @return */ public Map<String, Object> getDataMap() { return dataMap; } }
完整的struts.xml配置文件如下:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN" "http://struts.apache.org/dtds/struts-2.0.dtd"> <struts> <package name="json" extends="json-default" namespace="/test"> <action name="testByAction" class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="testByAction"> <result type="json"> <!-- 这里指定将被Struts2序列化的属性，该属性在action中必须有对应的getter方法 --> <!-- 默认将会序列所有有返回值的getter方法的值，而无论该方法是否有对应属性 --> <param name="root">dataMap</param> <!-- 指定是否序列化空的属性 --> <!-- <param name="excludeNullProperties">true</param> --> <!-- 这里指定将序列化dataMap中的那些属性 --> <!-- <param name="includeProperties"> userList.* </param> --> <!-- 这里指定将要从dataMap中排除那些属性，这些排除的属性将不被序列化，一半不与上边的参数配置同时出现 --> <!-- <param name="excludeProperties"> SUCCESS </param> --> </result> </action> </package> <package name="default" extends="struts-default" namespace="/"> <action name="testJSONFromActionByGeneral" class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="doAction"> </action> <action name="testByJSP" class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="testByJSP"> <result name="success">/actionJSP.jsp</result> </action> </package> </struts>
posted on
