您的位置：首页 > 编程语言 > Java开发

11级_Java_曹建波 04.06 Struts2 返回json数据的详细介

2013-04-07 13:28 393 查看

Struts2 返回json数据的详细介绍

在Action中以传统方式输出JSON数据

public void doAction() throws IOException{

HttpServletResponse response=ServletActionContext.getResponse();

//以下代码从JSON.java中拷过来的

response.setContentType("text/html");

PrintWriter out;

out = response.getWriter();

//将要被返回到客户端的对象

User user=new User();

user.setId("123");

user.setName("JSONActionGeneral");

user.setPassword("JSON");

user.setSay("Hello , i am a action to print a json!");

JSONObject json=new JSONObject();

json.accumulate("success", true);

json.accumulate("user", user);

out.println(json.toString());

// 因为JSON数据在传递过程中是以普通字符串形式传递的，所以我们也可以手动拼接符合JSON语法规范的字符串输出到客户端

// 以下这两句的作用与38-46行代码的作用是一样的，将向客户端返回一个User对象，和一个success字段

// String jsonString="{\"user\":{\"id\":\"123\",\"name\":\"JSONActionGeneral\",\"say\":\"Hello , i am a action to print a json!\",\"password\":\"JSON\"},\"success\":true}";

// out.println(jsonString);

out.flush();

out.close();

}

struts.xml中的配置:

<package name="default" extends="struts-default" namespace="/">

<action name="testJSONFromActionByGeneral" class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="doAction">

</action>

</package>

注意:这个action没有result，且doAction方法没有返回值!

在Action中以Struts2的方式输出JSON数据

本着“不重复发明轮子”的原则，我们将转换JSON数据的工作交给Struts2来做，那么相对于在Action中以传统方式输出JSON不同的是，Action是需要将注意力放在业务处理上，而无需关心处理结果是如何被转换成JSON被返回客户端的——这些工作通过简单的配置，Struts2会帮我们做的更好。

public String testByAction() {

// dataMap中的数据将会被Struts2转换成JSON字符串，所以这里要先清空其中的数据

dataMap.clear();

User user = new User();

user.setId("123");

user.setName("JSONActionStruts2");

user.setPassword("123");

user.setSay("Hello world !");

dataMap.put("user", user);

// 放入一个是否操作成功的标识

dataMap.put("success", true);

// 返回结果

return SUCCESS;

}

struts.xml中action的配置:

<package name="json" extends="json-default" namespace="/test">

<action name="testByAction"

class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="testByAction">

<result type="json">



<param name="root">dataMap</param>

</result>

</action>

</package>

凡是使用Struts2序列化对象到JSON的action，所在的package必须继承自json-default，注意，这里唯一的result，没有指定name属性。

结果如下图所示:

上面很详细的说明了在WEB应用中如何返回JSON数据到客户端，讲了那么多种方式，涉及的技术核心无非只有两点：

1、将对象转换成符合JSON语法格式的字符串；

2、将符合JSON语法格式的字符串返回客户端；

第二点是整个实现过程的本质，但却不难做到；第一点其实也不难，他甚至有两种做法，一是通过字符串拼接方式，而是通过JSONObject以对象方式转换。看下面的一个例子：

package cn.ysh.studio.struts2.json.demo.test;

import cn.ysh.studio.struts2.json.demo.bean.User;

import net.sf.json.JSONObject;

public class JSONTest {

/**

* 将普通的pojo转换成JSON字符串

* @return

*/

public JSONObject bean2json() {

User user = new User();

user.setId("JSONTest");

user.setName("JSONTest");

user.setPassword("JSON");

user.setSay("Hello,i am JSONTest.java");

JSONObject jsonObject = new JSONObject();

jsonObject.accumulate("user", user);

System.out.println("User转换后的字符串:"+jsonObject.toString());

return jsonObject;

}

/**

* 从JSONObject对象中反向解析出User对象

* @param jsonObject

*/

public void json2bean(JSONObject jsonObject) {

User user=(User)JSONObject.toBean((JSONObject)jsonObject.get("user"),User.class);

System.out.println("转换得到的User对象的Name为:"+user.getName());

}

public static void main(String[] s) {

JSONTest tester=new JSONTest();

tester.json2bean(tester.bean2json());

}

}

