ssh配置客户端和服务器的交互json传递数据

我的测试样例

服务器端

package com.vin.ssh.action.cmcc;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.json.JsonObject;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.xml.ws.Action;

import net.sf.json.JSONObject;

import org.apache.struts2.ServletActionContext;
import org.apache.struts2.interceptor.RequestAware;
import org.apache.struts2.interceptor.ServletRequestAware;
import org.apache.struts2.interceptor.ServletResponseAware;

import com.opensymphony.xwork2.ActionContext;
import com.opensymphony.xwork2.ActionSupport;
import com.vin.ssh.entities.Department;


public class BaseClientAction extends ActionSupport implements ServletRequestAware, ServletResponseAware{
	
	private Map<String, Object> request;
	private Map<String, Object> responseJson;
	
	private HttpServletRequest httpServletRequest;
	private HttpServletResponse httpServletResponse;
	
	private Integer id;
	private String name;
	
	public Integer getId()
	{
		return id;
	}
	public void setId(Integer id)
	{
		this.id = id;
	}
	public String getName()
	{
		return name;
	}
	public void setName(String name)
	{
		this.name = name;
	}
	
	public void setResponseJson(Map<String, Object> responseJson) {
		this.responseJson = responseJson;
	}
	
	public Map<String, Object> getResponseJson() {
		return responseJson;
	}
	
	public void sendClientRequest() throws IOException
	{
//		httpServletRequest=ServletActionContext.getRequest();
//		httpServletResponse=ServletActionContext.getResponse();
		
		System.out.println(httpServletRequest.getParameterNames());
		System.out.println(httpServletRequest.getParameterMap());
		System.out.println(httpServletRequest.getParameterValues("name"));
		
		httpServletResponse.setContentType("application/json;charset=utf-8");
		Map<String, String[]> parameterMap = httpServletRequest.getParameterMap();
		for(Enumeration<String> parameterNames = httpServletRequest.getParameterNames(); parameterNames.hasMoreElements(); )
		{
			String element=parameterNames.nextElement();
			System.out.println(element);
			String[] values=parameterMap.get(element);
			for(int i=0; i<values.length; i++)
			{
				System.out.println(values[i]);
			}
		}
		JSONObject jsonObject=new JSONObject();
		jsonObject.put("number", 2);
		jsonObject.put("shop_name", "宿舍");
		jsonObject.put("ctime", "2015-09-18");
		List<Map<String, Object>> list=new ArrayList<Map<String, Object>>();
		Map<String, Object> map=new HashMap<String, Object>();
		map.put("id", "1001");
		map.put("name", "janvinal");
		list.add(map);
		jsonObject.put("users", list);
		
		System.out.println("id="+getId());
		System.out.println("name="+getName());
		
		httpServletResponse.getWriter().write(jsonObject.toString());
		
/*		responseJson=new HashMap<String, Object>();
		responseJson.put("number", 2);
		responseJson.put("shop_name", "宿舍");
		responseJson.put("ctime", "2015-09-18");
		List<Map<String, Object>> list=new ArrayList<Map<String, Object>>();
		Map<String, Object> map=new HashMap<String, Object>();
		map.put("id", "1001");
		map.put("name", "janvinal");
		list.add(map);
		responseJson.put("user", list);
		
		System.out.println("id="+getId());
		System.out.println("name="+getName());
		
		httpServletResponse.getWriter().write(responseJson.toString());
		return "sendClientRequest";*/
	}

	@Override
	public void setServletResponse(HttpServletResponse httpServletResponse)
	{
		this.httpServletResponse=httpServletResponse;
	}

	@Override
	public void setServletRequest(HttpServletRequest httpServletRequest)
	{
		this.httpServletRequest=httpServletRequest;
	}
	
}

客户端

package com.vin.ssh.http;

import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.Map.Entry;

import net.sf.json.JSONArray;
import net.sf.json.JSONObject;

import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpException;
import org.apache.commons.httpclient.NameValuePair;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.params.HttpClientParams;
import org.apache.log4j.Logger;
import org.junit.Test;

