說說JSON和JSONP，含jQuery用例

2024-04-27 15:19:40

字體：大中小

來源：轉載

供稿：網友

前言：

說到Ajax就會不可避免的面臨兩個問題，第一個是AJAX以何種格式來交換數據？第二個是跨域的需求如何解決？這兩個問題目前都有不同的解決方案，比如數據可以用自定義字符串或者用xml來描述，跨域可以通過服務器端代理來解決。

但到目前為止最被推崇或者說首選的方案還是用JSON來傳數據，靠JSONP來跨域。而這就是本文將要講述的內容。

JSON和JSONP雖然只有一個字母的差別，但其實他們根本不是一回事兒：JSON是一種數據交換格式，而JSONP是一種依靠開發人員的聰明才智創造出的一種非官方跨域數據交互協議。我們拿最近比較火的諜戰片來打個比方，JSON是地下黨們用來書寫和交換情報的“暗號”，而JSONP則是把用暗號書寫的情報傳遞給自己同志時使用的接頭方式。看到沒？一個是描述信息的格式，一個是信息傳遞雙方約定的方法。

既然隨便聊聊，那我們就不再采用教條的方式來講述，而是把關注重心放在幫助開發人員理解是否應當選擇使用以及如何使用上。

什么是JSON？

前面簡單說了一下，JSON是一種基于文本的數據交換方式，或者叫做數據描述格式，你是否該選用他首先肯定要關注它所擁有的優點。

JSON的優點：

1、基于純文本，跨平臺傳遞極其簡單；

2、javascript原生支持，后臺語言幾乎全部支持；

3、輕量級數據格式，占用字符數量極少，特別適合互聯網傳遞；

4、可讀性較強，雖然比不上XML那么一目了然，但在合理的依次縮進之后還是很容易識別的；

5、容易編寫和解析，當然前提是你要知道數據結構；

JSON的缺點當然也有，但在作者看來實在是無關緊要的東西，所以不再單獨說明。

JSON的格式或者叫規則：

JSON能夠以非常簡單的方式來描述數據結構，XML能做的它都能做，因此在跨平臺方面兩者完全不分伯仲。

1、JSON只有兩種數據類型描述符，大括號{}和方括號[]，其余英文冒號:是映射符，英文逗號,是分隔符，英文雙引號""是定義符。

2、大括號{}用來描述一組“不同類型的無序鍵值對集合”（每個鍵值對可以理解為OOP的屬性描述），方括號[]用來描述一組“相同類型的有序數據集合”（可對應OOP的數組）。

3、上述兩種集合中若有多個子項，則通過英文逗號,進行分隔。

4、鍵值對以英文冒號:進行分隔，并且建議鍵名都加上英文雙引號""，以便于不同語言的解析。

5、JSON內部常用數據類型無非就是字符串、數字、布爾、日期、null 這么幾個，字符串必須用雙引號引起來，其余的都不用，日期類型比較特殊，這里就不展開講述了，只是建議如果客戶端沒有按日期排序功能需求的話，那么把日期時間直接作為字符串傳遞就好，可以省去很多麻煩。

JSON實例：

// 描述一個人var person = {    "Name": "Bob",    "Age": 32,    "Company": "IBM",    "Engineer": true}// 獲取這個人的信息var personAge = person.Age;// 描述幾個人var members = [    {        "Name": "Bob",        "Age": 32,        "Company": "IBM",        "Engineer": true    },    {        "Name": "John",        "Age": 20,        "Company": "Oracle",        "Engineer": false    },    {        "Name": "Henry",        "Age": 45,        "Company": "Microsoft",        "Engineer": false    }]// 讀取其中John的公司名稱var johnsCompany = members[1].Company;// 描述一次會議var conference = {    "Conference": "Future Marketing",    "Date": "2012-6-1",    "Address": "Beijing",    "Members":     [        {            "Name": "Bob",            "Age": 32,            "Company": "IBM",            "Engineer": true        },        {            "Name": "John",            "Age": 20,            "Company": "Oracle",            "Engineer": false        },        {            "Name": "Henry",            "Age": 45,            "Company": "Microsoft",            "Engineer": false        }    ]}// 讀取參會者Henry是否工程師var henryIsAnEngineer = conference.Members[2].Engineer; 
關于JSON，就說這么多，更多細節請在開發過程中查閱資料深入學習。
 
 什么是JSONP？
 
