Struts2返回JSON數(shù)據(jù)的具體應(yīng)用范例

南郡修道院 2012-10-14

展開(kāi)全文

Struts2返回JSON數(shù)據(jù)的具體應(yīng)用范例

博客分類：

Struts2

早在我剛學(xué)Struts2之初的時(shí)候,，就想寫一篇文章來(lái)闡述Struts2如何返回JSON數(shù)據(jù)的原理和具體應(yīng)用了，但苦于一直忙于工作難以抽身,，漸漸的也淡忘了此事,。直到前兩天有同事在工作中遇到這個(gè)問(wèn)題，來(lái)找我詢問(wèn),，我又細(xì)細(xì)地給他講了一遍之后,，才覺(jué)得無(wú)論如何要抽一個(gè)小時(shí)的時(shí)間來(lái)寫這篇文章，從頭到尾將Struts2與JSON的關(guān)系說(shuō)清楚,。

其實(shí)網(wǎng)絡(luò)中,，關(guān)于這個(gè)問(wèn)題的答案已是海量，我當(dāng)初也是從這海量的答案中吸收精華,，才將“Struts2返回JSON數(shù)據(jù)”這個(gè)問(wèn)題搞清楚的,。但是這些海量的答案,，有一個(gè)共同的缺陷，就是作者們只關(guān)注問(wèn)題核心,，即“如何在具體的Struts2應(yīng)用中返回JSON數(shù)據(jù)到客戶端”如何實(shí)現(xiàn),，而對(duì)于"為何要這樣實(shí)現(xiàn)"以及實(shí)現(xiàn)的本質(zhì)卻解釋的不甚了了，在筆者看來(lái)這只是“授人以魚”而非筆者所推崇的“授人以魚的同時(shí),，授人以漁”,。在這篇文章中，筆者將總結(jié)前輩們的經(jīng)驗(yàn),，并結(jié)合自己的理解,，來(lái)從理論到實(shí)踐由淺入深的說(shuō)明“Struts2返回JSON數(shù)據(jù)”這一問(wèn)題。

JSON(JavaScript Object Notation)

首先來(lái)看一下JSON官方對(duì)于“JSON”的解釋：

JSON(JavaScript Object Notation) 是一種輕量級(jí)的數(shù)據(jù)交換格式,。易于人閱讀和編寫,。同時(shí)也易于機(jī)器解析和生成。它基于JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999的一個(gè)子集,。 JSON采用完全獨(dú)立于語(yǔ)言的文本格式,，但是也使用了類似于C語(yǔ)言家族的習(xí)慣（包括C, C++, C#, Java, JavaScript, Perl, Python等）。這些特性使JSON成為理想的數(shù)據(jù)交換語(yǔ)言,。(更多內(nèi)容請(qǐng)參見(jiàn)JSON官網(wǎng)http:///json-zh.html)

JSON建構(gòu)于兩種結(jié)構(gòu)：

“名稱/值”對(duì)的集合（A collection of name/value pairs）,。不同的語(yǔ)言中，它被理解為對(duì)象（object）,，紀(jì)錄（record）,，結(jié)構(gòu)（struct），字典（dictionary）,，哈希表（hash table）,，有鍵列表（keyed list），或者關(guān)聯(lián)數(shù)組（associative array）,。

值的有序列表（An ordered list of values）,。在大部分語(yǔ)言中，它被理解為數(shù)組（array）,。

因?yàn)镴SON中的值（value）可以是雙引號(hào)括起來(lái)的字符串（string）,、數(shù)值(number)、true,、false,、 null、對(duì)象（object）或者數(shù)組（array）,，且這些結(jié)構(gòu)可以嵌套,，這種特性給予JSON表達(dá)數(shù)據(jù)以無(wú)限的可能：它既可以表達(dá)一個(gè)簡(jiǎn)單的key/value，也可以表達(dá)一個(gè)復(fù)雜的Map或List，而且它是易于閱讀和理解的,。

Struts2中JSON的用武之地

