首頁 > 文章 > web前端 > 用CORS實作WebApi Ajax跨域請求的方法

用CORS實作WebApi Ajax跨域請求的方法

php中世界最好的语言原創: 2018-03-31 10:34:302135瀏覽

這次帶給大家用CORS實作WebApi Ajax跨域請求的方法，用CORS實作WebApi Ajax跨域請求的注意事項有哪些，下面就是實戰案例，一起來看一下。

概述

ASP.NET Web API 的好用使用過的都知道，沒有複雜的設定檔，一個簡單的ApiController加上需要的Action就能運作。但是使用API的時候總會遇到跨域請求的問題，特別各種APP萬花齊放的今天，API的跨域請求是不能避免的。

在預設情況下，為了防止CSRF跨站的偽造攻擊(或是javascript的同源策略（Same-Origin Policy）)，當一個網頁從另一個網域取得資料時就會收到限制。有一些方法可以突破這個限制，那就是大家熟知的JSONP，當然這只是眾多解決方法中一種，由於JSONP只支援GET的請求，如今的複雜業務中已經不能滿足需求。而CORS（Cross Origin Resource Sharing https://www.w3.org/wiki/CORS）跨域資源共享，是一種新的header規範，可以讓伺服器端放鬆跨域的限制，可以根據header來切換限制或不限制跨域請求。重要的是它支援所有http請求方式。

問題

XMLHttpRequest 跨域 POST或GET請求，請求方式會自動變成OPTIONS的問題。

由於CORS（cross origin resource share）規範的存在，瀏覽器會先發送一次options嗅探，同時header帶上origin，判斷是否有跨域請求權限，伺服器回應access control allow origin的值，供瀏覽器與origin匹配，如果匹配則正式發送post請求，即便是伺服器允許程式跨域訪問，若不支援options 請求，請求也會死掉。

原因

瀏覽器為了安全起見，會Preflighted Request的透明伺服器驗證機制支援開發人員使用自訂的頭部、GET或POST以外的方法，以及不同類型的主題內容，也就是會先發送一個options 請求，
問伺服器是否會正確（允許）請求，確保請求發送是安全的。

出現OPTIONS 的情況一般為：

1、非GET 、POST請求

2、POST請求的content-type不是常規的三個：application/x- www-form-urlencoded（使用HTTP 的POST 方法提交的表單）、multipart/form-data（同上，但主要用於表單提交時伴隨文件上傳的場合）、text/plain（純文本)　

3、POST請求的payload為text/html　

#4、設定自訂頭部

OPTIONS請求頭部中會包含以下頭部：Origin、Access -Control-Request-Method、Access-Control-Request-Headers，發送這個請求後，伺服器可以設定以下頭部與瀏覽器溝通來判斷是否允許這個請求。
Access-Control-Allow-Origin、Access-Control-Allow-Method、Access-Control-Allow-Headers

解決方法

此方法功能強大，可以解決ASP.NET Web API複雜跨域請求，攜帶複雜頭部訊息，正文內容和授權驗證訊息

方法一

public class CrosHandler:DelegatingHandler
{
 private const string Origin = "Origin";
 private const string AccessControlRequestMethod = "Access-Control-Request-Method";
 private const string AccessControlRequestHeaders = "Access-Control-Request-Headers";
 private const string AccessControlAllowOrign = "Access-Control-Allow-Origin";
 private const string AccessControlAllowMethods = "Access-Control-Allow-Methods";
 private const string AccessControlAllowHeaders = "Access-Control-Allow-Headers";
 private const string AccessControlAllowCredentials = "Access-Control-Allow-Credentials";
 protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
 {
  bool isCrosRequest = request.Headers.Contains(Origin);
  bool isPrefilightRequest = request.Method == HttpMethod.Options;
  if (isCrosRequest)
  {
   Task<HttpResponseMessage> taskResult = null;
   if (isPrefilightRequest)
   {
    taskResult = Task.Factory.StartNew<HttpResponseMessage>(() =>
    {
     HttpResponseMessage response = new HttpResponseMessage(System.Net.HttpStatusCode.OK);
     response.Headers.Add(AccessControlAllowOrign,
      request.Headers.GetValues(Origin).FirstOrDefault());
     string method = request.Headers.GetValues(AccessControlRequestMethod).FirstOrDefault();
     if (method != null)
     {
      response.Headers.Add(AccessControlAllowMethods, method);
     }
     string headers = string.Join(", ", request.Headers.GetValues(AccessControlRequestHeaders));
     if (!string.IsNullOrWhiteSpace(headers))
     {
      response.Headers.Add(AccessControlAllowHeaders, headers);
     }
     response.Headers.Add(AccessControlAllowCredentials, "true");
     return response;
    }, cancellationToken);
   }
   else
   {
    taskResult = base.SendAsync(request, cancellationToken).ContinueWith<HttpResponseMessage>(t =>
    {
     var response = t.Result;
     response.Headers.Add(AccessControlAllowOrign,
      request.Headers.GetValues(Origin).FirstOrDefault());
     response.Headers.Add(AccessControlAllowCredentials, "true");
     return response;
    });
   }
   return taskResult;
  }
  return base.SendAsync(request, cancellationToken);
 }
}

使用方式，在Global.asax檔案中新增

protected void Application_Start()
{
 IOCConfig.RegisterAll();
 AreaRegistration.RegisterAllAreas();
 WebApiConfig.Register(GlobalConfiguration.Configuration);
 FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
 RouteConfig.RegisterRoutes(RouteTable.Routes);
 BundleConfig.RegisterBundles(BundleTable.Bundles);
 GlobalConfiguration.Configuration.MessageHandlers.Add(new CrosHandler());
}

方法二

設定檔中加入如下配置，此方法簡單，應對簡單的跨域請求

<system.webServer>
 <httpProtocol>
  <customHeaders>
  <add name="Access-Control-Allow-Origin" value="*" />
  <add name="Access-Control-Allow-Headers" value="Content-Type" />
  <add name="Access-Control-Allow-Methods" value="GET, POST,OPTIONS" />
  </customHeaders>
 </httpProtocol>
<system.webServer>

相信看了本文案例你已經掌握了方法，更多精彩請關注php中文網其它相關文章！