前言
說(shuō)到AJAX就會(huì)不可避免的面臨兩個(gè)問題,第一個(gè)是AJAX以何種格式來(lái)交換數(shù)據(jù)婿滓?第二個(gè)是跨域的需求如何解決伤哺?這兩個(gè)問題目前都有不同的解決方案,比如數(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是一種依靠開發(fā)人員的聰明才智創(chuàng)造出的一種非官方跨域數(shù)據(jù)交互協(xié)議。我們拿最近比較火的諜戰(zhàn)片來(lái)打個(gè)比方祟偷,JSON是地下黨們用來(lái)書寫和交換情報(bào)的“暗號(hào)”察滑,而JSONP則是把用暗號(hào)書寫的情報(bào)傳遞給自己同志時(shí)使用的接頭方式⌒蕹Γ看到?jīng)]贺辰?一個(gè)是描述信息的格式,一個(gè)是信息傳遞雙方約定的方法嵌施。
既然隨便聊聊饲化,那我們就不再采用教條的方式來(lái)講述,而是把關(guān)注重心放在幫助開發(fā)人員理解是否應(yīng)當(dāng)選擇使用以及如何使用上吗伤。
JSON
前面簡(jiǎn)單說(shuō)了一下吃靠,JSON是一種基于文本的數(shù)據(jù)交換方式,或者叫做數(shù)據(jù)描述格式足淆,你是否該選用他首先肯定要關(guān)注它所擁有的優(yōu)點(diǎn)撩笆。
JSON的優(yōu)點(diǎn):
1、基于純文本缸浦,跨平臺(tái)傳遞極其簡(jiǎn)單夕冲;
2、Javascript原生支持裂逐,后臺(tái)語(yǔ)言幾乎全部支持歹鱼;
3、輕量級(jí)數(shù)據(jù)格式卜高,占用字符數(shù)量極少弥姻,特別適合互聯(lián)網(wǎng)傳遞;
4掺涛、可讀性較強(qiáng)庭敦,雖然比不上XML那么一目了然,但在合理的依次縮進(jìn)之后還是很容易識(shí)別的薪缆;
5秧廉、容易編寫和解析,當(dāng)然前提是你要知道數(shù)據(jù)結(jié)構(gòu);
JSON的缺點(diǎn)當(dāng)然也有疼电,但在作者看來(lái)實(shí)在是無(wú)關(guān)緊要的東西嚼锄,所以不再單獨(dú)說(shuō)明。
JSON的格式或者叫規(guī)則:
JSON能夠以非常簡(jiǎn)單的方式來(lái)描述數(shù)據(jù)結(jié)構(gòu)蔽豺,XML能做的它都能做区丑,因此在跨平臺(tái)方面兩者完全不分伯仲。
1修陡、JSON只有兩種數(shù)據(jù)類型描述符沧侥,大括號(hào){}和方括號(hào)[],其余英文冒號(hào):是映射符魄鸦,英文逗號(hào),是分隔符正什,英文雙引號(hào)""是定義符。
2号杏、大括號(hào){}用來(lái)描述一組“不同類型的無(wú)序鍵值對(duì)集合”(每個(gè)鍵值對(duì)可以理解為OOP的屬性描述)婴氮,方括號(hào)[]用來(lái)描述一組“相同類型的有序數(shù)據(jù)集合”(可對(duì)應(yīng)OOP的數(shù)組)。
3盾致、上述兩種集合中若有多個(gè)子項(xiàng)主经,則通過(guò)英文逗號(hào),進(jìn)行分隔。
4庭惜、鍵值對(duì)以英文冒號(hào):進(jìn)行分隔罩驻,并且建議鍵名都加上英文雙引號(hào)"",以便于不同語(yǔ)言的解析护赊。
5惠遏、JSON內(nèi)部常用數(shù)據(jù)類型無(wú)非就是字符串、數(shù)字骏啰、布爾节吮、日期、null 這么幾個(gè)判耕,字符串必須用雙引號(hào)引起來(lái)透绩,其余的都不用,日期類型比較特殊壁熄,這里就不展開講述了帚豪,只是建議如果客戶端沒有按日期排序功能需求的話,那么把日期時(shí)間直接作為字符串傳遞就好草丧,可以省去很多麻煩狸臣。
JSON實(shí)例:
// 描述一個(gè)人
var person = {
"Name": "Bob",
"Age": 32,
"Company": "IBM",
"Engineer": true
}
// 獲取這個(gè)人的信息
var personAge = person.Age;
// 描述幾個(gè)人
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;
// 描述一次會(huì)議
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
}
]
}
// 讀取參會(huì)者Henry是否工程師
var henryIsAnEngineer = conference.Members[2].Engineer;
關(guān)于JSON,就說(shuō)這么多昌执,更多細(xì)節(jié)請(qǐng)?jiān)陂_發(fā)過(guò)程中查閱資料深入學(xué)習(xí)烛亦。
什么是JSONP
先說(shuō)說(shuō)JSONP是怎么產(chǎn)生的:
其實(shí)網(wǎng)上關(guān)于JSONP的講解有很多诈泼,但卻千篇一律,而且云里霧里此洲,對(duì)于很多剛接觸的人來(lái)講理解起來(lái)有些困難,小可不才委粉,試著用自己的方式來(lái)闡釋一下這個(gè)問題呜师,看看是否有幫助。
1贾节、一個(gè)眾所周知的問題汁汗,Ajax直接請(qǐng)求普通文件存在跨域無(wú)權(quá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ù)端代理痕支、屬于未來(lái)的HTML5之Websocket等方式不算)跨域訪問數(shù)據(jù)就只有一種可能,那就是在遠(yuǎn)程服務(wù)器上設(shè)法把數(shù)據(jù)裝進(jìn)js格式的文件里蛮原,供客戶端調(diào)用和進(jìn)一步處理采转;
4、恰巧我們已經(jīng)知道有一種叫做JSON的純字符數(shù)據(jù)格式可以簡(jiǎn)潔的描述復(fù)雜數(shù)據(jù)瞬痘,更妙的是JSON還被js原生支持故慈,所以在客戶端幾乎可以隨心所欲的處理這種格式的數(shù)據(jù);
5框全、這樣子解決方案就呼之欲出了察绷,web客戶端通過(guò)與調(diào)用腳本一模一樣的方式,來(lái)調(diào)用跨域服務(wù)器上動(dòng)態(tài)生成的js格式文件(一般以JSON為后綴)津辩,顯而易見拆撼,服務(wù)器之所以要?jiǎng)討B(tài)生成JSON文件容劳,目的就在于把客戶端需要的數(shù)據(jù)裝入進(jìn)去。
6闸度、客戶端在對(duì)JSON文件調(diào)用成功之后竭贩,也就獲得了自己所需的數(shù)據(jù),剩下的就是按照自己需求進(jìn)行處理和展現(xiàn)了莺禁,這種獲取遠(yuǎn)程數(shù)據(jù)的方式看起來(lái)非常像AJAX留量,但其實(shí)并不一樣。
7哟冬、為了便于客戶端使用數(shù)據(jù)楼熄,逐漸形成了一種非正式傳輸協(xié)議,人們把它稱作JSONP浩峡,該協(xié)議的一個(gè)要點(diǎn)就是允許用戶傳遞一個(gè)callback參數(shù)給服務(wù)端可岂,然后服務(wù)端返回?cái)?shù)據(jù)時(shí)會(huì)將這個(gè)callback參數(shù)作為函數(shù)名來(lái)包裹住JSON數(shù)據(jù),這樣客戶端就可以隨意定制自己的函數(shù)來(lái)自動(dòng)處理返回?cái)?shù)據(jù)了翰灾。
如果對(duì)于callback參數(shù)如何使用還有些模糊的話缕粹,我們后面會(huì)有具體的實(shí)例來(lái)講解。
JSONP的客戶端具體實(shí)現(xiàn):
不管jQuery也好纸淮,extjs也罷致开,又或者是其他支持jsonp的框架,他們幕后所做的工作都是一樣的萎馅,下面我來(lái)循序漸進(jìn)的說(shuō)明一下jsonp在客戶端的實(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>
<head>
<title></title>
<script type="text/javascript" src="http://remoteserver.com/remote.js"></script>
</head>
<body>
</body>
</html>
毫無(wú)疑問,頁(yè)面將會(huì)彈出一個(gè)提示窗體峭竣,顯示跨域調(diào)用成功塘辅。
2、現(xiàn)在我們?cè)趈sonp.html頁(yè)面定義一個(gè)函數(shù)皆撩,然后在遠(yuǎn)程remote.js中傳入數(shù)據(jù)進(jìn)行調(diào)用扣墩。
jsonp.html頁(yè)面代碼如下:
<!DOCTYPE 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è)問題出現(xiàn)了濒持,我怎么讓遠(yuǎn)程js知道它應(yīng)該調(diào)用的本地函數(shù)叫什么名字呢键耕?畢竟是jsonp的服務(wù)者都要面對(duì)很多服務(wù)對(duì)象,而這些服務(wù)對(duì)象各自的本地函數(shù)都不相同案逃屈雄?我們接著往下看。
3官套、聰明的開發(fā)者很容易想到酒奶,只要服務(wù)端提供的js腳本是動(dòng)態(tài)生成的就行了唄,這樣調(diào)用者可以傳一個(gè)參數(shù)過(guò)去告訴服務(wù)端“我想要一段調(diào)用XXX函數(shù)的js代碼虏杰,請(qǐng)你返回給我”讥蟆,于是服務(wù)器就可以按照客戶端的需求來(lái)生成js腳本并響應(yīng)了勒虾。
看jsonp.html頁(yè)面的代碼:
<!DOCTYPE html>
<head>
<title></title>
<script type="text/javascript">
// 得到航班信息查詢結(jié)果后的回調(diào)函數(shù)
var flightHandler = function(data){
alert('你查詢的航班結(jié)果是:票價(jià) ' + data.price + ' 元纺阔,' + '余票 ' + data.tickets + ' 張。');
};
// 提供jsonp服務(wù)的url地址(不管是什么類型的地址修然,最終生成的返回值都是一段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)用開始
document.getElementsByTagName('head')[0].appendChild(script);
</script>
</head>
<body>
</body>
</html>
這次的代碼變化比較大愕宋,不再直接把遠(yuǎn)程js文件寫死玻靡,而是編碼實(shí)現(xiàn)動(dòng)態(tài)查詢,而這也正是jsonp客戶端實(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)把查詢結(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ò)程順利完成菌赖!
4、到這里為止的話沐序,相信你已經(jīng)能夠理解jsonp的客戶端實(shí)現(xiàn)原理了吧琉用?剩下的就是如何把代碼封裝一下堕绩,以便于與用戶界面交互,從而實(shí)現(xiàn)多次和重復(fù)調(diào)用邑时。
什么奴紧?你用的是jQuery,想知道jQuery如何實(shí)現(xiàn)jsonp調(diào)用晶丘?好吧黍氮,那我就好人做到底,再給你一段jQuery使用jsonp的代碼(我們依然沿用上面那個(gè)航班信息查詢的例子浅浮,假定返回jsonp結(jié)果不變):
<!DOCTYPE html>
<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",//傳遞給請(qǐng)求處理程序或頁(yè)面的沫浆,用以獲得jsonp回調(diào)函數(shù)名的參數(shù)名(一般默認(rèn)為:callback)
jsonpCallback:"flightHandler",//自定義的jsonp回調(diào)函數(shù)名稱,默認(rèn)為jQuery自動(dòng)生成的隨機(jī)函數(shù)名滚秩,也可以寫"?"专执,jQuery會(huì)自動(dòng)為你處理數(shù)據(jù)
success: function(json){
alert('您查詢到航班信息:票價(jià): ' + json.price + ' 元,余票: ' + json.tickets + ' 張郁油。');
},
error: function(){
alert('fail');
}
});
});
</script>
</head>
<body>
</body>
</html>
是不是有點(diǎn)奇怪本股?為什么我這次沒有寫flightHandler這個(gè)函數(shù)呢?而且竟然也運(yùn)行成功了桐腌!哈哈拄显,這就是jQuery的功勞了,jquery在處理jsonp類型的ajax時(shí)(還是忍不住吐槽案站,雖然jquery也把jsonp歸入了ajax躬审,但其實(shí)它們真的不是一回事兒),自動(dòng)幫你生成回調(diào)函數(shù)并把數(shù)據(jù)取出來(lái)供success屬性方法來(lái)調(diào)用蟆盐,是不是很爽呀承边?
5.用jquery的jsonp進(jìn)行跨域讀取數(shù)據(jù)
$.getJSON("http://flightQuery.com/jsonp/flightResult.aspx?code=CA1998&jsoncallback=?",
function (data) {
alert(data);
}
);
執(zhí)行原理:
發(fā)送請(qǐng)求時(shí)需要傳一個(gè)callback的回調(diào)函數(shù)名到服務(wù)器端,服務(wù)器端拿到這個(gè)回調(diào)函數(shù)名舱禽,再將返回?cái)?shù)據(jù)用參數(shù)的形式反回到客戶端炒刁,這樣客戶端就能夠調(diào)到。
所以發(fā)送請(qǐng)求URL的地址后面一定要上jsoncallback=?這樣的參數(shù)誊稚,jquery會(huì)將?號(hào)自動(dòng)替換成自動(dòng)生成的回調(diào)函數(shù)的名稱翔始。
所以最終的實(shí)際請(qǐng)求為:
http://flightQuery.com/jsonp/flightResult.aspx?code=CA1998&jsoncallback=jsonp1322444422697
所以和ajax的方式想比較,也就是callback函數(shù)一個(gè)是自動(dòng)生成的函數(shù)名里伯,一個(gè)是手工指定的函數(shù)名城瞎。