先說說JSONP是怎么產生的：
其實網上關于JSONP的講解有很多，但卻千篇一律，而且云里霧里，對于很多剛接觸的人來講理解起來有些困難，小可不才，試著用自己的方式來闡釋一下這個問題，看看是否有幫助。
1、一個眾所周知的問題，Ajax直接請求普通文件存在跨域無權限訪問的問題，甭管你是靜態頁面、動態網頁、web服務、WCF，只要是跨域請求，一律不準；
2、不過我們又發現，Web頁面上調用js文件時則不受是否跨域的影響（不僅如此，我們還發現凡是擁有"src"這個屬性的標簽都擁有跨域的能力，比如<script>、<img>、<iframe>）；
3、于是可以判斷，當前階段如果想通過純web端（ActiveX控件、服務端代理、屬于未來的HTML5之Websocket等方式不算）跨域訪問數據就只有一種可能，那就是在遠程服務器上設法把數據裝進js格式的文件里，供客戶端調用和進一步處理；
4、恰巧我們已經知道有一種叫做JSON的純字符數據格式可以簡潔的描述復雜數據，更妙的是JSON還被js原生支持，所以在客戶端幾乎可以隨心所欲的處理這種格式的數據；
5、這樣子解決方案就呼之欲出了，web客戶端通過與調用腳本一模一樣的方式，來調用跨域服務器上動態生成的js格式文件（一般以JSON為后綴），顯而易見，服務器之所以要動態生成JSON文件，目的就在于把客戶端需要的數據裝入進去。
6、客戶端在對JSON文件調用成功之后，也就獲得了自己所需的數據，剩下的就是按照自己需求進行處理和展現了，這種獲取遠程數據的方式看起來非常像AJAX，但其實并不一樣。
7、為了便于客戶端使用數據，逐漸形成了一種非正式傳輸協議，人們把它稱作JSONP，該協議的一個要點就是允許用戶傳遞一個callback參數給服務端，然后服務端返回數據時會將這個callback參數作為函數名來包裹住JSON數據，這樣客戶端就可以隨意定制自己的函數來自動處理返回數據了。
如果對于callback參數如何使用還有些模糊的話，我們后面會有具體的實例來講解。
JSONP的客戶端具體實現：
不管jQuery也好，extjs也罷，又或者是其他支持jsonp的框架，他們幕后所做的工作都是一樣的，下面我來循序漸進的說明一下jsonp在客戶端的實現：
 
1、我們知道，哪怕跨域js文件中的代碼（當然指符合web腳本安全策略的），web頁面也是可以無條件執行的。
遠程服務器remoteserver.com根目錄下有個remote.js文件代碼如下：
alert('我是遠程文件');本地服務器localserver.com下有個jsonp.html頁面代碼如下：
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head>    <title></title>    <script type="text/Javascript" src="http://remoteserver.com/remote.js"></script></head><body></body></html>毫無疑問，頁面將會彈出一個提示窗體，顯示跨域調用成功。
 
2、現在我們在jsonp.html頁面定義一個函數，然后在遠程remote.js中傳入數據進行調用。
jsonp.html頁面代碼如下：
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head>    <title></title>    <script type="text/javascript">    var localHandler = function(data){        alert('我是本地函數，可以被跨域的remote.js文件調用，遠程js帶來的數據是：' + data.result);    };    </script>    <script type="text/javascript" src="http://remoteserver.com/remote.js"></script></head><body></body></html>remote.js文件代碼如下：
localHandler({"result":"我是遠程js帶來的數據"});運行之后查看結果，頁面成功彈出提示窗口，顯示本地函數被跨域的遠程js調用成功，并且還接收到了遠程js帶來的數據。很欣喜，跨域遠程獲取數據的目的基本實現了，但是又一個問題出現了，我怎么讓遠程js知道它應該調用的本地函數叫什么名字呢？畢竟是jsonp的服務者都要面對很多服務對象，而這些服務對象各自的本地函數都不相同啊？我們接著往下看。
 
