Struts2返回JSON數據的方式總結2

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

一.使用Servlet的輸出流

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

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

編寫接口代碼：

這裏的方法與一般的Struts2方法的區別是這裏是void返回類型。

public void write() throws IOException{
	HttpServletResponse response=ServletActionContext.getResponse();
	/*
	 * 在調用getWriter之前未設置編碼(既調用setContentType或者setCharacterEncoding方法設置編碼),
	 * HttpServletResponse則會返回一個用默認的編碼(既ISO-8859-1)編碼的PrintWriter實例。這樣就會
	 * 造成中文亂碼。而且設置編碼時必須在調用getWriter之前設置,不然是無效的。
	 * */
	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配置沒有任何區別，只是沒有返回的視圖而已。

<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的擴展

要使用這個擴展功能肯定需要添加支持包。經過本人的調試，這裏有兩種選擇：

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的時候會出現：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中也沒有該類。

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

編寫接口代碼

該類中json()方法就是普通Struts2的方法。在這裏沒有看到任何JSON格式的字符串，因爲我們將要把這項工作交給擴展去完成。在沒有任何設定的情況下，改類下的所有getter方法的返回值將被包含在返回給客戶端的JSON字符串中。要剔除不需要包含的屬性，在類結構結構中需要在getter方法上使用@JSON(serialize=false)進行註解,當然在不影響其他業務的時候也可以直接去掉這個getter方法。所以本例中的返回結果是將dataMap對象轉換成的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中的數據將會被Struts2轉換成JSON字符串，所以這裏要先清空其中的數據
		dataMap = new HashMap<String, Object>();
		User user = new User();
		user.setName("張三");
		user.setPassword("123");
		dataMap.put("user", user);
		// 放入一個是否操作成功的標識
		dataMap.put("success", true);
		// 返回結果
		return SUCCESS;
	}

	public Map<String, Object> getDataMap() {
		return dataMap;
	}

	//設置key屬性不作爲json的內容返回
	@JSON(serialize=false)
	public String getKey() {
		return key;
	}
	
}

配置aciton

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

<?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中必須有對應的getter方法 -->
				<param name="root">dataMap</param>
			</result>
		</action>
    </package>
</struts>

返回值

Console代碼

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

三. Struts2零配置使用方法，使用Maven構件：

3.1）建立一個webapp，這裏還是採用Maven構建，構建過程參考limingnihao的blog：使用Eclipse構建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>

經過測試，上面的依賴包間沒有出現版本兼容的bug，不僅僅因爲他們是同一個版本，更加得益於Maven的自動構建方式。

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，設置一些基本常量和應用：

<?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">
		<!-- 這裏可以設置一些全局的返回值映射關係等 -->
	</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進行設置，所以對於Convention插件而言，默認的它會把所有類名以Action結尾的java類當成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。等到結果如下：

Json代碼 

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

從上面結果可知在啓用了零配置以後，只是少了在xml中的配置，改爲在每個action中用annotation進行註解。這裏刪除上面在xml中的配置，將下面的代碼寫入到上面的JsonAction的上部：

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

root就相當xml配置中的參數配置。

四.附 ：

action的返回類型爲json時的可配置參數詳解：

Xml代碼

<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>

參考：

1.《深入瞭解Struts2返回JSON數據的原理及具體應用範例》

2.添加支持包時的bug彙總：http://hi.baidu.com/chennning/item/53d8f8b97c1fd5d985dd79de

3.jjiag22222的BLOG《HttpServletResponse中獲取PrintWriter需要注意的一個小問題》

4.struts2 零配置詳解： http://topic.csdn.net/u/20101130/11/a47de200-c0e2-4daa-841b-5b2cb659f66b.html?45426

Struts2返回JSON數據的方式總結2

「Pygors跨平臺GUI」1：Pygors跨平臺GUI應用研究

[轉帖]

python列出centos7內存使用前50的進程信息

「Pygors跨平臺GUI」2：安裝MinGW-w64、MSYS2還是WSL2

一鍵自動化博客發佈工具,用過的人都說好(掘金篇)

Garnet：微軟官方基於.NET開源的高性能分佈式緩存存儲數據庫

Flink執行圖

Java響應式編程

評估統計算法在銀行僞造鈔票檢測中的價值

Dokcer部署Kafka集羣

日期和時間選擇對話框

Struts2返回JSON數據的方式總結2

Sqlite分頁

Android菜單使用之ContextMenu（上下文菜單）

Struts2返回JSON數據的方式總結1

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結