因?yàn)镴SON是脫離語(yǔ)言的理想的數(shù)據(jù)交換格式，所以它被頻繁的應(yīng)用在客戶端與服務(wù)器的通信過(guò)程中,，這一點(diǎn)是毋庸置疑的,。而在客戶端與服務(wù)器的通信過(guò)程中,，JSON數(shù)據(jù)的傳遞又被分為服務(wù)器向客戶端傳送JSON數(shù)據(jù),，和客戶端向服務(wù)器傳送JSON數(shù)據(jù)，前者的核心過(guò)程中將對(duì)象轉(zhuǎn)換成JSON,，而后者的核心是將JSON轉(zhuǎn)換成對(duì)象,，這是本質(zhì)的區(qū)別。另外,，值得一提的是,，JSON數(shù)據(jù)在傳遞過(guò)程中，其實(shí)就是傳遞一個(gè)普通的符合JSON語(yǔ)法格式的字符串而已,，所謂的“JSON對(duì)象”是指對(duì)這個(gè)JSON字符串解析和包裝后的結(jié)果,，這一點(diǎn)請(qǐng)牢記，因?yàn)橄旅娴膬?nèi)容會(huì)依賴這一點(diǎn),。

Struts2返回JSON數(shù)據(jù)到客戶端

這是最常見(jiàn)的需求,，在AJAX大行其道的今天，向服務(wù)器請(qǐng)求JSON數(shù)據(jù)已成為每一個(gè)WEB應(yīng)用必備的功能,。拋開(kāi)Struts2暫且不提,，在常規(guī)WEB應(yīng)用中由服務(wù)器返回JSON數(shù)據(jù)到客戶端有兩種方式：一是在Servlet中輸出JSON串，二是在JSP頁(yè)面中輸出JSON串,。上文提到,，服務(wù)器像客戶端返回JSON數(shù)據(jù)，其實(shí)就是返回一個(gè)符合JSON語(yǔ)法規(guī)范的字符串,，所以在上述兩種方法中存在一個(gè)共同點(diǎn),，就是將需要返回的數(shù)據(jù)包裝稱符合JSON語(yǔ)法規(guī)范的字符串后在頁(yè)面中顯示。如下所示

使用Servlet返回JSON數(shù)據(jù)到客戶端：

Java代碼

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();
//將要被返回到客戶端的對(duì)象
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());
// 因?yàn)镴SON數(shù)據(jù)在傳遞過(guò)程中是以普通字符串形式傳遞的,，所以我們也可以手動(dòng)拼接符合JSON語(yǔ)法規(guī)范的字符串輸出到客戶端
// 以下這兩句的作用與38-46行代碼的作用是一樣的,，將向客戶端返回一個(gè)User對(duì)象，和一個(gè)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);
}
}

結(jié)果在意料之中,，如下圖所示:

使用JSP（或html等）返回JSON數(shù)據(jù)到客戶端：

Java代碼

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
{"user":{"id":"123","name":"JSONJSP","say":"Hello , i am a JSP !","password":"JSON"},"success":true}

這個(gè)就不用去看結(jié)果了吧,。

再回到Struts，在Struts的MVC模型中,，Action替代Servlet擔(dān)當(dāng)了Model的角色,，所以對(duì)于Struts而言，返回JSON數(shù)據(jù)到客戶端，跟傳統(tǒng)的WEB應(yīng)用一樣,，存在兩種方式,，即在Action中輸出JSON數(shù)據(jù)，和在視圖資源中輸出JSON數(shù)據(jù),。再往下細(xì)分的話,，在Action中輸出JSON數(shù)據(jù)又分為兩種方式，一是使用傳統(tǒng)方式輸出自己包裝后的JSON數(shù)據(jù),，二是使用Struts自帶的JSON數(shù)據(jù)封裝功能來(lái)自動(dòng)包裝并返回JSON數(shù)據(jù),。

在視圖資源中輸出JSON數(shù)據(jù)

Action處理完用戶請(qǐng)求后，將數(shù)據(jù)存放在某一位置,，如request中,，并返回視圖，然后Struts將跳轉(zhuǎn)至該視圖資源,，在該視圖中,，我們需要做的是將數(shù)據(jù)從存放位置中取出，然后將其轉(zhuǎn)換為JSON字符串,，輸出在視圖中,。這跟傳統(tǒng)WEB應(yīng)用中在JSP頁(yè)面輸出JSON數(shù)據(jù)的做法如出一轍:

Java代碼

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對(duì)象中放了一個(gè)data，所以struts的result配置中不能有type="redirect"
ServletActionContext.getRequest().setAttribute("data", jsonObject.toString());
return SUCCESS;
};

因?yàn)槭浅Ｒ?guī)的Struts流程配置,，所以配置內(nèi)容就不再展示了,。

JSP代碼就非常簡(jiǎn)單了,

Java代碼

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
${data }

結(jié)果如圖所示:

在Action中以傳統(tǒng)方式輸出JSON數(shù)據(jù)

