Struts2 Result 返回JSON對象詳解

更新時間：2016年06月14日 09:17:37 作者：kingxss

這篇文章主要講解Struts2返回JSON對象的兩種方式，講的比較詳細(xì)，希望能給大家做一個參考。

　　如果是作為客戶端的HTTP+JSON接口工程，沒有JSP等view視圖的情況下，使用Jersery框架開發(fā)絕對是第一選擇。而在基于Spring3 MVC的架構(gòu)下，對HTTP+JSON的返回類型也有很好的支持。但是，在開發(fā)工作中，對功能的升級是基于既定架構(gòu)是很常見的情況。本人碰到需要用開發(fā)基于Struts2的HTTP+JSON返回類型接口就是基于既定框架結(jié)構(gòu)下進(jìn)行的。

　　Struts2返回JSON有兩種方式：1.使用Servlet的輸出流寫入JSON字符串；2.使用Struts2對JSON的擴(kuò)展。

一.使用Servlet的輸出流

　　JSON接口的實質(zhì)是：JSON數(shù)據(jù)在傳遞過程中，其實就是傳遞一個普通的符合JSON語法格式的字符串而已，所謂的“JSON對象”是指對這個JSON字符串解析和包裝后的結(jié)果。

　　所以這里只需要將一個JSON語法格式的字符串寫入到Servlet的HttpServletResponse中，這里使用的是PrintWriter的方式，當(dāng)然也可以采用Stream流的方式。需要注意的是：在調(diào)用getWriter之前未設(shè)置編碼(既調(diào)用setContentType或者setCharacterEncoding方法設(shè)置編碼), HttpServletResponse則會返回一個用默認(rèn)的編碼(既ISO-8859-1)編碼的PrintWriter實例。這樣就會造成中文亂碼。而且設(shè)置編碼時必須在調(diào)用getWriter之前設(shè)置,不然是無效的。

　　編寫接口代碼：

　　這里的方法與一般的Struts2方法的區(qū)別是這里是void返回類型。

public void write() throws IOException{ 
 HttpServletResponse response=ServletActionContext.getResponse(); 
 /* 
 * 在調(diào)用getWriter之前未設(shè)置編碼(既調(diào)用setContentType或者setCharacterEncoding方法設(shè)置編碼), 
 * HttpServletResponse則會返回一個用默認(rèn)的編碼(既ISO-8859-1)編碼的PrintWriter實例。這樣就會 
 * 造成中文亂碼。而且設(shè)置編碼時必須在調(diào)用getWriter之前設(shè)置,不然是無效的。 
 * */ 
 response.setContentType("text/html;charset=utf-8"); 
 //response.setCharacterEncoding("UTF-8"); 
 PrintWriter out = response.getWriter(); 
 //JSON在傳遞過程中是普通字符串形式傳遞的，這里簡單拼接一個做測試 
 String jsonString="{\"user\":{\"id\":\"123\",\"name\":\"張三\",\"say\":\"Hello , i am a action to print a json!\",\"password\":\"JSON\"},\"success\":true}"; 
 out.println(jsonString); 
 out.flush(); 
 out.close(); 
}

　　配置action

　　從以下的配置中可以明顯的看到配置與普通的action配置沒有任何區(qū)別，只是沒有返回的視圖而已。

<action name="write" class="json.JsonAction" method="write" />

　　返回值

{"user":{"id":"123","name":"張三","say":"Hello , i am a action to print a json!","password":"JSON"},"success":true}

二.使用Struts2對JSON的擴(kuò)展

　　要使用這個擴(kuò)展功能肯定需要添加支持包。經(jīng)過本人的調(diào)試，這里有兩種選擇：

　　1.xwork-core-2.1.6.jar和struts2-json-plugin-2.1.8.jar。如果你想使用struts2-json-plugin-2.1.8.jar這種支持方式，你的xwork-core-*.jar不能選擇2.2.1及以上版本，因為xwork-core-*.jar的2.2.1及以上版本中沒有了org.apache.commons.lang等包。啟動tomcat的時候會出現(xiàn)：java.lang.NoClassDefFoundError: org.apache.commons.lang.xwork.StringUtils。

　　2.xwork-2.1.2.jar和jsonplugin-0.34.jar。如果想用jsonplugin-0.34.jar這種支持方式，那需要切換你的xwork-core-*.jar為xwork-2.1.2.jar。因為jsonplugin-0.34.jar需要com.opensymphony.xwork2.util.TextUtils這個類的支持。而xwork-core-*.jar的2.2.1以上版本均為找到該類，且在xwork-core-2.1.6.jar中也沒有該類。