public class BaseHttpClient {
	
	@Test
	public void test1() throws HttpException, IOException {
		HttpClient httpClient=new HttpClient();
		PostMethod postMethod=new PostMethod("http://localhost:8080/SSH/cmcc/sendClientRequest.do");
		
		Map<String, Object> map=new HashMap<String, Object>();
		map.put("id", "11");
		map.put("name", "janvinal");
		NameValuePair[] parametersBody=new NameValuePair[map.size()];
		int index=0;
		for(Entry<String, Object> e : map.entrySet() )
		{
			parametersBody[index++]=new NameValuePair(e.getKey(), e.getValue()+"");
		}
		postMethod.setRequestBody(parametersBody);
		HttpClientParams params=new HttpClientParams();
		params.setContentCharset("utf-8");
		httpClient.setParams(params);
		
		httpClient.executeMethod(postMethod);
		System.out.println(postMethod.getStatusCode());
		System.out.println(postMethod.getStatusLine());
		System.out.println(postMethod.getStatusText());
		String result=postMethod.getResponseBodyAsString();
		System.out.println("result="+result);
		JSONObject jsonObject=JSONObject.fromObject(result);
		Map<String, Object> resultMap=new HashMap<String, Object>();
		for(Iterator<Object> iter=jsonObject.keys(); iter.hasNext(); )
		{
			String key=(String) iter.next();
			if( key.equals("users") )
			{
				JSONArray jsonArray=JSONArray.fromObject(jsonObject.get(key));
				List<Map<String, Object>> tmpList=new ArrayList<Map<String, Object>>();
				for(ListIterator<Object> listIter=jsonArray.listIterator(); listIter.hasNext(); )
				{
					Map<String, Object> tmpMap=(Map<String, Object>) listIter.next();
					System.out.println(tmpMap);
					System.out.println(tmpMap.get("id"));
					tmpList.add(tmpMap);
				}
				resultMap.put("list", tmpList);
				continue;
			}
			resultMap.put(key, jsonObject.get(key));
		}
		System.out.println("resultMap="+resultMap);
		
		
//		Logger logger=Logger.getLogger(postMethod.getResponseBodyAsString());
		postMethod.releaseConnection();
	}
	
	@Test
	public void test2()
	{
		HttpClient httpClient=new HttpClient();
		PostMethod post=new PostMethod("http://localhost:8080/SSH/cmcc/sendClientRequest.do");
		JSONObject jsonObject=new JSONObject();
		jsonObject.put("id", "1001");
		jsonObject.put("name", "janvinal");
		
	}
}

Struts2：在Action类中获得HttpServletResponse，HttpServletRequest对象的四种方法

在struts1.xAction类的execute方法中，有四个参数，其中两个就是response和request。而在Struts2中，并没有任何参数，因此，就不能简单地从execute方法获得HttpServletResponse或HttpServletRequest对象了。

    但在Struts2 Action类中仍然有很多方法可以获得这些对象。下面就列出四种获得这些对象的方法。

【方法1】使用Struts2 Aware拦截器

 

    这种方法需要Action类实现相应的拦截器接口。如我们要获得HttpServletResponse对象，需要实现org.apache.struts2.interceptor.ServletResponseAware接口，代码如下：

package  action;

import  com.opensymphony.xwork2.ActionSupport;
import  javax.servlet.http. * ;
import  org.apache.struts2.interceptor. * ;

public   class  MyAction  extends  ActionSupport  implements  ServletResponseAware
{
     private  javax.servlet.http.HttpServletResponse response;
     //  获得HttpServletResponse对象
     public   void  setServletResponse(HttpServletResponse response)
    {
         this .response  =  response;
    }    
     public  String execute()  throws  Exception
    {    
        response.getWriter().write( " 实现ServletResponseAware接口 " );
    }
}

在上面的代码中，MyAction实现了一个ServletResponseAware接口，并且实现了setServletResponse方法。如果一个动作类实现了ServletResponseAware接口，Struts2在调用execute方法之前，就会先调用setServletResponse方法，并将response参数传入这个方法。如果想获得HttpServletRequest、HttpSession和Cookie等对象，动作类可以分别实现ServletRequestAware、SessionAware和CookiesAware等接口。这些接口都在org.apache.struts2.interceptor包中。

