Struts2返回JSON对象的方法总结

一、为什么struts2要返回json
     
如果是作为客户端的HTTP+JSON接口工程，没有JSP等view视图的情况下，使用Jersery框架开发绝对是第一选择。而在基于Spring3
MVC的架构下，对HTTP+JSON的返回类型也有很好的支持。但是，在开发工作中，对功能的升级是基于既定架构是很常见的情况。本人碰到需要用开发基于Struts2的HTTP+JSON返回类型接口就是基于既定框架结构下进行的。

struts2和json的集成,是为了适应在action
处理完后需要向对端输出相应对象的多个属性,简单的例子是:多级select标签的联动,这个时候从action返回的值不仅仅是SUCCESS
or ERROR这么简单,而是在后端拼接好的<option>xxx</option>或者是<option>中所需数据。这个时候JSON排上了用场

二、struts2返回json的方式

Struts2返回JSON有两种方式：1.使用Servlet的输出流写入JSON字符串；2.使用Struts2对JSON的扩展。

当然，无论使用哪种方式都是要引入jar的：struts2-json-plugin-2.1.8.1.jar （方式二需要此插件包）json-lib-2.1.jar
commons-collections-3.2.1.jar commons-beanutils-1.8.2.jar
commons-lang-2.4.jar
ezmorph-1.0.6.jar,其他的包略，这几个包是返回json形式的数据必须的
这几个包是返回json形式的数据必须的
     
方式一、使用Servlet的输出流
       
JSON接口的实质是：JSON数据在传递过程中，其实就是传递一个普通的符合JSON语法格式的字符串而已，所谓的“JSON对象”是指对这个JSON字符串解析和包装后的结果。

所以这里只需要将一个JSON语法格式的字符串写入到Servlet的HttpServletResponse中，这里使用的是PrintWriter的方式，当然也可以采用Stream流的方式。需要注意的是：在调用getWriter之前未设置编码(既调用setContentType或者setCharacterEncoding方法设置编码),
HttpServletResponse则会返回一个用默认的编码(既ISO-8859-1)编码的PrintWriter实例。这样就会造成中文乱码。而且设置编码时必须在调用getWriter之前设置,不然是无效的。

     
步骤1、编写接口代码：

这里的方法与一般的Struts2方法的区别是这里是void返回类型。
    public void write() throws
IOException{
   
HttpServletResponse
response=ServletActionContext.getResponse();
   
   
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();
}
  
###注意：
 
上面是手动拼接json字符，我们也可以使用json的工具包将获取的list数据转换为json字符串：
     
List<Brh> brhs = new
ArrayList<Brh>();
   
   
    brhs.add(new
Brh("1", "机构1"));
   
   
    brhs.add(new
Brh("2", "机构2"));
   
   
    brhs.add(new
Brh("3", "机构3"));
   
   
    brhs.add(new
Brh("4", "机构4"));
   
   
   
//转换为json数据
   
   
    String
jsonString = JSONArray.fromObject(brhs).toString();

步骤2：配置action
          
从以下的配置中可以明显的看到配置与普通的action配置没有任何区别，只是没有返回的视图而已。
       
<action name="write" class="json.JsonAction"
method="write" />

  
步骤3：我们可以使用firebug或者谷歌的调试工具等看到返回的json字符串
      
    {"user":{"id":"123","name":"张三","say":"Hello , i am a
action to print a
json!","password":"JSON"},"success":true}
        
步骤1的注意中返回的json字符串为：
        
[{"brhId":"1","brhName":"机构1"},{"brhId":"2","brhName":"机构2"},{"brhId":"3","brhName":"机构3"},{"brhId":"4","brhName":"机构4"}]

 
方式二、使用Struts2对JSON的扩展
  
   步骤1、编写接口文档

该类中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;

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.clear();
   
    dataMap =
new HashMap<String, Object>();
   
    User user =
new User();
   
   
user.setName("张三");
   
   
user.setPassword("123");
   
   
dataMap.put("user", user);
   
    //
放入一个是否操作成功的标识
   
   
dataMap.put("success", true);
   
    //
返回结果
   
    return
"myJson";
    }
    public
Map<String, Object> getDataMap()
{
   
    return
dataMap;
    }

//设置key属性不作为json的内容返回
   
@JSON(serialize=false)
    public
String getKey() {
   
    return
key;
    }
}

