WebApi Ajax 跨域請求解決方法(CORS實現)

概述

ASP.NET Web API 的好用使用過的都知道,沒有複雜的配置文件,一個簡單的ApiController加上須要的Action就能工做。可是在使用API的時候總會遇到跨域請求的問題,
特別各類APP萬花齊放的今天,API的跨域請求是不能避免的。javascript

在默認狀況下,爲了防止CSRF跨站的僞造攻擊(或者是 javascript的同源策略(Same-Origin Policy)),一個網頁從另一個域獲取數據時就會收到限制。有一些方法能夠突破這個限制,那就是你們熟知的JSONP, 固然這只是衆多解決方法中一種,因爲JSONP只支持GET的請求,現在的複雜業務中已經不能知足需求。而CORS(Cross Origin Resource Sharing https://www.w3.org/wiki/CORS)跨域資源共享,是一種新的header規範,可讓服務器端放鬆跨域的限制,能夠根據header來切換限制或者不限制跨域請求。重要的是它支持全部http請求方式html

問題

XMLHttpRequest 跨域 POST或GET請求 ,請求方式會自動變成OPTIONS的問題。
因爲CORS(cross origin resource share)規範的存在,瀏覽器會首先發送一次options嗅探,同時header帶上origin,判斷是否有跨域請求權限,服務器響應access control allow origin的值,供瀏覽器與origin匹配,若是匹配則正式發送post請求,即使是服務器容許程序跨域訪問,若不支持 options 請求,請求也會死掉。java

緣由

瀏覽器爲了安全起見,會Preflighted Request的透明服務器驗證機制支持開發人員使用自定義的頭部、GET或POST以外的方法,以及不一樣類型的主題內容,也就是會先發送一個 options 請求,
問問服務器是否會正確(容許)請求,確保請求發送是安全的。web

出現 OPTIONS 的狀況通常爲:windows

一、非GET 、POST請求
二、POST請求的content-type不是常規的三個:application/x- www-form-urlencoded(使用 HTTP 的 POST 方法提交的表單)、multipart/form-data(同上,但主要用於表單提交時伴隨文件上傳的場合)、text/plain(純文本) 
三、POST請求的payload爲text/html 
四、設置自定義頭部跨域

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());
}

方法二

配置文件中添加以下配置,此方法簡單,應對簡單的跨域請求app

<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>

參考文獻

https://code.msdn.microsoft.com/windowsdesktop/Implementing-CORS-support-a677ab5d#content

相關文章
相關標籤/搜索