JSONP 和 JSON 長得好像,它們之間有什麼關係?簡單說,JSON 是資料格式,JSONP 是利用這個格式加上一層「填充」所組出來的跨域取巧方案。本文從頭拆解。
JSON(JavaScript Object Notation)是一種輕量級的資料交換格式,因為它就是 JavaScript 物件字面表示法的子集,所以在 JS 裡可以直接使用,不必任何轉換。
JSONP 是 JSON with Padding 的簡稱,是一個非官方協議。它允許在伺服器端整合 script 標籤回傳至客戶端,透過 JavaScript callback 的形式實現跨域訪問。名字裡的 Padding,指的就是「把 JSON 填進函式呼叫裡」這個動作。
所有支援 JavaScript 的瀏覽器都實施同源策略這道安全防線。所謂「同源」,指的是通訊協定、網域、連接埠三者完全相同。
舉個例子:瀏覽器的兩個分頁分別開著 A 站與 B 站的頁面,當 A 站的頁面執行一段腳本時,瀏覽器會檢查這段腳本屬於哪個頁面、是否同源,只有與 A 站同源的腳本才會被執行。這就是為什麼用 XMLHttpRequest 抓不到跨域資料的原因。
先手動做個小實驗。開一個 ASP.NET Web 專案(稱為 A 程序),加一個 sample.html 與一個 test.js:
sample.html:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="https://www.w3.org/1999/xhtml" > <head> <title>test</title> <script type="text/javascript" src="test.js"></script> </head> <body> </body> </html>
test.js:
alert("success");
打開 sample.html 會跳出 success,這沒什麼稀奇。接著我們模擬非同源的環境:再開一個 Visual Studio 建立 B 程序,把 test.js 從 A 移到 B。兩邊都跑起來後,假設 A 是 localhost:20001、B 是 localhost:20002——通訊協定與網域相同但連接埠不同,這就構成了非同源環境。
修改 sample.html 的 script 路徑:
<script type="text/javascript" src="https://localhost:20002/test.js"></script>
保持兩個程序的運行狀態,重新整理 localhost:20001/sample.html——一樣跳出了 success。你成功存取並執行了非同源的 localhost:20002/test.js。
結論:<script> 標籤的 src 屬性並不被同源策略約束,所以可以載入並執行任何伺服器上的腳本。這就是 JSONP 全部魔法所在。
光執行腳本還不夠,我們需要把資料「傳回來」。做法是客戶端先定義一個回呼函式,遠端腳本再呼叫它並把 JSON 當參數傳入。
A 程序的 sample.html:
<script type="text/javascript"> //回呼函式 function callback(data) { alert(data.message); } </script> <script type="text/javascript" src="https://localhost:20002/test.js"></script>
B 程序的 test.js:
//呼叫 callback 函式,並以 json 資料形式作為參數傳遞,完成回呼 callback({message:"success"});
這就是 JSONP 的雛形:建立一個回呼函式,然後在遠端服務上呼叫這個函式並把 JSON 資料作為參數傳遞,完成回呼。把 JSON 資料填充進回呼函式,就是 JSON + Padding 的含義。
寫死在 HTML 裡的 script 標籤,會在頁面顯示前就執行,很不靈活。改用 JavaScript 動態建立:
<script type="text/javascript"> function callback(data) { alert(data.message); } function addScriptTag(src){ var script = document.createElement('script'); script.setAttribute("type","text/javascript"); script.src = src; document.body.appendChild(script); } window.onload = function(){ addScriptTag("https://localhost:20002/test.js"); } </script>
這裡把 addScriptTag() 放進 window.onload 裡是有原因的:函式中有 document.body.appendChild(script),而這段 JS 寫在 head 裡,此時 document.body 還沒初始化完成,直接執行會出錯。等 onload 觸發後再呼叫就安全了。
上面那個例子還算不上真正的 JSONP 服務,因為回呼函式名是寫死的。真正的服務會把回呼函式名當成參數來接收,例如 Google 的 Ajax 搜尋介面:
https://ajax.googleapis.com/ajax/services/search/web?v=1.0&q=?&callback=?
其中 q=? 是搜尋內容,而 callback=? 是回呼函式名——客戶端把自己定義的函式名送給伺服器,伺服器就回傳以該函式名包裝的資料。
<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("https://ajax.googleapis.com/ajax/services/search/web?v=.&q=apple&callback=result"); } function result(data) { alert(data.responseData.results[].unescapedUrl); } </script>
這類公開的 JSONP 服務還有不少,例如 Digg API(頭條新聞)、Geonames API(郵編位置資訊)、Flickr 的 public feeds(例如載入貓咪圖片)、Yahoo Local Search API(地區商家搜尋)等。
在 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 程序的呼叫:
<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("https://localhost:20002/MyService.ashx?callback=person"); } function person(data) { alert(data.name + " is a " + data.sex); } </script>
方法一:$.getJSON
$.getJSON("https://localhost:20002/MyService.ashx?callback=?", function(data){ alert(data.name + " is a " + data.sex); });
網址末尾必須帶 callback=?,那個問號代表回呼函式名由 jQuery 自動生成(實際名稱類似 jQuery17207481773362960666_1332575486681,可以 debug 看到)。
方法二:$.ajax 指定回呼函式名
$.ajax({ url:"https://localhost:20002/MyService.ashx?callback=?", dataType:"jsonp", jsonpCallback:"person", success:function(data){ alert(data.name + " is a " + data.sex); } });
jsonpCallback 用來指定自己的回呼方法名;dataType: "jsonp" 則告訴 jQuery 以 JSONP 方式存取遠端服務。
回呼函式名的來源不可信,就是 XSS。上面那個 ashx 直接把 context.Request.QueryString["callback"] 原封不動拼進輸出。若有人傳 callback=alert(document.cookie)//,你的頁面就會執行它。正式實作一定要用白名單或正則表達式過濾回呼函式名(例如只允許 ^[a-zA-Z_$][a-zA-Z0-9_$.]*$),並確認回應的 Content-Type 為 application/javascript。
你必須信任對方。JSONP 的本質是「執行對方給你的程式碼」。任何能提供 JSONP 端點的網站,都具備在你的頁面上執行任意 JavaScript 的能力——包含讀取頁面內容、冒用使用者身分發請求。這不是理論風險,而是這項技術的先天設計。因此今天若要在新專案中做跨域,優先是伺服器端設定 CORS 標頭(Access-Control-Allow-Origin),JSONP 只該用在無可奈何的既有系統或老舊第三方服務上。