淺析JSONP之解決ajax跨域問題

JSON和JSONP

　　JSONP和JSON好像啊，他們之間有什么聯(lián)系嗎？

　　JSON(JavaScript Object Notation) 是一種輕量級的數(shù)據(jù)交換格式。對于JSON大家應(yīng)該是很了解了吧，不是很清楚的朋友可以去json.org上了解下，簡單易懂。

　　JSONP是JSON with Padding的略稱。它是一個非官方的協(xié)議，它允許在服務(wù)器端集成Script tags返回至客戶端，通過javascript callback的形式實現(xiàn)跨域訪問（這僅僅是JSONP簡單的實現(xiàn)形式）。

　　JSONP就像是JSON+Padding一樣(Padding這里我們理解為填充)， 我們先看下面的小例子然后再詳細介紹。

同源策略

　　為什么會出這樣的錯誤呢？這是因為所有支持Javascript的瀏覽器都會使用同源策略這個安全策略。看看百度的解釋：

　　同源策略，它是由Netscape提出的一個著名的安全策略?，F(xiàn)在所有支持JavaScript 的瀏覽器都會使用這個策略。所謂同源是指，域名，協(xié)議，端口相同。當(dāng)一個瀏覽器的兩個tab頁中分別打開來 百度和谷歌的頁面當(dāng)一個百度瀏覽器執(zhí)行一個腳本的時候會檢查這個腳本是屬于哪個頁面的，即檢查是否同源，只有和百度同源的腳本才會被執(zhí)行。

　　這就是引起為何取不到數(shù)據(jù)的原因了，那如何才能解決跨域的問題呢？沒錯，我們現(xiàn)在可以進入正題，來了解下什么是JSONP了。

跨域的簡單原理

　　光看定義還不是很明白，那首先我們先來手動做個簡單易懂的小測試。新建一個asp.net的web程序，添加sample.html網(wǎng)頁和一個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的代碼：

alert("success");

　　打開sample.html后會跳出"success”這樣的這樣的信息框，這似乎并不能說明什么， 跨域問題到底怎么解決呢？好，現(xiàn)在我們模擬下非同源的環(huán)境，剛才我們不是已經(jīng)用Visual Studio新建了一個Web程序嗎(這里我們叫A程序)，現(xiàn)在我們再打開一個新的Visual Studio再新建一個Web程序(B程序)，將我們的之前的test.js文件從A程序中移除然后拷貝到B程序中。兩個程序都運行起來后，Visual Studio會啟動內(nèi)置服務(wù)器，假設(shè)A程序是localhost:20001,B程序是localhost:20002，這就模擬了一個非同源的環(huán)境了(雖然域名相同但端口號不同，所以是非同源的)。

　　OK，我們接下來應(yīng)該改下sample.html里的代碼，因為test.js文件在B程序上了，url也就變成了localhost:20002。

sample.html部分代碼：

script type="text/javascript" src="http://localhost:20002/test.js">/script>

　　請保持AB兩個Web程序的運行狀態(tài)，當(dāng)你再次刷新localhost:20001/sample.html的時候，和原來一樣跳出了"success"的對話框，是的，成功訪問到了非同源的localhost:20002/test.js這個所謂的遠程服務(wù)了。到了這一步，相信大家應(yīng)該已經(jīng)大概明白如何跨域訪問了的原理了。

　　script>標(biāo)簽的src屬性并不被同源策略所約束，所以可以獲取任何服務(wù)器上腳本并執(zhí)行。

JSONP的實現(xiàn)模式--CallBack

　　剛才的小例子講解了跨域的原理，我們回上去再看看JSONP的定義說明中講到了javascript callback的形式。那我們就來修改下代碼，如何實現(xiàn)JSONP的javascript callback的形式。

程序A中sample的部分代碼：

 script type="text/javascript">
 //回調(diào)函數(shù)
 function callback(data) { 
   alert(data.message); 
 } 
 /script> 
 script type="text/javascript" src="http://localhost:20002/test.js">/script>

程序B中test.js的代碼：

//調(diào)用callback函數(shù)，并以json數(shù)據(jù)形式作為闡述傳遞，完成回調(diào)

callback({message:"success"}); 

　　這其實就是JSONP的簡單實現(xiàn)模式，或者說是JSONP的原型：創(chuàng)建一個回調(diào)函數(shù)，然后在遠程服務(wù)上調(diào)用這個函數(shù)并且將JSON 數(shù)據(jù)形式作為參數(shù)傳遞，完成回調(diào)。

　　將JSON數(shù)據(jù)填充進回調(diào)函數(shù)，這就是JSONP的JSON+Padding的含義吧。

　　一般情況下，我們希望這個script標(biāo)簽?zāi)軌騽討B(tài)的調(diào)用，而不是像上面因為固定在html里面所以沒等頁面顯示就執(zhí)行了，很不靈活。我們可以通過javascript動態(tài)的創(chuàng)建script標(biāo)簽，這樣我們就可以靈活調(diào)用遠程服務(wù)了。

程序A中sample的部分代碼：

 script type="text/javascript"> 
   function callback(data) { 
     alert(data.message); 
   } 
   //添加script>標(biāo)簽的方法 
   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代碼不變，我們再執(zhí)行下程序，是不是和原來的一樣呢。如果我們再想調(diào)用一個遠程服務(wù)的話，只要添加addScriptTag方法，傳入遠程服務(wù)的src值就可以了。這里說明下為什么要將addScriptTag方法放入到window.onload的方法里，原因是addScriptTag方法中有句document.body.appendChild(script);，這個script標(biāo)簽是被添加到body里的，由于我們寫的javascript代碼是在head標(biāo)簽中，document.body還沒有初始化完畢呢，所以我們要通過window.onload方法先初始化頁面，這樣才不會出錯。