####说明：
  在属性get方法上面加
  @JSON(name="newName")json中的名称
  @JSON(serialize=false) 该属性不被加入json
  @JSON(format="yyyy-MM-dd") 格式化日期

步骤2：配置action
    
在配置中，首先需要action所在的package继承了json-default（其实json-default已经继承类
struts-default），或者继承的父包继承了json-default。这配置action的返回result类型的type为json,result设置成json之后，容器会把action的属性自动封装到一个json对象中（json拦截器来做），然后调用js的callback方法.
返回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="json-default" >
   
   
<action name="testJson"
class="json.JsonAction" method="json">
   
   
   
<result name="myJson"
type="json">
         
<!-- 是否去掉返回值为NULL的properties
-->
           
<param
name="excludeNullProperties">true</param>

<!-- 这里指定将被Struts2序列化的属性，该属性在action中必须有对应的getter方法
-->
   
   
   
   
<param
name="root">dataMap</param>


<!--<param
name="includeProperties">  
dataMap.*
</param>
-->
   
   
   
</result>
   
   
</action>
   
</package>
</struts>
 
   步骤3：查看json返回值
        
{"success":true,"user":{"name":"张三","password":"123"}}

如果上面param配置的是includeProperties，那么返回值就是：

{"dataMap":{"success":true,"user":{"name":"张三","password":"123"}}}

总结：即如果使用includeProperties
或者excludeProperties
参数，那么返回的json字符串的key就是这里的属性名，value就是该属性的值（精华呀！！！！！）

################json中param详解#######################
    
<param
name="root">：是指定将被Struts2序列化的属性转为json字符串，该属性在action中必须有对应的getter方法。

我们有时候需要根据实际情况返回部分结果，如何对json的结果进行定制输出呢？result提供了一些参数替你解决这个问题，一般情况下用的最多的就是includeProperties
参数和excludeNullProperties参数。当然还有其他的方法，如给pojo的属性加json注解（步骤二中以讲到）。

   includeProperties
参数：输出结果中需要包含的属性值，这里正则表达式和属性名匹配，可以用“,”分割填充多个正则表达式。这个参数直接返回对象的json数据，前台不需要eval转换；<param
name="root">result</param>则不同，如果前台请求没有指定返回json数据（即ajax请求未指定返回json），需要前台进行eval转换，
如：
  
示例1：
   输出person对象的所有属性与只输出其name
<result type="json">
   <param
name="includeProperties">person.*,
person\.name</param>
</result>

  示例2（重要（精华呀！！！！！））:

输出一个JSON List列表
   <action
name="testList" class="testAction"
method="list">

<result name="success"
type="json">
        
<param
name="includeProperties">
            
myList\[\d+\]\.Id,list\[\d+\]\.user\.userName   
<!--正则表达式--!>

</param>
   
</result>

</action>
其中myList是action中的一个List类型的属性

myList\[\d+\]\.Id表示，list中存储的对象0..end的Id属性（list中存储的对象必须有Id属性）。
myList\[\d+\]\.user\.userName表示list中的对象中的user对象的userName属性
myList.*  表示list中的所有属性

 
excludeProperties
参数：输出结果需要剔除的属性值，也支持正则表达式匹配属性名，可以用“,”分割填充多个正则表达式，类同includeProperties，但是excludeProperties有比includeProperties更高的权限.一般不与includeProperties参数配置同时出现
。

  <param
name="excludeNullProperties">：指定是否序列化空的属性

为什么要用includeProperties或excludeProperties 参数？
    
主要是为了过滤掉接口，pojo的set、list、其它对象等（好像没有Map）不
需要的数据防止循环取其它关联对象或找不到接口。如果不配置,默认是处理action中的所有属性，如果action中有接口注入，json拦截器可能找
不到接口而返回不了结果，还有如果action中有一个对象，这个对象与好多对象都有关联，json拦截器会将相关联的所有对象的属性全部转换成json
格式，如果其它对象有list、set,其返回结果相当庞大，有可能是死循环而无法返回
。如果不用<param
name="includeProperties">或其他方式进行json数据过滤，通过debug你会发现前台返回的json字符串，是把
action中的所有属性全部转化成json字符串返回给客户端（包括service接口、pojo所有属性及有关联的pojo。有时候根本返回不了结
果，也不报错，后台执行了，但前台执行不到callback
function，这主要是因为找不到接口或者关联的pojo太多，造成死循环），一般情况下用的最多的就是root、
includeProperties
和excludeNullProperties参数。当然还有其他的方法，如给pojo的属性加json注解。