如果要获得请求参数，动作类可以实现org.apache.struts2.interceptor.ParameterAware接口，但如果只想判断某个参数是否存在，也可以实现com.opensymphony.xwork2.interceptor. ParameterNameAware接口。这个接口有一个acceptableParameterName方法，当Struts2获得一个请求参数时，就会调用一次。读者可以在这个方法中将所有的请求参数记录下来，以便以后使用。这个方法的定义如下：

boolean acceptableParameterName(String parameterName);

【方法2】使用RequestAware拦截器

    这种方法和第1种方法类似。动作类需要实现一个org.apache.struts2.interceptor.RequestAware接口。所不同的是RequestAware将获得一个com.opensymphony.xwork2.util.OgnlValueStack对象，这个对象可以获得response、request及其他的一些信息。代码如下所示：

package  action;

import  java.util.Map;
import  org.apache.struts2. * ;
import  com.opensymphony.xwork2.ActionSupport;
import  javax.servlet.http. * ;
import  com.opensymphony.xwork2.util. * ;
import  org.apache.struts2.interceptor. * ;

public   class  FirstAction  extends  ActionSupport  implements  RequestAware
{
     private  Map request;
private  HttpServletResponse response;
    
     public   void  setRequest(Map request)
    {
         this .request  =  request;        
    }    
     public  String execute()  throws  Exception
    {    
        java.util.Set < String >  keys  =  request.keySet();
         //  枚举所有的key值。实际上只有一个key：struts.valueStack
         for (String key: keys)
            System.out.println(key);
         //  获得OgnlValueStack 对象
        OgnlValueStack stack  =  (OgnlValueStack)request.get( " struts.valueStack " );
         //  获得HttpServletResponse对象
        response  = (HttpServletResponse)stack.getContext().get(StrutsStatics.HTTP_RESPONSE);
        response.getWriter().write( " 实现RequestAware 接口 " );
    }
}

    我们也可以使用StrutsStatics.HTTP_REQUEST、StrutsStatics.PAGE_CONTEXT来获得HttpServletRequest和PageContext对象。这种方法有些麻烦，一般很少用，读者可以作为一个参考。

【方法3】使用ActionContext类

    这种方法比较简单，我们可以通过 org.apache.struts2.ActionContext 类的 get 方法获得相应的对象。代码如下：

    HttpServletResponse response= (HttpServletResponse)

ActionContext.getContext().get(org.apache.struts2.StrutsStatics.HTTP_RESPONSE);

HttpServletRequest request = (HttpServletRequest)

ActionContext.getContext().get(org.apache.struts2.StrutsStatics.HTTP_REQUEST);

【方法4】使用ServletActionContext类

    Struts2为我们提供了一种最简单的方法获得HttpServletResponse及其他对象。这就是org.apache.struts2.ServletActionContext类。我们可以直接使用ServletActionContext类的getRequest、getResponse方法来获得HttpServletRequest、HttpServletResponse对象。代码如下：

    HttpServletResponse response = ServletActionContext.getResponse()

   response.getWriter().write("hello world");

    从这四种方法来看，最后一种是最简单的，读者可以根据自己的需要和要求来选择使用哪一种方法来获得这些对象。

Struts2返回JSON数据

早在我刚学Struts2之初的时候，就想写一篇文章来阐述Struts2如何返回JSON数据的原理和具体应用了，但苦于一直忙于工作难以抽身，渐渐的也淡忘了此事。直到前两天有同事在工作中遇到这个问题，来找我询问，我又细细地给他讲了一遍之后，才觉得无论如何要抽一个小时的时间来写这篇文章，从头到尾将Struts2与JSON的关系说清楚。

 

