如果是作為客戶端的HTTP+JSON接口工程，沒(méi)有JSP等view視圖的情況下，使用Jersery框架開(kāi)發(fā)絕對(duì)是第一選擇。而在基于Spring3 MVC的架構(gòu)下，對(duì)HTTP+JSON的返回類型也有很好的支持。但是，在開(kāi)發(fā)工作中，對(duì)功能的升級(jí)是基于既定架構(gòu)是很常見(jiàn)的情況。本人碰到需要用開(kāi)發(fā)基于Struts2的HTTP+JSON返回類型接口就是基于既定框架結(jié)構(gòu)下進(jìn)行的。
Struts2返回JSON有兩種方式：1.使用Servlet的輸出流寫(xiě)入JSON字符串；2.使用Struts2對(duì)JSON的擴(kuò)展。
一.使用Servlet的輸出流
JSON接口的實(shí)質(zhì)是：JSON數(shù)據(jù)在傳遞過(guò)程中，其實(shí)就是傳遞一個(gè)普通的符合JSON語(yǔ)法格式的字符串而已，所謂的“JSON對(duì)象”是指對(duì)這個(gè)JSON字符串解析和包裝后的結(jié)果。
所以這里只需要將一個(gè)JSON語(yǔ)法格式的字符串寫(xiě)入到Servlet的HttpServletResponse中，這里使用的是PrintWriter的方式，當(dāng)然也可以采用Stream流的方式。需要注意的是：在調(diào)用getWriter之前未設(shè)置編碼(既調(diào)用setContentType或者setCharacterEncoding方法設(shè)置編碼), HttpServletResponse則會(huì)返回一個(gè)用默認(rèn)的編碼(既ISO-8859-1)編碼的PrintWriter實(shí)例。這樣就會(huì)造成中文亂碼。而且設(shè)置編碼時(shí)必須在調(diào)用getWriter之前設(shè)置,不然是無(wú)效的。
編寫(xiě)接口代碼：
這里的方法與一般的Struts2方法的區(qū)別是這里是void返回類型。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
public void write() throws IOException{ HttpServletResponse response=ServletActionContext.getResponse(); /* * 在調(diào)用getWriter之前未設(shè)置編碼(既調(diào)用setContentType或者setCharacterEncoding方法設(shè)置編碼), * HttpServletResponse則會(huì)返回一個(gè)用默認(rèn)的編碼(既ISO-8859-1)編碼的PrintWriter實(shí)例。這樣就會(huì) * 造成中文亂碼。而且設(shè)置編碼時(shí)必須在調(diào)用getWriter之前設(shè)置,不然是無(wú)效的。 * */ response.setContentType("text/html;charset=utf-8"); //response.setCharacterEncoding("UTF-8"); PrintWriter out = response.getWriter(); //JSON在傳遞過(guò)程中是普通字符串形式傳遞的，這里簡(jiǎn)單拼接一個(gè)做測(cè)試 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配置沒(méi)有任何區(qū)別，只是沒(méi)有返回的視圖而已。
|
1
|
<action name="write" class="json.JsonAction" method="write" /> |
返回值
|
1
|
{"user":{"id":"123","name":"張三","say":"Hello , i am a action to print a json!","password":"JSON"},"success":true} |
二.使用Struts2對(duì)JSON的擴(kuò)展
要使用這個(gè)擴(kuò)展功能肯定需要添加支持包。經(jīng)過(guò)本人的調(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及以上版本，因?yàn)閤work-core-*.jar的2.2.1及以上版本中沒(méi)有了org.apache.commons.lang等包。啟動(dòng)tomcat的時(shí)候會(huì)出現(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。因?yàn)閖sonplugin-0.34.jar需要com.opensymphony.xwork2.util.TextUtils這個(gè)類的支持。而xwork-core-*.jar的2.2.1以上版本均為找到該類，且在xwork-core-2.1.6.jar中也沒(méi)有該類。
最后說(shuō)一句，還因?yàn)橛迷紭?gòu)建方式而不停蹚雷，確實(shí)不值得，真心累。使用Maven等自動(dòng)化構(gòu)件方式，會(huì)在很大程度上避免依賴包間的版本差異的bug。第三節(jié)的“struts2零配置”中會(huì)使用maven的構(gòu)件方式。
編寫(xiě)接口代碼
該類中json()方法就是普通Struts2的方法。在這里沒(méi)有看到任何JSON格式的字符串，因?yàn)槲覀儗⒁堰@項(xiàng)工作交給擴(kuò)展去完成。在沒(méi)有任何設(shè)定的情況下，改類下的所有g(shù)etter方法的返回值將被包含在返回給客戶端的JSON字符串中。要剔除不需要包含的屬性，在類結(jié)構(gòu)結(jié)構(gòu)中需要在getter方法上使用@JSON(serialize=false)進(jìn)行注解,當(dāng)然在不影響其他業(yè)務(wù)的時(shí)候也可以直接去掉這個(gè)getter方法。所以本例中的返回結(jié)果是將dataMap對(duì)象轉(zhuǎn)換成的JSON格式的字符串。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
package json; import java.util.HashMap; import java.util.Map; import org.apache.struts2.json.annotations.JSON; import com.opensymphony.xwork2.ActionSupport; /** * JSON測(cè)試 * * @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ù)將會(huì)被Struts2轉(zhuǎn)換成JSON字符串，所以這里要先清空其中的數(shù)據(jù) dataMap = new HashMap<String, Object>(); User user = new User(); user.setName("張三"); user.setPassword("123"); dataMap.put("user", user); // 放入一個(gè)是否操作成功的標(biāo)識(shí) 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ù)
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
<?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中必須有對(duì)應(yīng)的getter方法 --> <param name="root">dataMap</param> </result> </action> </package> </struts> |
返回值
|
1
|
{"success":true,"user":{"name":"張三","password":"123"}} |
三. Struts2零配置使用方法，使用Maven構(gòu)件：
3.1） 建立一個(gè)webapp，這里還是采用Maven構(gòu)建，構(gòu)建過(guò)程參考limingnihao的blog： 使用Eclipse構(gòu)建Maven的SpringMVC項(xiàng)目 。
3.2） 添加Struts2的依賴、struts2零配置依賴和struts2的json依賴：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
<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)過(guò)測(cè)試，上面的依賴包間沒(méi)有出現(xiàn)版本兼容的bug，不僅僅因?yàn)樗麄兪峭粋€(gè)版本，更加得益于Maven的自動(dòng)構(gòu)建方式。
3.3） 配置web.xml，啟用Struts2：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
<?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)用：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
<?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）編寫(xiě)和配置Action。由并未指定Convention進(jìn)行設(shè)置，所以對(duì)于Convention插件而言，默認(rèn)的它會(huì)把所有類名以Action結(jié)尾的java類當(dāng)成Action處理：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
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）部署項(xiàng)目，啟動(dòng)容器，瀏覽器地址欄中輸入：http://localhost:7070/Struts2foo/watson/json。等到結(jié)果如下：
|
1
|
{"flag":"success","user":{"age":"34","name":"張三"}} |
從上面結(jié)果可知在啟用了零配置以后，只是少了在xml中的配置，改為在每個(gè)action中用annotation進(jìn)行注解。這里刪除上面在xml中的配置，將下面的代碼寫(xiě)入到上面的JsonAction的上部：
|
1
2
3
4
5
|
@ParentPackage("base") @Namespace("/watson") @Results({ @Result(name = "json",type="json", params={"root","msg"}) }) |
root就相當(dāng)xml配置中的參數(shù)配置。
四.附 ：
action的返回類型為json時(shí)的可配置參數(shù)詳解：
|
1
2
3
4
5
6
7
8
9
10
11
|
<result type="json"> <!-- 這里指定將被Struts2序列化的屬性，該屬性在action中必須有對(duì)應(yīng)的getter方法 --> <!-- 默認(rèn)將會(huì)序列所有有返回值的getter方法的值，而無(wú)論該方法是否有對(duì)應(yīng)屬性 --> <param name="root">dataMap</param> <!-- 指定是否序列化空的屬性 --> <param name="excludeNullProperties">true</param> <!-- 這里指定將序列化dataMap中的那些屬性 --> <param name="includeProperties">userList.*</param> <!-- 這里指定將要從dataMap中排除那些屬性，這些排除的屬性將不被序列化，一般不與上邊的參數(shù)配置同時(shí)出現(xiàn) --> <param name="excludeProperties">SUCCESS</param> </result> |
附件下載
以上就是Struts2返回JSON對(duì)象的全部?jī)?nèi)容，希望能給大家一個(gè)參考，也希望大家多多支持服務(wù)器之家。