JSON格式的字符串返回到客户端后，客户端会将其解析并封装成真正的JSON对象，以供JS调用。

返回JSON数据时在result中配置的参数的含义及其常见常见配置：

<result type="json">





<param name="root">dataMap</param>



<param name="excludeNullProperties">true</param>



<param name="includeProperties">

userList.*

</param>



<param name="excludeProperties">

SUCCESS

</param>

</result>

值得一提的是通过Struts2来返回JSON数据，在IE中会提示下载，这个不用关心，换个浏览器就能正常展示JSON数据，而在JS调用中，更是毫无影响。

下面是整个Action的完整代码

package cn.ysh.studio.struts2.json.demo.action;

import java.io.IOException;

import java.io.PrintWriter;

import java.util.HashMap;

import java.util.Map;

import javax.servlet.http.HttpServletResponse;

import org.apache.struts2.ServletActionContext;

import net.sf.json.JSONObject;

import cn.ysh.studio.struts2.json.demo.bean.User;

import com.opensymphony.xwork2.ActionSupport;

public class UserAction extends ActionSupport {

/**

*

*/

private static final long serialVersionUID = 1L;

//将会被Struts2序列化为JSON字符串的对象

private Map<String, Object> dataMap;

/**

* 构造方法

*/

public UserAction() {

//初始化Map对象

dataMap = new HashMap<String, Object>();

}

/**

* 测试通过action以视图方式返回JSON数据

* @return

*/

public String testByJSP() {

User user = new User();

user.setId("123");

user.setName("JSONActionJSP");

user.setPassword("123");

user.setSay("Hello world !");

JSONObject jsonObject=new JSONObject();

jsonObject.accumulate("user", user);

jsonObject.accumulate("success", true);

//这里在request对象中放了一个data，所以struts的result配置中不能有type="redirect"

ServletActionContext.getRequest().setAttribute("data", jsonObject.toString());

return SUCCESS;

};

/**

* 测试通过action以Struts2默认方式返回JSON数据

* @return

*/

public String testByAction() {

// dataMap中的数据将会被Struts2转换成JSON字符串，所以这里要先清空其中的数据

dataMap.clear();

User user = new User();

user.setId("123");

user.setName("JSONActionStruts2");

user.setPassword("123");

user.setSay("Hello world !");

dataMap.put("user", user);

// 放入一个是否操作成功的标识

dataMap.put("success", true);

// 返回结果

return SUCCESS;

}

/**

* 通过action是以传统方式返回JSON数据

* @throws IOException

*/

public void doAction() throws IOException{

HttpServletResponse response=ServletActionContext.getResponse();

//以下代码从JSON.java中拷过来的

response.setContentType("text/html");

PrintWriter out;

out = response.getWriter();

//将要被返回到客户端的对象

User user=new User();

user.setId("123");

user.setName("JSONActionGeneral");

user.setPassword("JSON");

user.setSay("Hello , i am a action to print a json!");

JSONObject json=new JSONObject();

json.accumulate("success", true);

json.accumulate("user", user);

out.println(json.toString());

// 因为JSON数据在传递过程中是以普通字符串形式传递的，所以我们也可以手动拼接符合JSON语法规范的字符串输出到客户端

// 以下这两句的作用与38-46行代码的作用是一样的，将向客户端返回一个User对象，和一个success字段

// String jsonString="{\"user\":{\"id\":\"123\",\"name\":\"JSONActionGeneral\",\"say\":\"Hello , i am a action to print a json!\",\"password\":\"JSON\"},\"success\":true}";

// out.println(jsonString);

out.flush();

out.close();

}

/**

* Struts2序列化指定属性时，必须有该属性的getter方法，实际上，如果没有属性，而只有getter方法也是可以的

* @return

*/

public Map<String, Object> getDataMap() {

return dataMap;

}

}

完整的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="json" extends="json-default" namespace="/test">

<action name="testByAction"

class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="testByAction">

<result type="json">





<param name="root">dataMap</param>













</result>

</action>

</package>

<package name="default" extends="struts-default" namespace="/">

<action name="testJSONFromActionByGeneral"

class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="doAction">

</action>

<action name="testByJSP"

class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="testByJSP">

<result name="success">/actionJSP.jsp</result>

</action>

</package>

</struts>

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理

标签：

相关文章推荐

新的分享

章节导航