早在我刚学Struts2之初的时候，就想写一篇文章来阐述Struts2如何返回JSON数据的原理和具体应用了，但苦于一直忙于工作难以抽身，渐渐的也淡忘了此事。直到前两天有同事在工作中遇到这个问题，来找我询问，我又细细地给他讲了一遍之后，才觉得无论如何要抽一个小时的时间来写这篇文章，从头到尾将Struts2与JSON的关系说清楚。
其实网络中，关于这个问题的答案已是海量，我当初也是从这海量的答案中吸收精华，才将“Struts2返回JSON数据”这个问题搞清楚的。但是这些海量的答案，有一个共同的缺陷，就是作者们只关注问题核心，即“如何在具体的Struts2应用中返回JSON数据到客户端”如何实现，而对于"为何要这样实现"以及实现的本质却解释的不甚了了，在笔者看来这只是“授人以鱼”而非笔者所推崇的“授人以鱼的同时，授人以渔”。在这篇文章中，笔者将总结前辈们的经验，并结合自己的理解，来从理论到实践由浅入深的说明“Struts2返回JSON数据”这一问题。
JSON(JavaScript Object Notation)
首先来看一下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）。不同的语言中，它被理解为对象（object），纪录（record），结构（struct），字典（dictionary），哈希表（hash table），有键列表（keyed list），或者关联数组 （associative array）。
值的有序列表（An ordered list of values）。在大部分语言中，它被理解为数组（array）。
因为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数据到客户端：
package cn.ysh.studio.struts2.json.demo.servlet;
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);
}
}
结果在意料之中，如下图所示:
使用JSP（或html等）返回JSON数据到客户端：
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
{"user":{"id":"123","name":"JSONJSP","say":"Hello , i am a JSP !","password":"JSON"},"success":true}
这个就不用去看结果了吧。
再回到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;
};
因为是常规的Struts流程配置，所以配置内容就不再展示了。
JSP代码就非常简单了,
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
${data }
结果如图所示:
在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以对象方式转换。看下面的一个例子：
package cn.ysh.studio.struts2.json.demo.test;
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的完整代码:
package cn.ysh.studio.struts2.json.demo.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>
最后，附上整个范例工程(一个MyEclipse工程)源码。
原创文章，转载请注明出处: http://www.yshjava.cn/post/328.html
相关推荐
总结，Struts2和jQuery的Ajax JSON数据交换涉及以下几个关键步骤：配置Struts2的JSON插件，编写返回JSON数据的Action，使用jQuery发起Ajax请求并处理返回的JSON数据。通过这种方式，可以实现客户端与服务器之间的...
Struts2作为一款流行的Java EE Web应用开发框架，它支持多种数据格式的输出，而JSON作为一种轻量级的数据交换格式，广泛应用于Web服务的响应数据表示。在Struts2中，开发者可以使用内置的JSON插件或者手动编码的方式...
Action类通过execute()方法执行业务逻辑，并返回一个结果，这个结果可以是重定向到另一个页面、显示一个JSP或者向前端发送JSON数据。 在Struts2中，配置文件struts.xml是至关重要的，它定义了Action的映射、结果...
Action类需要实现相应的业务逻辑，并使用Struts2的Result类型（如`json`）来返回JSON数据。例如： ```java public class JqGridAction extends ActionSupport { private List<RowData> dataList; private int ...
在本例中，DWR可能被用来在后台处理数据，然后通过JSON将结果返回给EXT JS的动态树组件，这样用户就能看到实时更新的树状结构，而无需整个页面刷新。 综上所述，这个项目展示了如何利用SSH框架搭建后端服务，EXT JS...
结合Struts2利用jquery的ajax打造的google,flicker图片获取源的java web 应用，支持中文搜索，多线程快速保存图片，支持跳转搜索，JSON传输数据的使用范例，JSON字符串的解析和生成！
1. **网上书城系统**: 使用Java、SSH框架（Struts2、Spring、Hibernate）、Ajax、Jquery、Json等技术开发，项目规模为8人月。应聘者担任组长，负责超级管理员的书籍和订单管理，以及前台的登陆、注册、购物车等功能...
"JAVA项目开发实践-网上范例"是一个集合，包含了10个具体的项目实例，旨在帮助学习者通过实际操作来学习和掌握Java编程技术。下面，我们将详细探讨这些实践案例可能涵盖的知识点，以及它们如何帮助你提高开发能力。 ...
2. **MVC架构模式**：Model-View-Controller模式在Java Web中广泛应用，有助于实现业务逻辑、数据模型和用户界面的分离。了解Spring MVC或Struts等框架如何实现这一模式，提高开发效率和代码可维护性。 3. **JDBC与...
2. **异步数据更新**：比如，可以创建一个动态表格，前端定时调用服务器获取最新数据，更新表格内容，实现无刷新的数据刷新。 3. **文件上传**：DWR支持AJAX方式的文件上传，前端选择文件后，后台处理文件上传，同时...
2. 开发框架：熟练使用J2EE应用，如Spring、Struts、Hibernate等主流框架，了解MVC设计模式。 3. 数据库管理：掌握Oracle和MySQL数据库，能编写高效的SQL语句。 4. 开发工具：熟练运用Eclipse或MyEclipse等IDE，以及...
在这个页面上，可以通过JavaScript调用DWR提供的服务方法，并根据返回的结果更新页面内容。 **1.3 本章总结** 本章介绍了DWR的基本概念及其安装过程，并通过一个简单的例子展示了如何使用DWR进行基本的开发。 ###...
FTP的目标是：（1）提高文件的共享性（计算机程序和/或数据），（2）鼓励间接地（通过程序）使用远程计算机，（3）保护用户因主机之间的文件存储系统导致的变化，（4）为了可靠和高效地传输，虽然用户可以在终端上...
Keras深度学习框架中基于反向传播神经网络的房价预测 介绍 近年来，随着全球经济的快速增长，... 本文使用的数据是使用搜寻器技术从Web Host进行搜寻的，并使用基于Keras范例的反向传播神经网络（BP神经网络）模型进