這一點(diǎn)跟傳統(tǒng)的Servlet的處理方式基本上一模一樣，代碼如下

Java代碼

public void doAction() throws IOException{
HttpServletResponse response=ServletActionContext.getResponse();
//以下代碼從JSON.java中拷過(guò)來(lái)的
response.setContentType("text/html");
PrintWriter out;
out = response.getWriter();
//將要被返回到客戶端的對(duì)象
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());
// 因?yàn)镴SON數(shù)據(jù)在傳遞過(guò)程中是以普通字符串形式傳遞的,，所以我們也可以手動(dòng)拼接符合JSON語(yǔ)法規(guī)范的字符串輸出到客戶端
// 以下這兩句的作用與38-46行代碼的作用是一樣的,，將向客戶端返回一個(gè)User對(duì)象，和一個(gè)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中的配置:

Java代碼

<package name="default" extends="struts-default" namespace="/">
<action name="testJSONFromActionByGeneral" class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="doAction">
</action>
</package>

注意:這個(gè)action沒(méi)有result,，且doAction方法沒(méi)有返回值!

就不再貼圖了,，因?yàn)榻Y(jié)果可想而知!

在Action中以Struts2的方式輸出JSON數(shù)據(jù)

本著“不重復(fù)發(fā)明輪子”的原則，我們將轉(zhuǎn)換JSON數(shù)據(jù)的工作交給Struts2來(lái)做,，那么相對(duì)于在Action中以傳統(tǒng)方式輸出JSON不同的是,，Action是需要將注意力放在業(yè)務(wù)處理上，而無(wú)需關(guān)心處理結(jié)果是如何被轉(zhuǎn)換成JSON被返回客戶端的——這些工作通過(guò)簡(jiǎn)單的配置,，Struts2會(huì)幫我們做的更好,。

Java代碼

public String testByAction() {
// dataMap中的數(shù)據(jù)將會(huì)被Struts2轉(zhuǎn)換成JSON字符串，所以這里要先清空其中的數(shù)據(jù)
dataMap.clear();
User user = new User();
user.setId("123");
user.setName("JSONActionStruts2");
user.setPassword("123");
user.setSay("Hello world !");
dataMap.put("user", user);
// 放入一個(gè)是否操作成功的標(biāo)識(shí)
dataMap.put("success", true);
// 返回結(jié)果
return SUCCESS;
}

struts.xml中action的配置:

Java代碼

<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">
<param name="root">dataMap</param>
</result>
</action>
</package>

凡是使用Struts2序列化對(duì)象到JSON的action,，所在的package必須繼承自json-default，注意,，這里唯一的result,，沒(méi)有指定name屬性,。

結(jié)果如下圖所示:

上面很詳細(xì)的說(shuō)明了在WEB應(yīng)用中如何返回JSON數(shù)據(jù)到客戶端，講了那么多種方式,，涉及的技術(shù)核心無(wú)非只有兩點(diǎn)：

1,、將對(duì)象轉(zhuǎn)換成符合JSON語(yǔ)法格式的字符串；
2,、將符合JSON語(yǔ)法格式的字符串返回客戶端,；

第二點(diǎn)是整個(gè)實(shí)現(xiàn)過(guò)程的本質(zhì)，但卻不難做到,；第一點(diǎn)其實(shí)也不難，他甚至有兩種做法,，一是通過(guò)字符串拼接方式,，而是通過(guò)JSONObject以對(duì)象方式轉(zhuǎn)換?？聪旅娴囊粋€(gè)例子：

Java代碼

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轉(zhuǎn)換成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轉(zhuǎn)換后的字符串:"+jsonObject.toString());
return jsonObject;
}
/**
* 從JSONObject對(duì)象中反向解析出User對(duì)象
* @param jsonObject
*/
public void json2bean(JSONObject jsonObject) {
User user=(User)JSONObject.toBean((JSONObject)jsonObject.get("user"),User.class);
System.out.println("轉(zhuǎn)換得到的User對(duì)象的Name為:"+user.getName());
}
public static void main(String[] s) {
JSONTest tester=new JSONTest();
tester.json2bean(tester.bean2json());
}
}

JSON格式的字符串返回到客戶端后,，客戶端會(huì)將其解析并封裝成真正的JSON對(duì)象，以供JS調(diào)用,。