　　最后說一句，還因為用原始構(gòu)建方式而不停蹚雷，確實不值得，真心累。使用Maven等自動化構(gòu)件方式，會在很大程度上避免依賴包間的版本差異的bug。第三節(jié)的“struts2零配置”中會使用maven的構(gòu)件方式。

　　編寫接口代碼

　　該類中json()方法就是普通Struts2的方法。在這里沒有看到任何JSON格式的字符串，因為我們將要把這項工作交給擴(kuò)展去完成。在沒有任何設(shè)定的情況下，改類下的所有g(shù)etter方法的返回值將被包含在返回給客戶端的JSON字符串中。要剔除不需要包含的屬性，在類結(jié)構(gòu)結(jié)構(gòu)中需要在getter方法上使用@JSON(serialize=false)進(jìn)行注解,當(dāng)然在不影響其他業(yè)務(wù)的時候也可以直接去掉這個getter方法。所以本例中的返回結(jié)果是將dataMap對象轉(zhuǎn)換成的JSON格式的字符串。

package json; 
 
import java.util.HashMap; 
import java.util.Map; 
 
import org.apache.struts2.json.annotations.JSON; 
import com.opensymphony.xwork2.ActionSupport; 
 
/** 
 * JSON測試 
 * 
 * @author Watson Xu 
 * @date 2012-8-4 下午06:21:01 
 */ 
public class JsonAction extends ActionSupport{ 
 private static final long serialVersionUID = 1L; 
 
 private Map<String,Object> dataMap; 
 private String key = "Just see see"; 
 
 public String json() { 
 // dataMap中的數(shù)據(jù)將會被Struts2轉(zhuǎn)換成JSON字符串，所以這里要先清空其中的數(shù)據(jù) 
 dataMap = new HashMap<String, Object>(); 
 User user = new User(); 
 user.setName("張三"); 
 user.setPassword("123"); 
 dataMap.put("user", user); 
 // 放入一個是否操作成功的標(biāo)識 
 dataMap.put("success", true); 
 // 返回結(jié)果 
 return SUCCESS; 
 } 
 
 public Map<String, Object> getDataMap() { 
 return dataMap; 
 } 
 
 //設(shè)置key屬性不作為json的內(nèi)容返回 
 @JSON(serialize=false) 
 public String getKey() { 
 return key; 
 } 
 
}

　　配置aciton

　　在配置中，首先需要action所在的package繼承了json-default，或者繼承的父包繼承了json-default。這配置action的返回類型的type為json,并且可以配置其序列化的屬性等一些類參數(shù)

<?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="struts-default,json-default" > 
 <action name="json" class="json.JsonAction" method="json"> 
 <result type="json"> 
 <!-- 這里指定將被Struts2序列化的屬性，該屬性在action中必須有對應(yīng)的getter方法 --> 
 <param name="root">dataMap</param> 
 </result> 
 </action> 
 </package> 
</struts>

　　返回值

{"success":true,"user":{"name":"張三","password":"123"}}

三. Struts2零配置使用方法，使用Maven構(gòu)件：

　　3.1）建立一個webapp，這里還是采用Maven構(gòu)建，構(gòu)建過程參考limingnihao的blog：使用Eclipse構(gòu)建Maven的SpringMVC項目。

　　3.2）添加Struts2的依賴、struts2零配置依賴和struts2的json依賴：

<dependencies> 
 <!-- struts2核心依賴 --> 
 <dependency> 
 <groupId>org.apache.struts</groupId> 
 <artifactId>struts2-core</artifactId> 
 <version>2.3.4</version> 
 <type>jar</type> 
 <scope>compile</scope> 
 </dependency> 
 <!-- struts2零配置依賴 --> 
 <dependency> 
 <groupId>org.apache.struts</groupId> 
 <artifactId>struts2-convention-plugin</artifactId> 
 <version>2.3.4</version> 
 <type>jar</type> 
 <scope>compile</scope> 
 </dependency> 
 <!-- struts2的json依賴 --> 
 <dependency> 
 <groupId>org.apache.struts</groupId> 
 <artifactId>struts2-json-plugin</artifactId> 
 <version>2.3.4</version> 
 <type>jar</type> 
 <scope>compile</scope> 
 </dependency> 
</dependencies>

