Struts2返回JSON对象的方法总结
来源:互联网 发布:2017日剧推荐知乎 编辑:程序博客网 时间:2024/05/22 07:41
如果是作为客户端的HTTP+JSON接口工程,没有JSP等view视图的情况下,使用Jersery框架开发绝对是第一选择。而在基于Spring3 MVC的架构下,对HTTP+JSON的返回类型也有很好的支持。但是,在开发工作中,对功能的升级是基于既定架构是很常见的情况。本人碰到需要用开发基于Struts2的HTTP+JSON返回类型接口就是基于既定框架结构下进行的。
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返回类型。
01
public
void
write()
throws
IOException{
02
HttpServletResponse response=ServletActionContext.getResponse();
03
/*
04
* 在调用getWriter之前未设置编码(既调用setContentType或者setCharacterEncoding方法设置编码),
05
* HttpServletResponse则会返回一个用默认的编码(既ISO-8859-1)编码的PrintWriter实例。这样就会
06
* 造成中文乱码。而且设置编码时必须在调用getWriter之前设置,不然是无效的。
07
* */
08
response.setContentType(
"text/html;charset=utf-8"
);
09
//response.setCharacterEncoding("UTF-8");
10
PrintWriter out = response.getWriter();
11
//JSON在传递过程中是普通字符串形式传递的,这里简单拼接一个做测试
12
String jsonString=
"{\"user\":{\"id\":\"123\",\"name\":\"张三\",\"say\":\"Hello , i am a action to print a json!\",\"password\":\"JSON\"},\"success\":true}"
;
13
out.println(jsonString);
14
out.flush();
15
out.close();
16
}
配置action
从以下的配置中可以明显的看到配置与普通的action配置没有任何区别,只是没有返回的视图而已。
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对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格式的字符串。
01
package
json;
02
03
import
java.util.HashMap;
04
import
java.util.Map;
05
06
import
org.apache.struts2.json.annotations.JSON;
07
import
com.opensymphony.xwork2.ActionSupport;
08
09
/**
10
* JSON测试
11
*
12
* @author Watson Xu
13
* @date 2012-8-4 下午06:21:01
14
*/
15
public
class
JsonAction
extends
ActionSupport{
16
private
static
final
long
serialVersionUID = 1L;
17
18
private
Map<String,Object> dataMap;
19
private
String key =
"Just see see"
;
20
21
public
String json() {
22
// dataMap中的数据将会被Struts2转换成JSON字符串,所以这里要先清空其中的数据
23
dataMap =
new
HashMap<String, Object>();
24
User user =
new
User();
25
user.setName(
"张三"
);
26
user.setPassword(
"123"
);
27
dataMap.put(
"user"
, user);
28
// 放入一个是否操作成功的标识
29
dataMap.put(
"success"
,
true
);
30
// 返回结果
31
return
SUCCESS;
32
}
33
34
public
Map<String, Object> getDataMap() {
35
return
dataMap;
36
}
37
38
//设置key属性不作为json的内容返回
39
@JSON
(serialize=
false
)
40
public
String getKey() {
41
return
key;
42
}
43
44
}
配置aciton
在配置中,首先需要action所在的package继承了json-default,或者继承的父包继承了json-default。这配置action的返回类型的type为json,并且可以配置其序列化的属性等一些类参数
01
<?
xml
version
=
"1.0"
encoding
=
"UTF-8"
?>
02
<!DOCTYPE struts PUBLIC
03
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
04
"http://struts.apache.org/dtds/struts-2.0.dtd">
05
<
struts
>
06
<
package
name
=
"json"
extends
=
"struts-default,json-default"
>
07
<
action
name
=
"json"
class
=
"json.JsonAction"
method
=
"json"
>
08
<
result
type
=
"json"
>
09
<!-- 这里指定将被Struts2序列化的属性,该属性在action中必须有对应的getter方法 -->
10
<
param
name
=
"root"
>dataMap</
param
>
11
</
result
>
12
</
action
>
13
</
package
>
14
</
struts
>
1
{
"success"
:
true
,
"user"
:{
"name"
:
"张三"
,
"password"
:
"123"
}}
三. Struts2零配置使用方法,使用Maven构件:
3.1) 建立一个webapp,这里还是采用Maven构建,构建过程参考limingnihao的blog: 使用Eclipse构建Maven的SpringMVC项目 。
3.2) 添加Struts2的依赖、struts2零配置依赖和struts2的json依赖:
01
<
dependencies
>
02
<!-- struts2核心依赖 -->
03
<
dependency
>
04
<
groupId
>org.apache.struts</
groupId
>
05
<
artifactId
>struts2-core</
artifactId
>
06
<
version
>2.3.4</
version
>
07
<
type
>jar</
type
>
08
<
scope
>compile</
scope
>
09
</
dependency
>
10
<!-- struts2零配置依赖 -->
11
<
dependency
>
12
<
groupId
>org.apache.struts</
groupId
>
13
<
artifactId
>struts2-convention-plugin</
artifactId
>
14
<
version
>2.3.4</
version
>
15
<
type
>jar</
type
>
16
<
scope
>compile</
scope
>
17
</
dependency
>
18
<!-- struts2的json依赖 -->
19
<
dependency
>
20
<
groupId
>org.apache.struts</
groupId
>
21
<
artifactId
>struts2-json-plugin</
artifactId
>
22
<
version
>2.3.4</
version
>
23
<
type
>jar</
type
>
24
<
scope
>compile</
scope
>
25
</
dependency
>
26
</
dependencies
>
经过测试,上面的依赖包间没有出现版本兼容的bug,不仅仅因为他们是同一个版本,更加得益于Maven的自动构建方式。
3.3) 配置web.xml,启用Struts2:
01
<?
xml
version
=
"1.0"
encoding
=
"UTF-8"
?>
02
<
web-app
version
=
"2.5"
xmlns
=
"http://java.sun.com/xml/ns/javaee"
03
xmlns:xsi
=
"http://www.w3.org/2001/XMLSchema-instance"
04
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
05
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
06
07
<
filter
>
08
<
filter-name
>StrutsPrepareAndExecuteFilter </
filter-name
>
09
<
filter-class
>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter </
filter-class
>
10
<
init-param
>
11
<
param-name
>config</
param-name
>
12
<
param-value
>struts-default.xml,struts-plugin.xml,struts.xml</
param-value
>
13
</
init-param
>
14
</
filter
>
15
<
filter-mapping
>
16
<
filter-name
>StrutsPrepareAndExecuteFilter</
filter-name
>
17
<
url-pattern
>/*</
url-pattern
>
18
</
filter-mapping
>
19
</
web-app
>
01
<?
xml
version
=
"1.0"
encoding
=
"UTF-8"
?>
02
<!DOCTYPE struts PUBLIC
03
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
04
"http://struts.apache.org/dtds/struts-2.0.dtd">
05
06
<
struts
>
07
<
package
name
=
"base"
extends
=
"json-default,struts-default"
>
08
<!-- 这里可以设置一些全局的返回值映射关系等 -->
09
</
package
>
10
11
<
constant
name
=
"struts.action.extension"
value
=
""
/>
12
<
constant
name
=
"struts.ui.theme"
value
=
"simple"
/>
13
<
constant
name
=
"struts.i18n.encoding"
value
=
"utf-8"
/>
14
<
constant
name
=
"struts.multipart.maxSize"
value
=
"1073741824"
/>
15
<
constant
name
=
"struts.devMode"
value
=
"false"
/>
16
</
struts
>
01
package
watson.action;
02
03
import
java.util.HashMap;
04
import
java.util.Map;
05
06
import
org.apache.struts2.convention.annotation.Action;
07
import
org.apache.struts2.convention.annotation.Namespace;
08
import
org.apache.struts2.convention.annotation.ParentPackage;
09
import
org.apache.struts2.convention.annotation.Result;
10
import
org.apache.struts2.convention.annotation.Results;
11
12
@ParentPackage
(
"base"
)
13
@Namespace
(
"/watson"
)
14
@Results
({
15
@Result
(name =
"json"
,type=
"json"
, params={
"root"
,
"msg"
})
16
})
17
public
class
JsonAction {
18
19
@Action
(value=
"json"
)
20
public
String json() {
21
msg =
new
HashMap<String, Object>();
22
msg.put(
"flag"
,
"success"
);
23
24
Map<String, String> user =
new
HashMap<String, String>();
25
user.put(
"name"
,
"张三"
);
26
user.put(
"age"
,
"34"
);
27
msg.put(
"user"
, user);
28
return
"json"
;
29
}
30
31
//==================================
32
private
Map<String, Object> msg;
33
34
public
Map<String, Object> getMsg() {
35
return
msg;
36
}
37
38
}
1
{
"flag"
:
"success"
,
"user"
:{
"age"
:
"34"
,
"name"
:
"张三"
}}
1
@ParentPackage
(
"base"
)
2
@Namespace
(
"/watson"
)
3
@Results
({
4
@Result
(name =
"json"
,type=
"json"
, params={
"root"
,
"msg"
})
5
})
root就相当xml配置中的参数配置。
四.附 :
action的返回类型为json时的可配置参数详解:
01
<
result
type
=
"json"
>
02
<!-- 这里指定将被Struts2序列化的属性,该属性在action中必须有对应的getter方法 -->
03
<!-- 默认将会序列所有有返回值的getter方法的值,而无论该方法是否有对应属性 -->
04
<
param
name
=
"root"
>dataMap</
param
>
05
<!-- 指定是否序列化空的属性 -->
06
<
param
name
=
"excludeNullProperties"
>true</
param
>
07
<!-- 这里指定将序列化dataMap中的那些属性 -->
08
<
param
name
=
"includeProperties"
>userList.*</
param
>
09
<!-- 这里指定将要从dataMap中排除那些属性,这些排除的属性将不被序列化,一般不与上边的参数配置同时出现 -->
10
<
param
name
=
"excludeProperties"
>SUCCESS</
param
>
11
</
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
原文地址:http://kingxss.iteye.com/blog/1622455
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结(*****)
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- Struts2返回JSON对象的方法总结
- SpringMVC 配置
- 如何删除不必要的开票的出库单?
- c#描述异常处理语句try、catch、finally执行时的相互关系
- 所以我们要多发现身边的追求文明公德
- 查看Strut2的源代码的方式 基于myeclipse
- Struts2返回JSON对象的方法总结
- 我突然听到朋友的追求叫声
- 在每一座宫和殿的追求前面都有这样的两个水缸
- 我突然想到了许多狗狗在我身边
- vc中键盘输入
- 是什么将你身上的运动服变成了笔挺的西装
- Java transient关键字使用小结及一些需要注意的细节
- linux系统安装 FLASH插件
- 画个圆吧---C语言画圆