　　上面的例子是最簡單的JSONP的實現(xiàn)模型，不過它還算不上一個真正的JSONP服務(wù)。我們來看一下真正的JSONP服務(wù)是怎么樣的，比如Google的ajax搜索接口：http://ajax.googleapis.com/ajax/services/search/web?v=1.0q=?callback=?

　　q=?這個問號是表示你要搜索的內(nèi)容，最重要的是第二個callback=?這個是正如其名表示回調(diào)函數(shù)的名稱，也就是將你自己在客戶端定義的回調(diào)函數(shù)的函數(shù)名傳送給服務(wù)端，服務(wù)端則會返回以你定義的回調(diào)函數(shù)名的方法，將獲取的json數(shù)據(jù)傳入這個方法完成回調(diào)。有點羅嗦了，還是看看實現(xiàn)代碼吧：

 script type="text/javascript"> 
   //添加script>標(biāo)簽的方法 
   function addScriptTag(src){
     var script = document.createElement('script');
     script.setAttribute("type","text/javascript");
     script.src = src;
     document.body.appendChild(script);
   }
   window.onload = function(){
     //搜索apple，將自定義的回調(diào)函數(shù)名result傳入callback參數(shù)中
     addScriptTag("http://ajax.googleapis.com/ajax/services/search/web?v=.q=applecallback=result");
   }
   //自定義的回調(diào)函數(shù)result
   function result(data) {
     //我們就簡單的獲取apple搜索結(jié)果的第一條記錄中url數(shù)據(jù)
     alert(data.responseData.results[].unescapedUrl);
   }
 /script>

像這樣的JSONP服務(wù)還有很多(以下信息來自使用 JSONP 實現(xiàn)跨域通信，第 1 部分: 結(jié)合 JSONP 和 jQuery 快速構(gòu)建強大的 mashup)：

Digg API：來自 Digg 的頭條新聞：

　　http://services.digg.com/stories/top?appkey=http%3A%2F%2Fmashup.comtype=javascriptcallback=?

Geonames API：郵編的位置信息：

　　http://www.geonames.org/postalCodeLookupJSON?postalcode=10504country=UScallback=?

Flickr JSONP API：載入最新貓的圖片：

　　http://api.flickr.com/services/feeds/photos_public.gne?tags=cattagmode=anyformat=jsonjsoncallback=?

Yahoo Local Search API：在郵編為 10504 的地區(qū)搜索比薩：

　　http://local.yahooapis.com/LocalSearchService/V3/localSearch?appid=YahooDemoquery=pizzazip=10504results=2output=jsoncallback=?

　　接下來我們自己來創(chuàng)建一個簡單的遠程服務(wù)，實現(xiàn)和上面一樣的JSONP服務(wù)。還是利用Web程序A和程序B來做演示，這次我們在程序B上創(chuàng)建一個MyService.ashx文件。

程序B的MyService.ashx代碼：

 public class MyService : IHttpHandler 
   { 
     public void ProcessRequest(HttpContext context) 
     { 
       //獲取回調(diào)函數(shù)名 
       string callback = context.Request.QueryString["callback"]; 
       //json數(shù)據(jù) 
       string json = "{\"name\":\"chopper\",\"sex\":\"man\"}"; 
 
       context.Response.ContentType = "application/json"; 
       //輸出：回調(diào)函數(shù)名(json數(shù)據(jù))
       context.Response.Write(callback + "(" + json + ")");
     } 
 
     public bool IsReusable 
     { 
       get 
       { 
         return false; 
       } 
     } 
   }

程序A的sample代碼中的調(diào)用：

 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(){
     //調(diào)用遠程服務(wù)     addScriptTag("http://localhost:/MyService.ashx?callback=person");
   }
   //回調(diào)函數(shù)person   function person(data) {
     alert(data.name + " is a " + data.sex);
   }
 /script>　　

　　這就完成了一個最基本的JSONP服務(wù)調(diào)用了，是不是很簡單，下面我們來了解下JQuery是如何調(diào)用JSONP的。

jQuery對JSONP的實現(xiàn)

　　jQuery框架也當(dāng)然支持JSONP，可以使用$.getJSON(url,[data],[callback])方法(詳細可以參考http://api.jquery.com/jQuery.getJSON/)。那我們就來修改下程序A的代碼，改用jQuery的getJSON方法來實現(xiàn)(下面的例子沒用用到向服務(wù)傳參，所以只寫了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>

　　結(jié)果是一樣的，要注意的是在url的后面必須添加一個callback參數(shù)，這樣getJSON方法才會知道是用JSONP方式去訪問服務(wù)，callback后面的那個問號是內(nèi)部自動生成的一個回調(diào)函數(shù)名。這個函數(shù)名大家可以debug一下看看，比如jQuery17207481773362960666_1332575486681。

　　當(dāng)然，加入說我們想指定自己的回調(diào)函數(shù)名，或者說服務(wù)上規(guī)定了固定回調(diào)函數(shù)名該怎么辦呢？我們可以使用$.ajax方法來實現(xiàn)(參數(shù)較多，詳細可以參考http://api.jquery.com/jQuery.ajax)。先來看看如何實現(xiàn)吧：

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就是可以指定我們自己的回調(diào)方法名person，遠程服務(wù)接受callback參數(shù)的值就不再是自動生成的回調(diào)名，而是person。dataType是指定按照JSOPN方式訪問遠程服務(wù)。

利用jQuery可以很方便的實現(xiàn)JSONP來進行跨域訪問。先暫時寫到這吧。后續(xù)還有更新，請持續(xù)關(guān)注，謝謝。