其实网络中，关于这个问题的答案已是海量，我当初也是从这海量的答案中吸收精华，才将“Struts2返回JSON数据”这个问题搞清楚的。但是这些海量的答案，有一个共同的缺陷，就是作者们只关注问题核心，即“如何在具体的Struts2应用中返回JSON数据到客户端”如何实现，而对于"为何要这样实现"以及实现的本质却解释的不甚了了，在笔者看来这只是“授人以鱼”而非笔者所推崇的“授人以鱼的同时，授人以渔”。在这篇文章中，笔者将总结前辈们的经验，并结合自己的理解，来从理论到实践由浅入深的说明“Struts2返回JSON数据”这一问题。

 

JSON(JavaScript Object Notation)

 

首先来看一下JSON官方对于“JSON”的解释：

JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。易于人阅读和编写。同时也易于机器解析和生成。它基于JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999的一个子集。 JSON采用完全独立于语言的文本格式，但是也使用了类似于C语言家族的习惯（包括C, C++, C#, Java, JavaScript, Perl, Python等）。这些特性使JSON成为理想的数据交换语言。(更多内容请参见JSON官网http://json.org/json-zh.html)


JSON建构于两种结构：

“名称/值”对的集合（A collection of name/value pairs）。不同的语言中，它被理解为对象（object），纪录（record），结构（struct），字典（dictionary），哈希表（hash table），有键列表（keyed list），或者关联数组 （associative array）。


值的有序列表（An ordered list of values）。在大部分语言中，它被理解为数组（array）。

因为JSON中的值（value）可以是双引号括起来的字符串（string）、数值(number)、true、false、 null、对象（object）或者数组（array），且这些结构可以嵌套，这种特性给予JSON表达数据以无限的可能：它既可以表达一个简单的key/value，也可以表达一个复杂的Map或List，而且它是易于阅读和理解的。

 

 

Struts2中JSON的用武之地


因为JSON是脱离语言的理想的数据交换格式，所以它被频繁的应用在客户端与服务器的通信过程中，这一点是毋庸置疑的。而在客户端与服务器的通信过程中，JSON数据的传递又被分为服务器向客户端传送JSON数据，和客户端向服务器传送JSON数据，前者的核心过程中将对象转换成JSON，而后者的核心是将JSON转换成对象，这是本质的区别。另外，值得一提的是，JSON数据在传递过程中，其实就是传递一个普通的符合JSON语法格式的字符串而已，所谓的“JSON对象”是指对这个JSON字符串解析和包装后的结果，这一点请牢记，因为下面的内容会依赖这一点。

 

Struts2返回JSON数据到客户端


这是最常见的需求，在AJAX大行其道的今天，向服务器请求JSON数据已成为每一个WEB应用必备的功能。抛开Struts2暂且不提，在常规WEB应用中由服务器返回JSON数据到客户端有两种方式：一是在Servlet中输出JSON串，二是在JSP页面中输出JSON串。上文提到，服务器像客户端返回JSON数据，其实就是返回一个符合JSON语法规范的字符串，所以在上述两种 方法中存在一个共同点，就是将需要返回的数据包装称符合JSON语法规范的字符串后在页面中显示。如下所示

 