總結(jié)上述,，其實(shí)只要明白了服務(wù)器返回JSON數(shù)據(jù)到客戶端的原理，做起來(lái)就游刃有余了,，他甚至有非常多的可選方案,，但既然是基于Struts2的實(shí)現(xiàn)，那么肯定還是要用Struts2的方式來(lái)做啦,，因?yàn)檫@樣確實(shí)可以省很多事,。另外，在文章的最后,，說(shuō)明一下返回JSON數(shù)據(jù)時(shí)在result中配置的參數(shù)的含義及其常見(jiàn)常見(jiàn)配置吧：

Java代碼

<result type="json">
<param name="root">dataMap</param>
<param name="excludeNullProperties">true</param>
<param name="includeProperties">
userList.*
</param>
<param name="excludeProperties">
SUCCESS
</param>
</result>

值得一提的是通過(guò)Struts2來(lái)返回JSON數(shù)據(jù),，在IE中會(huì)提示下載,，這個(gè)不用關(guān)心，換個(gè)瀏覽器就能正常展示JSON數(shù)據(jù)，而在JS調(diào)用中，更是毫無(wú)影響。

下面是整個(gè)Action的完整代碼:

Java代碼

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;
//將會(huì)被Struts2序列化為JSON字符串的對(duì)象
private Map<String, Object> dataMap;
/**
* 構(gòu)造方法
*/
public UserAction() {
//初始化Map對(duì)象
dataMap = new HashMap<String, Object>();
}
/**
* 測(cè)試通過(guò)action以視圖方式返回JSON數(shù)據(jù)
* @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對(duì)象中放了一個(gè)data,，所以struts的result配置中不能有type="redirect"
ServletActionContext.getRequest().setAttribute("data", jsonObject.toString());
return SUCCESS;
};
/**
* 測(cè)試通過(guò)action以Struts2默認(rèn)方式返回JSON數(shù)據(jù)
* @return
*/
public String testByAction() {
// dataMap中的數(shù)據(jù)將會(huì)被Struts2轉(zhuǎn)換成JSON字符串,，所以這里要先清空其中的數(shù)據(jù)
dataMap.clear();
User user = new User();
user.setId("123");
user.setName("JSONActionStruts2");
user.setPassword("123");
user.setSay("Hello world !");
dataMap.put("user", user);
// 放入一個(gè)是否操作成功的標(biāo)識(shí)
dataMap.put("success", true);
// 返回結(jié)果
return SUCCESS;
}
/**
* 通過(guò)action是以傳統(tǒng)方式返回JSON數(shù)據(jù)
* @throws IOException
*/
public void doAction() throws IOException{
HttpServletResponse response=ServletActionContext.getResponse();
//以下代碼從JSON.java中拷過(guò)來(lái)的
response.setContentType("text/html");
PrintWriter out;
out = response.getWriter();
//將要被返回到客戶端的對(duì)象
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());
// 因?yàn)镴SON數(shù)據(jù)在傳遞過(guò)程中是以普通字符串形式傳遞的,，所以我們也可以手動(dòng)拼接符合JSON語(yǔ)法規(guī)范的字符串輸出到客戶端
// 以下這兩句的作用與38-46行代碼的作用是一樣的，將向客戶端返回一個(gè)User對(duì)象,，和一個(gè)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序列化指定屬性時(shí),，必須有該屬性的getter方法，實(shí)際上,，如果沒(méi)有屬性,，而只有g(shù)etter方法也是可以的
* @return
*/
public Map<String, Object> getDataMap() {
return dataMap;
}
}

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

Xml代碼

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts./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">
<param name="root">dataMap</param>
<!--
<param name="excludeNullProperties">true</param>
-->
<!--
<param name="includeProperties">
userList.*
</param>
-->
<!--
<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>

最后,，附上整個(gè)范例工程(一個(gè)MyEclipse工程)源碼。

原創(chuàng)文章,，轉(zhuǎn)載請(qǐng)注明出處:http://yshjava./blog/1333104

Struts2_JSON_Demo.rar (109.5 KB)
下載次數(shù): 491

本站是提供個(gè)人知識(shí)管理的網(wǎng)絡(luò)存儲(chǔ)空間，所有內(nèi)容均由用戶發(fā)布,，不代表本站觀點(diǎn),。請(qǐng)注意甄別內(nèi)容中的聯(lián)系方式、誘導(dǎo)購(gòu)買等信息,，謹(jǐn)防詐騙,。如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容，請(qǐng)點(diǎn)擊一鍵舉報(bào),。

轉(zhuǎn)藏 分享

QQ空間 QQ好友新浪微博微信

獻(xiàn)花（0） +1

來(lái)自：南郡修道院 > 《技術(shù)》

舉報(bào)/認(rèn)領(lǐng)