DIV CSS 佈局教程網

JavaScript 跨域呼叫 RESTful API:CORS 方案完整實作
編輯:關於JavaScript     

只要前端想直接打另一個來源的 API,跨域這件事就避不開。本文從名詞定義開始,把常見的三種解法比較一遍,最後針對最正規的 CORS 方案,示範伺服器端與客戶端各自需要寫什麼。

一、先釐清幾個名詞

AJAX(Asynchronous JavaScript And XML)是一套讓網頁能與伺服器在背景交換少量資料的技術,因為不必重新載入整頁,就能局部更新畫面內容。

JSON(JavaScript Object Notation)則是一種輕量的資料交換格式,看起來就是用大括號包住的一堆 key/value 對:

 {"firstName":"Brett", "lastName":"McLaughlin", "email":"abcdefg@gmail.com"}

同源策略(Same Origin Policy)是瀏覽器基於安全考量的限制:一段腳本只能讀取同來源視窗與文件的屬性。所謂「同來源」,指的是通訊協定、網域、連接埠三者完全相同。

跨域問題正是這條策略的直接結果——當你試著用 AJAX 去抓別台伺服器的資料時,瀏覽器就會把你擋下來。

二、三種常見解法

1. 以 iframe 實作:要求兩個頁面屬於同一個主網域(例如都是 xxx.com),並使用相同的通訊協定與連接埠。限制太多,實務上用途有限。

2. 以 script 標籤實作(JSONP):JSONP(JSON with Padding)並不是官方協定,而是一種「使用模式」。它借用 script 標籤不受同源政策限制的歷史特性來取得資料,能解決主流瀏覽器的跨域問題,但只能發出 GET 請求,這是它最大的侷限。

3. 以後端代理實作(CORS):CORS(Cross-Origin Resource Sharing,跨來源資源共享)是 W3C 的正式標準,它讓瀏覽器得以向跨源的伺服器發出 XMLHttpRequest 請求,從根本上突破了 AJAX 只能同源的束縛。這也是目前最推薦的方式。

三、CORS 的具體做法

伺服器端

伺服器需要在正常的 HTTP 回應標頭中,加上 Access-Control-Allow-Origin、Access-Control-Allow-Methods、Access-Control-Allow-Headers 等欄位。

以下以 Python 撰寫的服務為例,使用 webob.Request 處理請求。修改方式是在 res = req.get_response(self.app) 這行之後補上幾行:

 res.headerlist.append(('Access-Control-Allow-Origin', '*'))
 res.headerlist.append(('Access-Control-Allow-Methods', 'GET, POST'))
 res.headerlist.append(('Access-Control-Max-Age', '3600'))
 res.headerlist.append(('Access-Control-Allow-Headers',
     'Access-Control-Allow-Origin, Access-Control-Allow-Methods, Access-Control-Max-Age, X-Auth-Token, Content-Type, Accept'))

實務上,Access-Control-Allow-Origin 最好不要寫成 *,而是明確限制前端來源的位址,安全性會好很多:

 res.headerlist.append(('Access-Control-Allow-Origin', 'https://10.111.121.26:8080'))

關於預檢請求(Preflight Request)

Access-Control-Max-Age 可以用來設定這些 CORS 相關配置的緩存時間,如此一來客戶端就不必在每次請求前都先做一次預檢。

所謂預檢,是瀏覽器先送出一個使用 OPTIONS 方法、且帶有 Origin 標頭的請求;只有在這個請求被允許之後,才會真正發出跨域的請求。

因此,如果伺服器端對 X-Auth-Token 做了驗證,務必放行 OPTIONS 請求,否則預檢就會被自己的權限機制擋掉:

 def process_request(self, req):
    if (req.headers.get('X-Auth-Token') != 'open-sesame') and (req.method != 'OPTIONS'):
        return exc.HTTPForbidden()

客戶端

發請求時有三個地方要特別注意:

· data 必須是 JSON 格式的字串;
· contentType 用來宣告編碼格式為 UTF-8;
· dataType 用來宣告回傳內容是 JSON。

 data_param = { "timeType": "LAST_7_DAYS", "hostType": "ALL_HOSTS" }

 $.ajax({
    url: "https://172.16.17.11:41128/dpi/webApp/eventRetrieve",
    type: "POST",
    data: JSON.stringify(data_param),
    headers: {
        "X-Auth-Token": "open-sesame",
        "Content-Type": "application/json"
    },
    contentType: 'text/html; charset=UTF-8',
    dataType: "json",
    success: function (data) {
        alert(data);   // Object
    },
    error: function (XMLHttpRequest, textStatus, errorThrown) {
        alert(XMLHttpRequest.status);
        alert(XMLHttpRequest.readyState);
        alert(textStatus);
    },
    complete: function (XMLHttpRequest, textStatus) {
    }
 });

以上就是 JavaScript 跨域呼叫 RESTful API 的完整整理。真正需要花心思的其實只有伺服器端那幾個標頭,尤其是預檢請求的放行,這一步漏掉就會出現「明明設定都對卻還是被擋」的狀況。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved