DIV CSS 佈局教程網

jQuery.ajax 跨網域請求 WebAPI 並自訂 Header 的完整解法
編輯:關於JavaScript     

跨網域呼叫服務時想額外帶上自訂的請求標頭(例如 token),會遇到一個很多人踩過的問題:請求直接失敗,看起來完全沒有合理的錯誤訊息。原因在於瀏覽器的 preflight(預檢)機制。

為什麼會多出一次請求

當跨網域請求帶有「非簡單」的自訂標頭時,瀏覽器不會直接送出真正的請求,而是先自動發一次 OPTIONS 請求問伺服器:「我接下來要用 POST 加上 token 這個標頭,你准嗎?」伺服器答應之後,瀏覽器才會發出真正的請求。

所以整個流程是兩步:OPTIONS 預檢 → 真正的請求。若後端沒有正確回應 OPTIONS,第二步永遠不會發生。

第一步:後端設定回應標頭

在 WebAPI 的 web.config 中加上跨網域相關的標頭:

<system.webServer>
 <httpProtocol>
 <!--跨域配置開始-->
 <customHeaders>
 <add name="Access-Control-Allow-Origin" value="*" />
 <!--支持全域名訪問,不安全,部署後需要固定限制為客戶端網址-->
 <add name="Access-Control-Allow-Methods" value="GET, POST, PUT, DELETE, OPTIONS" />
 <!--支援的 http 動作-->
 <add name="Access-Control-Allow-Headers" value="Content-Type,X-Requested-With,token" />
 <!--允許的請求標頭,請依需求調整,這裡新增了 token-->
 <add name="Access-Control-Request-Methods" value="GET, POST, PUT, DELETE, OPTIONS" />
 </customHeaders>
 <!--跨域配置結束-->
 </httpProtocol>
</system.webServer>

特別注意 Access-Control-Allow-Origin。設成 * 只是開發期的方便做法,上正式環境後務必改成具體的網域,否則等於對所有網站敞開大門。同時 Allow-Headers 必須明確列出你會用到的自訂標頭名稱,漏掉的話預檢就會失敗。

第二步:讓後端正確回應 OPTIONS

預檢請求不需要回傳任何內容,只要給一個 202 Accepted 表示「我收到了,你繼續」即可。實務上最乾淨的做法是在權限攔截器中攔下它:

/// <summary>
/// 權限攔截器
/// </summary>
public class ApiAuthorizeAttribute : AuthorizeAttribute
{
 public override void OnAuthorization(HttpActionContext actionContext)
 {
 if (actionContext.Request.Method == HttpMethod.Options)
 {
 actionContext.Response =
 actionContext.Request.CreateResponse(HttpStatusCode.Accepted);
 return;
 }
 // 這裡接續原本的權限驗證邏輯
 }
}

這個寫法的好處是:預檢請求不必經過後面的驗證流程,也不會因為「沒有帶 token」而被 401 擋掉——畢竟預檢的目的正是要問「帶 token 行不行」。

第三步:客戶端送出請求

$("#btnSumit").click(function () {
 var Ticket = $.cookie("token");
 var model = { id: 1 };

 $.ajax({
 type: "POST",
 url: "https://localhost:65312/api/products/FindProductById",
 data: JSON.stringify(model),
 contentType: "application/json; charset=utf-8",
 dataType: "json",
 beforeSend: function (xhr) {
 // 請求發起前在標頭附加 token
 xhr.setRequestHeader("token", Ticket);
 },
 success: function (data, status) {
 if (data.statuscode == "401") {
 alert(data.msg);
 } else {
 alert(JSON.stringify(data));
 }
 },
 complete: function () { }
 });
});

關鍵是 beforeSend:這個回呼讓你能拿到原生的 XMLHttpRequest 物件,在請求真正送出前掛上任何自訂標頭。

除錯建議

遇到跨域問題時,打開開發者工具的 Network 面板,你會清楚看到 OPTIONS 與 POST 兩筆紀錄。哪一筆是紅的就代表問題在哪一層:OPTIONS 失敗通常是標頭或方法沒被允許;OPTIONS 成功但 POST 失敗,則多半是回應缺少 Access-Control-Allow-Origin。另外別忘了 Access-Control-Allow-Credentials——若你需要帶 cookie,且 Origin 已改為具體網域,這個標頭也要一併設定。

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