Struts2返回JSON對象的方法總結

時間  2019-11-08
標籤 struts2 struts 返回 json 對象 方法 總結 欄目 Struts 简体版
原文   原文鏈接

若是是做爲客戶端的HTTP+JSON接口工程，沒有JSP等view視圖的狀況下，使用Jersery框架開發絕對是第一選擇。而在基於Spring3 MVC的架構下，對HTTP+JSON的返回類型也有很好的支持。可是，在開發工做中，對功能的升級是基於既定架構是很常見的狀況。本人碰到須要用開發基於Struts2的HTTP+JSON返回類型接口就是基於既定框架結構下進行的。 html

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

 

  一.使用Servlet的輸出流 web

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

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

 

    編寫接口代碼： 瀏覽器

   這裏的方法與通常的Struts2方法的區別是這裏是void返回類型。 tomcat


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配置沒有任何區別，只是沒有返回的視圖而已。 app

<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>
返回值 

{"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。等到結果以下： 

{"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時的可配置參數詳解： 

<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

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程