3、聰明的開發者很容易想到，只要服務端提供的js腳本是動態生成的就行了唄，這樣調用者可以傳一個參數過去告訴服務端“我想要一段調用XXX函數的js代碼，請你返回給我”，于是服務器就可以按照客戶端的需求來生成js腳本并響應了。
看jsonp.html頁面的代碼：
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head>    <title></title>    <script type="text/javascript">    // 得到航班信息查詢結果后的回調函數    var flightHandler = function(data){        alert('你查詢的航班結果是：票價 ' + data.PRice + ' 元，' + '余票 ' + data.tickets + ' 張。');    };    // 提供jsonp服務的url地址（不管是什么類型的地址，最終生成的返回值都是一段javascript代碼）    var url = "http://flightQuery.com/jsonp/flightResult.aspx?code=CA1998&callback=flightHandler";    // 創建script標簽，設置其屬性    var script = document.createElement('script');    script.setAttribute('src', url);    // 把script標簽加入head，此時調用開始    document.getElementsByTagName('head')[0].appendChild(script);     </script></head><body></body></html>這次的代碼變化比較大，不再直接把遠程js文件寫死，而是編碼實現動態查詢，而這也正是jsonp客戶端實現的核心部分，本例中的重點也就在于如何完成jsonp調用的全過程。
我們看到調用的url中傳遞了一個code參數，告訴服務器我要查的是CA1998次航班的信息，而callback參數則告訴服務器，我的本地回調函數叫做flightHandler，所以請把查詢結果傳入這個函數中進行調用。
OK，服務器很聰明，這個叫做flightResult.aspx的頁面生成了一段這樣的代碼提供給jsonp.html（服務端的實現這里就不演示了，與你選用的語言無關，說到底就是拼接字符串）：
flightHandler({    "code": "CA1998",    "price": 1780,    "tickets": 5});我們看到，傳遞給flightHandler函數的是一個json，它描述了航班的基本信息。運行一下頁面，成功彈出提示窗口，jsonp的執行全過程順利完成！
 
4、到這里為止的話，相信你已經能夠理解jsonp的客戶端實現原理了吧？剩下的就是如何把代碼封裝一下，以便于與用戶界面交互，從而實現多次和重復調用。
什么？你用的是jQuery，想知道jQuery如何實現jsonp調用？好吧，那我就好人做到底，再給你一段jQuery使用jsonp的代碼（我們依然沿用上面那個航班信息查詢的例子，假定返回jsonp結果不變）：
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head>     <title>Untitled Page</title>      <script type="text/javascript" src=jquery.min.js"></script>      <script type="text/javascript">     jQuery(document).ready(function(){         $.ajax({             type: "get",             async: false,             url: "http://flightQuery.com/jsonp/flightResult.aspx?code=CA1998",             dataType: "jsonp",             jsonp: "callback",//傳遞給請求處理程序或頁面的，用以獲得jsonp回調函數名的參數名(一般默認為:callback)             jsonpCallback:"flightHandler",//自定義的jsonp回調函數名稱，默認為jQuery自動生成的隨機函數名，也可以寫"?"，jQuery會自動為你處理數據             success: function(json){                 alert('您查詢到航班信息：票價： ' + json.price + ' 元，余票： ' + json.tickets + ' 張。');             },             error: function(){                 alert('fail');             }         });     });     </script>     </head>  <body>  </body> </html>是不是有點奇怪？為什么我這次沒有寫flightHandler這個函數呢？而且竟然也運行成功了！哈哈，這就是jQuery的功勞了，jquery在處理jsonp類型的ajax時（還是忍不住吐槽，雖然jquery也把jsonp歸入了ajax，但其實它們真的不是一回事兒），自動幫你生成回調函數并把數據取出來供success屬性方法來調用，是不是很爽呀？
 
好啦，寫到這里，我已經無力再寫下去，又困又累，得趕緊睡覺。朋友們要是看這不錯，覺得有啟發，給點個“推薦”唄！由于實在比較簡單，所以就不再提供demo源碼下載了。