时间： 2024-10-26 10:28:15

Struts2返回JSON对象的方法总结的相关文章

(转)Struts2返回JSON对象的方法总结

转自:http://kingxss.iteye.com/blog/1622455 如果是作为客户端的HTTP+JSON接口工程,没有JSP等view视图的情况下,使用Jersery框架开发绝对是第一选择.而在基于Spring3 MVC的架构下,对HTTP+JSON的返回类型也有很好的支持.但是,在开发工作中,对功能的升级是基于既定架构是很常见的情况.本人碰到需要用开发基于Struts2的HTTP+JSON返回类型接口就是基于既定框架结构下进行的. Struts2返回JSON有两种方式:1.使用S

ModelAndView返回json对象的方法

这是在spring4之后. @RequestMapping(value = "/returnjson") public ModelAndView getfsd(){ ModelAndView modelAndView=new ModelAndView(new MappingJackson2JsonView()); modelAndView.addObject("result","success"); return modelAndView; }

转载：深入了解Struts2返回JSON数据的原理及具体应用范例

早在我刚学Struts2之初的时候,就想写一篇文章来阐述Struts2如何返回JSON数据的原理和具体应用了,但苦于一直忙于工作难以抽身, 渐渐的也淡忘了此事.直到前两天有同事在工作中遇到这个问题,来找我询问,我又细细地给他讲了一遍之后,才觉得无论如何要抽一个小时的时间来写这篇文章, 从头到尾将Struts2与JSON的关系说清楚. 其实网络中,关于这个问题的答案已是海量,我当初也是从这海量的答案中吸收精华,才将“Struts2返回JSON数据”这个问题搞清楚的.但 是这些海量的答案,有一个共同

struts2返回json格式的数据

描述:当前端使用ajax发送请求到action时,如果需要返回json格式的数据,如对象集合.具体做法如下: 前端代码: <%@ page language="java" import="java.util.*" pageEncoding="utf-8"%> <% String path = request.getContextPath(); String basePath = request.getScheme()+"

转： .NET MVC3 几种返回 JSON 对象的方式和注意事项

.NET MVC3 几种返回 JSON 对象的方式和注意事项 转自:http://blog.csdn.net/xxj_jing/article/details/7382589 引言在用 .NET MVC3 给我们做 WEB 项目带来很大灵活性同时,对刚上手的同学来说有些细微的设置导致的问题让我们相当的“纠结”! 这里要讨论的就是:使用JQuery的 Ajax 请求后“返回”的JSON 数据问题. 相信大多数同学都会遇到过,就是在后台已经拼接好了一(拼接方法比较多,我的博客也有提到过!)串标准的J

struts2返回json数据类型

项目需要jar包 项目结构 web.xml <?xml version="1.0" encoding="UTF-8"?> <web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocati

js 将json字符串转换为json对象的方法解析（转）

js 将json字符串转换为json对象的方法解析 将json字符串转换为json对象的方法.在数据传输过程中,json是以文本,即字符串的形式传递的,而JS操作的是JSON对象,所以,JSON对象和JSON字符串之间的相互转换是关键 例如: JSON字符串:var str1 = '{ "name": "cxh", "sex": "man" }'; JSON对象:var str2 = { "name": &

Ajax请求php返回json对象数据中包含有数字索引和字符串索引，在for in循环中取出数据的顺序问题

//php中的数组数据格式 Array ( [all] => Array ( [title] => ALL [room_promotion_id] => all ) [best_available_rate] => Array ( [title] => Best Available Rate [room_promotion_id] => best_available_rate ) [30] => Array ( [room_promotion_id] =>

php 返回json对象

服务器端使用php+ajax调用返回json对象. php <?php $result = array('Status' => false, 'Message' => 'sss'); $jsonstring = json_encode($result); header('Content-Type: application/json'); //前面代码容易找到,但是这句是失败无数次在http://stackoverflow.com上找到的. echo $jsonstring; ?>