JSON和JSONP
JSONP和JSON好像啊,他們之間有什麼聯絡嗎?
JSON(JavaScript Object Notation) 是一種輕量級的資料交換格式。對於JSON大家應該是很瞭解了吧,不是很清楚的朋友可以去json.org上瞭解下,簡單易懂。
JSONP是JSON with Padding的略稱。它是一個非官方的協議,它允許在伺服器端整合Script tags返回至用戶端,通過javascript callback的形式實現跨域訪問(這僅僅是JSONP簡單的實現形式)。
JSONP就像是JSON+Padding一樣(Padding這裡我們理解為填充), 我們先看下面的小例子然後再詳細介紹。
同源策略
為什麼會出這樣的錯誤呢?這是因為所有支援Javascript的瀏覽器都會使用同源策略這個安全性原則。看看百度的解釋:
同源策略,它是由Netscape提出的一個著名的安全性原則。現在所有支援JavaScript 的瀏覽器都會使用這個策略。所謂同源是指,網域名稱,協議,連接埠相同。當一個瀏覽器的兩個tab頁中分別開啟來 百度和Google的頁面當一個百度瀏覽器執行一個指令碼的時候會檢查這個指令碼是屬於哪個頁面的,即檢查是否同源,只有和百度同源的指令碼才會被執行。
這就是引起為何取不到資料的原因了,那如何才能解決跨域的問題呢?沒錯,我們現在可以進入正題,來瞭解下什麼是JSONP了。
跨域的簡單原理
光看定義還不是很明白,那首先我們先來手動做個簡單易懂的小測試。建立一個asp.net的web程式,添加sample.html網頁和一個test.js檔案,代碼如下:
sample.html的代碼:
<!DOCTYPE html PUBLIC "-//WC//DTD XHTML . Transitional//EN" "http://www.w.org/TR/xhtml/DTD/xhtml-transitional.dtd"> <html xmlns="http://www.w.org//xhtml" > <head> <title>test</title> <script type="text/javascript" src="test.js"></script> </head> <body> </body> </html>
test.js的代碼:
開啟sample.html後會跳出"success”這樣的這樣的資訊框,這似乎並不能說明什麼, 跨域問題到底怎麼解決呢?好,現在我們類比下非同源的環境,剛才我們不是已經用Visual Studio建立了一個Web程式嗎(這裡我們叫A程式),現在我們再開啟一個新的Visual Studio再建立一個Web程式(B程式),將我們的之前的test.js檔案從A程式中移除然後拷貝到B程式中。兩個程式都運行起來後,Visual Studio會啟動內建伺服器,假設A程式是localhost:20001,B程式是localhost:20002,這就類比了一個非同源的環境了(雖然網域名稱相同但連接埠號碼不同,所以是非同源的)。
OK,我們接下來應該改下sample.html裡的代碼,因為test.js檔案在B程式上了,url也就變成了localhost:20002。
sample.html部分代碼:
<script type="text/javascript" src="http://localhost:20002/test.js"></script>
請保持AB兩個Web程式的運行狀態,當你再次重新整理localhost:20001/sample.html的時候,和原來一樣跳出了"success"的對話方塊,是的,成功訪問到了非同源的localhost:20002/test.js這個所謂的遠程服務了。到了這一步,相信大家應該已經大概明白如何跨域訪問了的原理了。
<script>標籤的src屬性並不被同源策略所約束,所以可以擷取任何伺服器上指令碼並執行。
JSONP的實現模式--CallBack
剛才的小例子講解了跨域的原理,我們回上去再看看JSONP的定義說明中講到了javascript callback的形式。那我們就來修改下代碼,如何?JSONP的javascript callback的形式。
程式A中sample的部分代碼:
<script type="text/javascript"> //回呼函數 function callback(data) { alert(data.message); } </script> <script type="text/javascript" src="http://localhost:20002/test.js"></script>
程式B中test.js的代碼:
//調用callback函數,並以json資料形式作為闡述傳遞,完成回調
callback({message:"success"});
這其實就是JSONP的簡單實現模式,或者說是JSONP的原型:建立一個回呼函數,然後在遠程服務上調用這個函數並且將JSON 資料形式作為參數傳遞,完成回調。
將JSON資料填充進回呼函數,這就是JSONP的JSON+Padding的含義吧。
一般情況下,我們希望這個script標籤能夠動態調用,而不是像上面因為固定在html裡面所以沒等頁面顯示就執行了,很不靈活。我們可以通過javascript動態建立script標籤,這樣我們就可以靈活調用遠程服務了。
程式A中sample的部分代碼:
<script type="text/javascript"> function callback(data) { alert(data.message); } //添加<script>標籤的方法 function addScriptTag(src){ var script = document.createElement('script'); script.setAttribute("type","text/javascript"); script.src = src; document.body.appendChild(script); } window.onload = function(){ addScriptTag("http://localhost:/test.js"); } </script>
程式B的test.js代碼不變,我們再執行下程式,是不是和原來的一樣呢。如果我們再想調用一個遠程服務的話,只要添加addScriptTag方法,傳入遠程服務的src值就可以了。這裡說明下為什麼要將addScriptTag方法放入到window.onload的方法裡,原因是addScriptTag方法中有句document.body.appendChild(script);,這個script標籤是被添加到body裡的,由於我們寫的javascript代碼是在head標籤中,document.body還沒有初始化完畢呢,所以我們要通過window.onload方法先初始化頁面,這樣才不會出錯。
上面的例子是最簡單的JSONP的實現模型,不過它還算不上一個真正的JSONP服務。我們來看一下真正的JSONP服務是怎麼樣的,比如Google的ajax搜尋介面:http://ajax.googleapis.com/ajax/services/search/web?v=1.0&q=?&callback=?
q=?這個問號是表示你要搜尋的內容,最重要的是第二個callback=?這個是正如其名表示回呼函數的名稱,也就是將你自己在用戶端定義的回呼函數的函數名傳送給服務端,服務端則會返回以你定義的回呼函數名的方法,將擷取的json資料傳入這個方法完成回調。有點羅嗦了,還是看看實現代碼吧:
<script type="text/javascript"> //添加<script>標籤的方法 function addScriptTag(src){ var script = document.createElement('script'); script.setAttribute("type","text/javascript"); script.src = src; document.body.appendChild(script); } window.onload = function(){ //搜尋apple,將自訂的回呼函數名result傳入callback參數中 addScriptTag("http://ajax.googleapis.com/ajax/services/search/web?v=.&q=apple&callback=result"); } //自訂的回呼函數result function result(data) { //我們就簡單的擷取apple搜尋結果的第一條記錄中url資料 alert(data.responseData.results[].unescapedUrl); } </script>
像這樣的JSONP服務還有很多(以下資訊來自使用 JSONP 實現跨域通訊,第 1 部分: 結合 JSONP 和 jQuery 快速構建強大的 mashup):
Digg API:來自 Digg 的頭條新聞:
http://services.digg.com/stories/top?appkey=http%3A%2F%2Fmashup.com&type=javascript&callback=?
Geonames API:郵編的位置資訊:
http://www.geonames.org/postalCodeLookupJSON?postalcode=10504&country=US&callback=?
Flickr JSONP API:載入最新貓的圖片:
http://api.flickr.com/services/feeds/photos_public.gne?tags=cat&tagmode=any&format=json&jsoncallback=?
Yahoo Local Search API:在郵編為 10504 的地區搜尋比薩:
http://local.yahooapis.com/LocalSearchService/V3/localSearch?appid=YahooDemo&query=pizza&zip=10504&results=2&output=json&callback=?
接下來我們自己來建立一個簡單的遠程服務,實現和上面一樣的JSONP服務。還是利用Web程式A和程式B來做示範,這次我們在程式B上建立一個MyService.ashx檔案。
程式B的MyService.ashx代碼:
public class MyService : IHttpHandler { public void ProcessRequest(HttpContext context) { //擷取回呼函數名 string callback = context.Request.QueryString["callback"]; //json資料 string json = "{\"name\":\"chopper\",\"sex\":\"man\"}"; context.Response.ContentType = "application/json"; //輸出:回呼函數名(json資料) context.Response.Write(callback + "(" + json + ")"); } public bool IsReusable { get { return false; } } }
程式A的sample代碼中的調用:
<script type="text/javascript"> function addScriptTag(src){ var script = document.createElement('script'); script.setAttribute("type","text/javascript"); script.src = src; document.body.appendChild(script); } window.onload = function(){ //調用遠程服務 addScriptTag("http://localhost:/MyService.ashx?callback=person"); } //回呼函數person function person(data) { alert(data.name + " is a " + data.sex); } </script>
這就完成了一個最基本的JSONP服務調用了,是不是很簡單,下面我們來瞭解下JQuery是如何調用JSONP的。
jQuery對JSONP的實現
jQuery架構也當然支援JSONP,可以使用$.getJSON(url,[data],[callback])方法(詳細可以參考http://api.jquery.com/jQuery.getJSON/)。那我們就來修改下程式A的代碼,改用jQuery的getJSON方法來實現(下面的例子沒用用到向服務傳參,所以唯寫了getJSON(url,[callback])):
<script type="text/javascript" src="http://code.jquery.com/jquery-latest.js"></script> <script type="text/javascript"> $.getJSON("http://localhost:20002/MyService.ashx?callback=?",function(data){ alert(data.name + " is a a" + data.sex); }); </script>
結果是一樣的,要注意的是在url的後面必須添加一個callback參數,這樣getJSON方法才會知道是用JSONP方式去訪問服務,callback後面的那個問號是內部自動產生的一個回呼函數名。這個函數名大家可以debug一下看看,比如jQuery17207481773362960666_1332575486681。
當然,加入說我們想指定自己的回呼函數名,或者說服務上規定了固定回呼函數名該怎麼辦呢?我們可以使用$.ajax方法來實現(參數較多,詳細可以參考http://api.jquery.com/jQuery.ajax)。先來看看如何?吧:
<script type="text/javascript" src="http://code.jquery.com/jquery-latest.js"></script> <script type="text/javascript"> $.ajax({ url:"http://localhost:20002/MyService.ashx?callback=?", dataType:"jsonp", jsonpCallback:"person", success:function(data){ alert(data.name + " is a a" + data.sex); } }); </script>
沒錯,jsonpCallback就是可以指定我們自己的回調方法名person,遠程服務接受callback參數的值就不再是自動產生的回調名,而是person。dataType是指定按照JSOPN方式訪問遠程服務。
利用jQuery可以很方便的實現JSONP來進行跨域訪問。先暫時寫到這吧。後續還有更新,請持續關注,謝謝。