使用Servlet返回JSON数据到客户端：

 
Java代码  收藏代码

    package cn.ysh.studio.struts2.json.demo.servlet;  
      
    import java.io.IOException;  
    import java.io.PrintWriter;  
      
    import javax.servlet.ServletException;  
    import javax.servlet.http.HttpServlet;  
    import javax.servlet.http.HttpServletRequest;  
    import javax.servlet.http.HttpServletResponse;  
      
    import net.sf.json.JSONObject;  
      
    import cn.ysh.studio.struts2.json.demo.bean.User;  
      
    public class JSON extends HttpServlet {  
      
        /** 
         *  
         */  
        private static final long serialVersionUID = 1L;  
      
        /** 
         * The doGet method of the servlet. <br> 
         * 
         * This method is called when a form has its tag value method equals to get. 
         *  
         * @param request the request send by the client to the server 
         * @param response the response send by the server to the client 
         * @throws ServletException if an error occurred 
         * @throws IOException if an error occurred 
         */  
        public void doGet(HttpServletRequest request, HttpServletResponse response)  
                throws ServletException, IOException {  
      
            response.setContentType("text/html");  
            PrintWriter out = response.getWriter();  
            //将要被返回到客户端的对象  
            User user=new User();  
            user.setId("123");  
            user.setName("JSONServlet");  
            user.setPassword("JSON");  
            user.setSay("Hello , i am a servlet !");  
            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\":\"JSONServlet\",\"say\":\"Hello , i am a servlet !\",\"password\":\"JSON\"},\"success\":true}";  
    //      out.println(jsonString);  
            out.flush();  
            out.close();  
        }  
      
        /** 
         * The doPost method of the servlet. <br> 
         * 
         * This method is called when a form has its tag value method equals to post. 
         *  
         * @param request the request send by the client to the server 
         * @param response the response send by the server to the client 
         * @throws ServletException if an error occurred 
         * @throws IOException if an error occurred 
         */  
        public void doPost(HttpServletRequest request, HttpServletResponse response)  
                throws ServletException, IOException {  
            doGet(request, response);  
        }  
      
    }  

 

结果在意料之中，如下图所示:

 

 

 

 

使用JSP（或html等）返回JSON数据到客户端：

 
Java代码  收藏代码

    <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>  
    {"user":{"id":"123","name":"JSONJSP","say":"Hello , i am a JSP !","password":"JSON"},"success":true}  

 

这个就不用去看结果了吧。

 

再回到Struts，在Struts的MVC模型中，Action替代Servlet担当了Model的角色，所以对于Struts而言，返回JSON数据到客户端，跟传统的WEB应用一样，存在两种方式，即在Action中输出JSON数据，和在视图资源中输出JSON数据。再往下细分的话，在Action中输出JSON数据又分为两种方式，一是使用传统方式输出自己包装后的JSON数据，二是使用Struts自带的JSON数据封装功能来自动包装并返回JSON数据。

 

在视图资源中输出JSON数据


Action处理完用户请求后，将数据存放在某一位置，如request中，并返回视图，然后Struts将跳转至该视图资源，在该视图中，我们需要做的是将数据从存放位置中取出，然后将其转换为JSON字符串，输出在视图中。这跟传统WEB应用中在JSP页面输出JSON数据的做法如出一辙:

 
Java代码  收藏代码

    public String testByJSP() {  
            User user = new User();  
            user.setId("123");  
            user.setName("Struts2");  
            user.setPassword("123");  
            user.setSay("Hello world !");  
            JSONObject jsonObject=new JSONObject();  
            jsonObject.accumulate("user", user);  
            //这里在request对象中放了一个data，所以struts的result配置中不能有type="redirect"  
            ServletActionContext.getRequest().setAttribute("data", jsonObject.toString());  
            return SUCCESS;  
        };  

 

因为是常规的Struts流程配置，所以配置内容就不再展示了。

 

JSP代码就非常简单了,

 
Java代码  收藏代码

    <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>  
    ${data }  

 

结果如图所示:

 

 

 

 

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


这一点跟传统的Servlet的处理方式基本上一模一样，代码如下

 
Java代码  收藏代码

    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中的配置:

 
Java代码  收藏代码

    <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会帮我们做的更好。

 
Java代码  收藏代码

    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的配置:

 
Java代码  收藏代码

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

 

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

 

结果如下图所示:

 

 

 

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


1、将对象转换成符合JSON语法格式的字符串；
2、将符合JSON语法格式的字符串返回客户端；


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

 
Java代码  收藏代码

    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数据到客户端的原理，做起来就游刃有余了，他甚至有非常多的可选方案，但既然是基于Struts2的实现，那么肯定还是要用Struts2的方式来做啦，因为这样确实可以省很多事。另外，在文章的最后，说明一下返回JSON数据时在result中配置的参数的含义及其常见常见配置吧：

 
Java代码  收藏代码

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

 

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

 

下面是整个Action的完整代码:

 
Java代码  收藏代码

    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代码  收藏代码

    <?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">  
                    <!-- 这里指定将被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>  
            </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>