　　經(jīng)過測試，上面的依賴包間沒有出現(xiàn)版本兼容的bug，不僅僅因為他們是同一個版本，更加得益于Maven的自動構(gòu)建方式。

　　3.3）配置web.xml，啟用Struts2：

<?xml version="1.0" encoding="UTF-8"?> 
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" 
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
 http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"> 
 
 <filter> 
 <filter-name>StrutsPrepareAndExecuteFilter </filter-name> 
 <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter </filter-class> 
 <init-param> 
 <param-name>config</param-name> 
 <param-value>struts-default.xml,struts-plugin.xml,struts.xml</param-value> 
 </init-param> 
 </filter> 
 <filter-mapping> 
 <filter-name>StrutsPrepareAndExecuteFilter</filter-name> 
 <url-pattern>/*</url-pattern> 
 </filter-mapping> 
</web-app>

　　3.4）配置struts.xml，設(shè)置一些基本常量和應(yīng)用：

<?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="base" extends="json-default,struts-default"> 
 <!-- 這里可以設(shè)置一些全局的返回值映射關(guān)系等 --> 
 </package> 
 
 <constant name="struts.action.extension" value="" /> 
 <constant name="struts.ui.theme" value="simple" /> 
 <constant name="struts.i18n.encoding" value="utf-8" /> 
 <constant name="struts.multipart.maxSize" value="1073741824"/> 
 <constant name="struts.devMode" value="false"/> 
</struts>

　　3.5）編寫和配置Action。由并未指定Convention進(jìn)行設(shè)置，所以對于Convention插件而言，默認(rèn)的它會把所有類名以Action結(jié)尾的java類當(dāng)成Action處理：

package watson.action; 
 
import java.util.HashMap; 
import java.util.Map; 
 
import org.apache.struts2.convention.annotation.Action; 
import org.apache.struts2.convention.annotation.Namespace; 
import org.apache.struts2.convention.annotation.ParentPackage; 
import org.apache.struts2.convention.annotation.Result; 
import org.apache.struts2.convention.annotation.Results; 
 
@ParentPackage("base") 
@Namespace("/watson") 
@Results({ 
 @Result(name = "json",type="json", params={"root","msg"}) 
}) 
public class JsonAction { 
 
 @Action(value="json") 
 public String json() { 
 msg = new HashMap<String, Object>(); 
 msg.put("flag", "success"); 
 
 Map<String, String> user = new HashMap<String, String>(); 
 user.put("name", "張三"); 
 user.put("age", "34"); 
 msg.put("user", user); 
 return "json"; 
 } 
 
 //================================== 
 private Map<String, Object> msg; 
 
 public Map<String, Object> getMsg() { 
 return msg; 
 } 
 
}

　　3.6）部署項目，啟動容器，瀏覽器地址欄中輸入：http://localhost:7070/Struts2foo/watson/json。等到結(jié)果如下：

{"flag":"success","user":{"age":"34","name":"張三"}}

　　從上面結(jié)果可知在啟用了零配置以后，只是少了在xml中的配置，改為在每個action中用annotation進(jìn)行注解。這里刪除上面在xml中的配置，將下面的代碼寫入到上面的JsonAction的上部：

@ParentPackage("base") 
@Namespace("/watson") 
@Results({ 
 @Result(name = "json",type="json", params={"root","msg"}) 
})

　　root就相當(dāng)xml配置中的參數(shù)配置。

四.附：

　　action的返回類型為json時的可配置參數(shù)詳解：

<result type="json"> 
 <!-- 這里指定將被Struts2序列化的屬性，該屬性在action中必須有對應(yīng)的getter方法 --> 
 <!-- 默認(rèn)將會序列所有有返回值的getter方法的值，而無論該方法是否有對應(yīng)屬性 --> 
 <param name="root">dataMap</param> 
 <!-- 指定是否序列化空的屬性 --> 
 <param name="excludeNullProperties">true</param> 
 <!-- 這里指定將序列化dataMap中的那些屬性 --> 
 <param name="includeProperties">userList.*</param> 
 <!-- 這里指定將要從dataMap中排除那些屬性，這些排除的屬性將不被序列化，一般不與上邊的參數(shù)配置同時出現(xiàn) --> 
 <param name="excludeProperties">SUCCESS</param> 
</result>

附件下載

StrutsJson.rar

Struts2foo.rar

以上就是Struts2返回JSON對象的全部內(nèi)容，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: