JSONP跨域詳解

0. 前言

說(shuō)到AJAX就會(huì)不可避免的面臨兩個(gè)問(wèn)題。

  • AJAX以何種格式來(lái)交換數(shù)據(jù)?
  • 第二個(gè)是跨域的需求如何解決?

這兩個(gè)問(wèn)題目前都有不同的解決方案,比如數(shù)據(jù)可以用自定義字符串或者用XML來(lái)描述,跨域可以通過(guò)服務(wù)器端代理來(lái)解決。
但到目前為止最被推崇或者說(shuō)首選的方案還是用JSON來(lái)傳數(shù)據(jù),靠JSONP來(lái)跨域。而這就是本文將要講述的內(nèi)容。
JSON和JSONP雖然只有一個(gè)字母的差別,但其實(shí)他們根本不是一回事兒:JSON是一種數(shù)據(jù)交換格式,而JSONP是一種依靠開(kāi)發(fā)人員的聰明才智創(chuàng)造出的一種非官方跨域數(shù)據(jù)交互協(xié)議。我們拿最近比較火的諜戰(zhàn)片來(lái)打個(gè)比方,JSON是地下黨們用來(lái)書(shū)寫(xiě)和交換情報(bào)的“暗號(hào)”,而JSONP則是把用暗號(hào)書(shū)寫(xiě)的情報(bào)傳遞給自己同志時(shí)使用的接頭方式。看到?jīng)]?一個(gè)是描述信息的格式,一個(gè)是信息傳遞雙方約定的方法。

1. 什么是JSON?

JSON是JavaScript Object Notation的縮寫(xiě),它是一種數(shù)據(jù)交換格式。在JSON中,一共就這么幾種數(shù)據(jù)類(lèi)型:

  • number
  • boolean
  • string
  • null
  • array
  • object

以及上面的任意組合。
并且,JSON還定死了字符集必須是UTF-8,表示多語(yǔ)言就沒(méi)有問(wèn)題了。
由于JSON非常簡(jiǎn)單,很快就風(fēng)靡Web世界,并且成為ECMA標(biāo)準(zhǔn)。幾乎所有編程語(yǔ)言都有解析JSON的庫(kù),而在JavaScript中,我們可以直接使用JSON,因?yàn)镴avaScript內(nèi)置了JSON的解析。

2. 什么是JSONP?

2.1 先說(shuō)說(shuō)JSONP是怎么產(chǎn)生的

  1. 一個(gè)眾所周知的問(wèn)題,AJAX直接請(qǐng)求普通文件存在跨域無(wú)權(quán)限訪問(wèn)的問(wèn)題,甭管你是靜態(tài)頁(yè)面、動(dòng)態(tài)網(wǎng)頁(yè)、web服務(wù)、WCF,只要是跨域請(qǐng)求,一律不準(zhǔn);

  2. 不過(guò)我們又發(fā)現(xiàn),Web頁(yè)面上調(diào)用js文件時(shí)則不受是否跨域的影響(不僅如此,我們還發(fā)現(xiàn)凡是擁有src這個(gè)屬性的標(biāo)簽都擁有跨域的能力,比如<script><img><iframe>);

  3. 于是可以判斷,當(dāng)前階段如果想通過(guò)純web端(ActiveX控件、服務(wù)端代理、Web socket等方式不算)跨域訪問(wèn)數(shù)據(jù)就只有一種可能,那就是在遠(yuǎn)程服務(wù)器上設(shè)法把數(shù)據(jù)裝進(jìn)js格式的文件里,供客戶(hù)端調(diào)用和進(jìn)一步處理;

  4. 恰巧我們已經(jīng)知道有一種叫做JSON的純字符數(shù)據(jù)格式可以簡(jiǎn)潔的描述復(fù)雜數(shù)據(jù),更妙的是JSON還被JS原生支持,所以在客戶(hù)端幾乎可以隨心所欲的處理這種格式的數(shù)據(jù);

  5. 這樣子解決方案就呼之欲出了,web客戶(hù)端通過(guò)與調(diào)用腳本一模一樣的方式,來(lái)調(diào)用跨域服務(wù)器上動(dòng)態(tài)生成的js格式文件(一般以JSON為后綴),顯而易見(jiàn),服務(wù)器之所以要?jiǎng)討B(tài)生成JSON文件,目的就在于把客戶(hù)端需要的數(shù)據(jù)裝入進(jìn)去。

  6. 客戶(hù)端在對(duì)JSON文件調(diào)用成功之后,也就獲得了自己所需的數(shù)據(jù),剩下的就是按照自己需求進(jìn)行處理和展現(xiàn)了,這種獲取遠(yuǎn)程數(shù)據(jù)的方式看起來(lái)非常像AJAX,但其實(shí)并不一樣。

  7. 為了便于客戶(hù)端使用數(shù)據(jù),逐漸形成了一種非正式傳輸協(xié)議,人們把它稱(chēng)作JSONP,該協(xié)議的一個(gè)要點(diǎn)就是允許用戶(hù)傳遞一個(gè)callback參數(shù)給服務(wù)端,然后服務(wù)端返回?cái)?shù)據(jù)時(shí)會(huì)將這個(gè)callback參數(shù)作為函數(shù)名來(lái)包裹住JSON數(shù)據(jù),這樣客戶(hù)端就可以隨意定制自己的函數(shù)來(lái)自動(dòng)處理返回?cái)?shù)據(jù)了

如果對(duì)于callback參數(shù)如何使用還有些模糊的話,我們后面會(huì)有具體的實(shí)例來(lái)講解。

2.2 JSONP的客戶(hù)端具體實(shí)現(xiàn)

不管jQuery也好,extjs也罷,又或者是其他支持JSONP的框架,他們幕后所做的工作都是一樣的,下面我來(lái)循序漸進(jìn)的說(shuō)明一下JSONP在客戶(hù)端的實(shí)現(xiàn)。
1)我們知道,哪怕跨域js文件中的代碼(當(dāng)然指符合web腳本安全策略的),web頁(yè)面也是可以無(wú)條件執(zhí)行的。
遠(yuǎn)程服務(wù)器remoteserver.com根目錄下有個(gè)remote.js文件代碼如下:

alert('我是遠(yuǎn)程文件');

本地服務(wù)器localserver.com下有個(gè)jsonp.html頁(yè)面代碼如下:

<!DOCTYPE html>
<html>
  <head>
    <title></title>
    <script type="text/javascript" src="http://remoteserver.com/remote.js"></script>
  </head>
  <body></body>
</html>

毫無(wú)疑問(wèn),頁(yè)面將會(huì)彈出一個(gè)提示窗體,顯示跨域調(diào)用成功。

2)現(xiàn)在我們?cè)?code>jsonp.html頁(yè)面定義一個(gè)函數(shù),然后在遠(yuǎn)程remote.js中傳入數(shù)據(jù)進(jìn)行調(diào)用。
jsonp.html頁(yè)面代碼如下:

<!DOCTYPE html>
<html>
  <head>
    <title></title>
    <script type="text/javascript">
      var localHandler = function(data){
          alert('我是本地函數(shù),可以被跨域的remote.js文件調(diào)用,遠(yuǎn)程js帶來(lái)的數(shù)據(jù)是:' + data.result);
      };
    </script>
    <script type="text/javascript" src="http://remoteserver.com/remote.js"></script>
  </head>
  <body></body>
</html>

remote.js文件代碼如下:

localHandler({
  "result":"我是遠(yuǎn)程js帶來(lái)的數(shù)據(jù)"
});

運(yùn)行之后查看結(jié)果,頁(yè)面成功彈出提示窗口,顯示本地函數(shù)被跨域的遠(yuǎn)程js調(diào)用成功,并且還接收到了遠(yuǎn)程js帶來(lái)的數(shù)據(jù)。很欣喜,跨域遠(yuǎn)程獲取數(shù)據(jù)的目的基本實(shí)現(xiàn)了,但是又一個(gè)問(wèn)題出現(xiàn)了,怎么讓遠(yuǎn)程js知道它應(yīng)該調(diào)用的本地函數(shù)叫什么名字呢?畢竟是JSONP的服務(wù)者都要面對(duì)很多服務(wù)對(duì)象,而這些服務(wù)對(duì)象各自的本地函數(shù)都不相同啊?我們接著往下看。

3)聰明的開(kāi)發(fā)者很容易想到,只要服務(wù)端提供的js腳本是動(dòng)態(tài)生成的就行了唄,這樣調(diào)用者可以傳一個(gè)參數(shù)過(guò)去告訴服務(wù)端“我想要一段調(diào)用XXX函數(shù)的js代碼,請(qǐng)你返回給我”,于是服務(wù)器就可以按照客戶(hù)端的需求來(lái)生成js腳本并響應(yīng)了。

