jquery的ajax和getJson跨域获取json数据

很多开发人员在使用jquery在前端和服务器端进行数据交互，所以很容易会认为在前端利用jquery就可以读取任何站点的数据了。近日在进行开发时，因为要和第三方公司的一个项目进行数据的共享，因为考虑多不占用服务器的资源，遂决定直接在html进行数据的读取，不走服务器端进行中转了。然后正好就遇到了浏览器端跨域访问的问题。

跨域的安全限制都是指浏览器端来说的，服务器端不存在跨域安全限制的问题。

目前浏览器端跨域访问常用的两种方法有两种：

1、通过jQuery的ajax进行跨域，这其实是采用的jsonp的方式来实现的。

jsonp是英文json with padding的缩写。它允许在服务器端生成script tags至返回至客户端，也就是动态生成javascript标签，通过javascript callback的形式实现数据读取。

html页面端示例代码：

01	//首先要引入jquery的js包

02	jQuery(document).ready( function (){

03

$.ajax({

04	type :  "get" ,  //jquey是不支持post方式跨域的

05	async: false ,

06	url :  "http://api.taobao.com/apitools/ajax_props.do" , //跨域请求的URL

07	dataType :  "jsonp" ,

08	//传递给请求处理程序，用以获得jsonp回调函数名的参数名(默认为:callback)

09	jsonp:  "jsoncallback" ,

10	//自定义的jsonp回调函数名称，默认为jQuery自动生成的随机函数名

11	jsonpCallback: "success_jsonpCallback" ,

12	//成功获取跨域服务器上的json数据后,会动态执行这个callback函数

13	success :  function (json){

14	alert(json);

15

}

16

});

17

});

服务器端示例代码，以java为例：

服务器端代码，是重点，开始以为，只要客户端通过jsonp就可以直接跨域访问，其实不然，需要服务器端的支持才行。

01	public   void   jsonpTest()  throws   IOException{

02	HttpServletRequest request = ServletActionContext.getRequest();

03	HttpServletResponse response = ServletActionContext.getResponse();

04	//根据html指定的jsonp回调函数的参数名，获取回调函数的名称

05	//callbackName的值其实就是：success_jsonpCallback

06	String callbackName = (String)request.getAttribute( "jsoncallback" );

07	//简单模拟一个json字符串，实际可使用google的gson进行转换，次数通过字符串拼接

08	//{"name":"张三","age":28}

09	//\是对"号进行转义

10	String jsonStr =  "{\"name\":\"张三\",\"age\":28}" ;

11	//最终返回的数据为：success_jsonpCallback({"name":"张三","age":28})

12	String renderStr = callbackName+ "(" +jsonStr+ ")" ;

13	response.setContentType( "text/plain;charset=UTF-8" );

14	response.getWriter().write(renderStr);

15

}

jsonp的原理：

首先在客户端注册一个callback (如:'jsoncallback'), 然后把callback的名字(如:success_jsonpCallback)传给服务器端对应的处理函数。

服务器先生成需要返回给客户端的 json 数据。然后以 javascript 语法的方式，生成一个function , function 名字就是传递上来的参数(jsoncallback)的值(success_jsonpCallback) 。

最后将 json 数据直接以入参的方式，放置到 function 中，这样就生成了一段 js 语法的文档，返回给客户端。

客户端浏览器，解析script标签，并将服务器端返回的数据，作为参数，

传入到了客户端预先定义好的 callback 函数(如上例中jquery $.ajax()方法封装的的success: function (json))里。

实际上跨域是通过动态增加script来加载数据，无法直接获得数据，所以需要使用回调函数。

2.使用jquery的getJson进行跨域读取数据

实际上getJson方式的根本原理和ajax使用jsonp的方式是一样的。

jquery中常用getJson来调用获取远程的数据，并通过json格式返回。函数的原型如下：

jQuery.getJSON(url,data,success(data,status,xhr))

参数	描述
url	必需。规定将请求发送的哪个 URL。
data	可选。规定连同请求发送到服务器的数据。
success(data,status,xhr)	可选。规定当请求成功时运行的函数。 额外的参数： response - 包含来自请求的结果数据 status - 包含请求的状态 xhr - 包含 XMLHttpRequest 对象

该函数是简写的ajax函数，实际上等价于：

$.ajax({
url: url,
data: data,
success: callback,
dataType: json
});

言归正传，下面我们来看如何使用getJson跨域获取数据。

html页面示例代码：

$.getJSON("http://api.taobao.com/apitools/ajax_props.do&jsoncallback=?",
   function (data) {
        alert(data);
    }
);

执行原理：

发送请求时需要传一个callback的回调函数名到服务器端，服务器端拿到这个回调函数名，再将返回数据用参数的形式反回到客户端，这样客户端就能够调到。

所以发送请求URL的地址后面一定要上jsoncallback=?这样的参数，jquery会将?号自动替换成自动生成的回调函数的名称。

所以最终的实际请求为：http://api.taobao.com/apitools/ajax_props.do&jsoncallback=jsonp1322444422697

所以和ajax的方式想比较，也就是callback函数一个是自动生成的函数名，一个是手工指定的函数名。

 

本文首发于度外网络官方博客，转载请注明出处：http://www.duwaiweb.com/blog/20120918_e51195f8-2261-48cf-a883-3013a576fa51.html