很多開發人員在使用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) | 可選。規定當請求成功時運行的函數。 額外的參數:
|
該函數是簡寫的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