jsonp.html頁(yè)面的代碼:

<!DOCTYPE html>
<html>
  <head>
    <title></title>
    <script type="text/javascript">
      // 得到航班信息查詢(xún)結(jié)果后的回調(diào)函數(shù)
      var flightHandler = function(data){
          alert('你查詢(xún)的航班結(jié)果是:票價(jià) ' + data.price + ' 元,' + '余票 ' + data.tickets + ' 張。');
      };
      // 提供jsonp服務(wù)的url地址(不管是什么類(lèi)型的地址,最終生成的返回值都是一段javascript代碼)
      var url = "http://flightQuery.com/jsonp/flightResult.aspx?code=CA1998&callback=flightHandler";
      // 創(chuàng)建script標(biāo)簽,設(shè)置其屬性
      var script = document.createElement('script');
      script.setAttribute('src', url);
      // 把script標(biāo)簽加入head,此時(shí)調(diào)用開(kāi)始
      document.getElementsByTagName('head')[0].appendChild(script); 
    </script>
  </head>
  <body></body>
</html>

這次的代碼變化比較大,不再直接把遠(yuǎn)程js文件寫(xiě)死,而是編碼實(shí)現(xiàn)動(dòng)態(tài)查詢(xún),而這也正是JSONP客戶(hù)端實(shí)現(xiàn)的核心部分,本例中的重點(diǎn)也就在于如何完成JSONP調(diào)用的全過(guò)程。
我們看到調(diào)用的url中傳遞了一個(gè)code參數(shù),告訴服務(wù)器我要查的是CA1998次航班的信息,而callback參數(shù)則告訴服務(wù)器,我的本地回調(diào)函數(shù)叫做flightHandler,所以請(qǐng)把查詢(xún)結(jié)果傳入這個(gè)函數(shù)中進(jìn)行調(diào)用。
OK,服務(wù)器很聰明,這個(gè)叫做flightResult.aspx的頁(yè)面生成了一段這樣的代碼提供給jsonp.html(服務(wù)端的實(shí)現(xiàn)這里就不演示了,與你選用的語(yǔ)言無(wú)關(guān),說(shuō)到底就是拼接字符串):

flightHandler({
  "code": "CA1998",
  "price": 1780,
  "tickets": 5
});

我們看到,傳遞給flightHandler函數(shù)的是一個(gè)json,它描述了航班的基本信息。運(yùn)行一下頁(yè)面,成功彈出提示窗口,JSONP的執(zhí)行全過(guò)程順利完成!

2.3 總結(jié)原生JS實(shí)現(xiàn)JSONP的步驟

2.3.1 客戶(hù)端
  1. 定義獲取數(shù)據(jù)后調(diào)用的回調(diào)函數(shù)
  2. 動(dòng)態(tài)生成對(duì)服務(wù)端JS進(jìn)行引用的代碼
    • 設(shè)置url為提供jsonp服務(wù)的url地址,并在該url中設(shè)置相關(guān)callback參數(shù)
    • 創(chuàng)建script標(biāo)簽,并設(shè)置其src屬性
    • script標(biāo)簽加入head,此時(shí)調(diào)用開(kāi)始。
2.3.2 服務(wù)端

將客戶(hù)端發(fā)送的callback參數(shù)作為函數(shù)名來(lái)包裹住JSON數(shù)據(jù),返回?cái)?shù)據(jù)至客戶(hù)端。

2.4 JSONP在jQuery中的具體實(shí)現(xiàn)

在jQuery中實(shí)現(xiàn)JSONP主要有兩種方式。

  • $.getJSON
  • $.ajax
2.4.1 $.getJSON實(shí)現(xiàn)方式
<script type="text/javascript" src="jquery.js"></script>  
<script type="text/javascript">  
    $.getJSON("http://crossdomain.com/services.php?callback=?", function(json){
        alert('您查詢(xún)到航班信息:票價(jià): ' + json.price + ' 元,余票: ' + json.tickets + ' 張。');
    });  
