Struts2 Result 返回JSON对象详解

　　如果是作为客户端的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返回类型。

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> 

　　返回值

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

附件下载

strutsjson.rar

struts2foo.rar

以上就是struts2返回json对象的全部内容，希望能给大家一个参考，也希望大家多多支持。