</script>
2.4.2 $.ajax實(shí)現(xiàn)方式:
<script type="text/javascript" src=jquery.min.js"></script>
<script type="text/javascript">
     $(document).ready(function(){ 
        $.ajax({
             type: "get",
             url: "http://flightQuery.com/jsonp/flightResult.aspx?code=CA1998",
             dataType: "jsonp",
             jsonp: "callback",//傳遞給請(qǐng)求處理程序或頁(yè)面的,用以獲得jsonp回調(diào)函數(shù)名的參數(shù)名(一般默認(rèn)為:callback)
             jsonpCallback:"flightHandler",//自定義的jsonp回調(diào)函數(shù)名稱(chēng),默認(rèn)為jQuery自動(dòng)生成的隨機(jī)函數(shù)名,也可以寫(xiě)"?",jQuery會(huì)自動(dòng)為你處理數(shù)據(jù)
             success: function(json){
                 alert('您查詢(xún)到航班信息:票價(jià): ' + json.price + ' 元,余票: ' + json.tickets + ' 張。');
             },
             error: function(){
                 alert('fail');
             }
         });
     });
</script>

是不是有點(diǎn)奇怪?為什么我這次沒(méi)有寫(xiě)flightHandler這個(gè)函數(shù)呢?而且竟然也運(yùn)行成功了!哈哈,這就是jQuery的功勞了,jquery在處理JSONP類(lèi)型的ajax時(shí)(還是忍不住吐槽,雖然jQuery也把jsonp歸入了ajax,但其實(shí)它們真的不是一回事兒),自動(dòng)幫你生成回調(diào)函數(shù)并把數(shù)據(jù)取出來(lái)供success屬性方法來(lái)調(diào)用。

3. JSONP與GET / POST 請(qǐng)求

我們知道scriptlinkimg 等標(biāo)簽引入外部資源,都是GET請(qǐng)求的,那么就決定了 JSONP 一定是GET的。即便在$.ajax()中使用POST請(qǐng)求也能成功。一旦當(dāng)我們指定dataType: 'jsonp',不管指定type的值是什么(GET/POST/甚至不寫(xiě)),都會(huì)進(jìn)行GET請(qǐng)求。
這是jQuery在封裝JSONP跨域時(shí)就已經(jīng)寫(xiě)死了的。
對(duì)應(yīng)的源碼如下:

jQuery.ajaxPrefilter( "script", function( s ) {
    if ( s.cache === undefined ) {
        s.cache = false;
    }
    if ( s.crossDomain ) {
        s.type = "GET";
        s.global = false;
    }
});

if( s.crossDomain){ s.type = "GET"; ...}這里就是真相~ 在ajax的過(guò)濾函數(shù)中,只要是跨域,jQuery就將其type設(shè)置成GET,真是那句話:在源碼面前,一切了無(wú)秘密~ jQuery源碼我自己很多地方讀不懂,但是并不妨礙我們?nèi)プx,去探索~

4. AJAX與JSONP的異同:

  1. AJAX和JSONP這兩種技術(shù)在調(diào)用方式上“看起來(lái)”很像,目的也一樣,都是請(qǐng)求一個(gè)url,然后把服務(wù)器返回的數(shù)據(jù)進(jìn)行處理,因此jQuery和extjs等框架都把JSONP作為AJAX的一種形式進(jìn)行了封裝;

  2. 但AJAX和JSONP其實(shí)本質(zhì)上是不同的東西。AJAX的核心是通過(guò)XmlHttpRequest獲取非本頁(yè)內(nèi)容,而JSONP的核心則是動(dòng)態(tài)添加<script>標(biāo)簽來(lái)調(diào)用服務(wù)器提供的js腳本。

  3. 所以說(shuō),其實(shí)AJAX與JSONP的區(qū)別不在于是否跨域,AJAX通過(guò)服務(wù)端代理一樣可以實(shí)現(xiàn)跨域,JSONP本身也不排斥同域的數(shù)據(jù)的獲取。

  4. 還有就是,JSONP是一種方式或者說(shuō)非強(qiáng)制性協(xié)議,如同AJAX一樣,它也不一定非要用JSON格式來(lái)傳遞數(shù)據(jù),如果你愿意,字符串都行,只不過(guò)這樣不利于用JSONP提供公開(kāi)服務(wù)。

  5. 總而言之,JSONP不是AJAX的一個(gè)特例,哪怕jQuery等巨頭把它封裝進(jìn)了AJAX,也不能改變這一點(diǎn)!

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容