ajax跨域,這應該是最全的解決方案了

前言

搬運的歷史文章javascript

從剛接觸前端開發起,跨域這個詞就一直以很高的頻率在身邊重複出現,一直到如今,已經調試過N個跨域相關的問題了,16年時也整理過一篇相關文章,可是感受仍是差了點什麼,因而如今從新梳理了一下。php

我的見識有限,若有差錯,請多多見諒,歡迎提出issue,另外看到這個標題,請勿噴~html

題綱

關於跨域,有N種類型,本文只專一於ajax請求跨域(,ajax跨域只是屬於瀏覽器"同源策略"中的一部分,其它的還有Cookie跨域iframe跨域,LocalStorage跨域等這裏不作介紹),內容大概以下:前端

  • 什麼是ajax跨域java

    • 原理node

    • 表現(整理了一些遇到的問題以及解決方案)git

  • 如何解決ajax跨域github

    • JSONP方式web

    • CORS方式ajax

    • 代理請求方式

  • 如何分析ajax跨域

    • http抓包的分析

    • 一些示例

什麼是ajax跨域

ajax跨域的原理

ajax出現請求跨域錯誤問題,主要緣由就是由於瀏覽器的「同源策略」,能夠參考

瀏覽器同源政策及其規避方法(阮一峯)

CORS請求原理

CORS是一個W3C標準,全稱是"跨域資源共享"(Cross-origin resource sharing)。它容許瀏覽器向跨源服務器,發出XMLHttpRequest請求,從而克服了AJAX只能同源使用的限制。

基本上目前全部的瀏覽器都實現了CORS標準,其實目前幾乎全部的瀏覽器ajax請求都是基於CORS機制的,只不過可能平時前端開發人員並不關心而已(因此說其實如今CORS解決方案主要是考慮後臺該如何實現的問題)。

關於CORS,強烈推薦閱讀  跨域資源共享 CORS 詳解(阮一峯)

另外,這裏也整理了一個實現原理圖(簡化版):

如何判斷是不是簡單請求?

瀏覽器將CORS請求分紅兩類:簡單請求(simple request)和非簡單請求(not-so-simple request)。只要同時知足如下兩大條件,就屬於簡單請求。

  • 請求方法是如下三種方法之一:HEAD,GET,POST

  • HTTP的頭信息不超出如下幾種字段:

    • Accept

    • Accept-Language

    • Content-Language

    • Last-Event-ID

    • Content-Type(只限於三個值application/x-www-form-urlencoded、 multipart/form-data、text/plain)

凡是不一樣時知足上面兩個條件,就屬於非簡單請求。

ajax跨域的表現

說實話,當初整理過一篇文章,而後做爲了一個解決方案,可是後來發現仍然有不少人仍是不會。無奈只能耗時又耗力的調試。然而就算是我來分析,也只會根據對應的表現來判斷是不是跨域,所以這一點是很重要的。

ajax請求時,若是存在跨域現象,而且沒有進行解決,會有以下表現:(注意,是ajax請求,請不要說爲何http請求能夠,而ajax不行,由於ajax是伴隨着跨域的,因此僅僅是http請求ok是不行的)

注意:具體的後端跨域配置請看題綱位置。

第一種現象:No 'Access-Control-Allow-Origin' header is present on the requested resource,而且The response had HTTP status code 404

出現這種狀況的緣由以下:

  • 本次ajax請求是「非簡單請求」,因此請求前會發送一次預檢請求(OPTIONS)

  • 服務器端後臺接口沒有容許OPTIONS請求,致使沒法找到對應接口地址

解決方案: 後端容許options請求

第二種現象:No 'Access-Control-Allow-Origin' header is present on the requested resource,而且The response had HTTP status code 405

這種現象和第一種有區別,這種狀況下,後臺方法容許OPTIONS請求,可是一些配置文件中(如安全配置),阻止了OPTIONS請求,纔會致使這個現象

解決方案: 後端關閉對應的安全配置

第三種現象:No 'Access-Control-Allow-Origin' header is present on the requested resource,而且status 200

這種現象和第一種和第二種有區別,這種狀況下,服務器端後臺容許OPTIONS請求,而且接口也容許OPTIONS請求,可是頭部匹配時出現不匹配現象

好比origin頭部檢查不匹配,好比少了一些頭部的支持(如常見的X-Requested-With頭部),而後服務端就會將response返回給前端,前端檢測到這個後就觸發XHR.onerror,致使前端控制檯報錯

解決方案: 後端增長對應的頭部支持

第四種現象:heade contains multiple values '*,*'

表現現象是,後臺響應的http頭部信息有兩個Access-Control-Allow-Origin:*

說實話,這種問題出現的主要緣由就是進行跨域配置的人不瞭解原理,致使了重複配置,如:

  • 常見於.net後臺(通常在web.config中配置了一次origin,而後代碼中又手動添加了一次origin(好比代碼手動設置了返回*))

  • 常見於.net後臺(在IIS和項目的webconfig中同時設置Origin:*)

解決方案(一一對應):

  • 建議刪除代碼中手動添加的*,只用項目配置中的便可

  • 建議刪除IIS下的配置*,只用項目配置中的便可

如何解決ajax跨域

通常ajax跨域解決就是經過JSONP解決或者CORS解決,如如下:(注意,如今已經幾乎不會再使用JSONP了,因此JSONP瞭解下便可)

JSONP方式解決跨域問題

jsonp解決跨域問題是一個比較古老的方案(實際中不推薦使用),這裏作簡單介紹(實際項目中若是要使用JSONP,通常會使用JQ等對JSONP進行了封裝的類庫來進行ajax請求)

實現原理

JSONP之因此可以用來解決跨域方案,主要是由於 script 腳本擁有跨域能力,而JSONP正是利用這一點來實現。具體原理如圖

實現流程

JSONP的實現步驟大體以下(參考了來源中的文章)

  • 客戶端網頁網頁經過添加一個script元素,向服務器請求JSON數據,這種作法不受同源政策限制

    function addScriptTag(src) {
      var script = document.createElement('script');
      script.setAttribute("type","text/javascript");
      script.src = src;
      document.body.appendChild(script);
    }
    
    window.onload = function () {
      addScriptTag('http://example.com/ip?callback=foo');
    }
    
    function foo(data) {
      console.log('response data: ' + JSON.stringify(data));
    };                      
        
    複製代碼

    請求時,接口地址是做爲構建出的腳本標籤的src的,這樣,當腳本標籤構建出來時,最終的src是接口返回的內容

  • 服務端對應的接口在返回參數外面添加函數包裹層

foo({
  "test": "testData"
});                     
複製代碼
  • 因爲script>元素請求的腳本,直接做爲代碼運行。這時,只要瀏覽器定義了foo函數,該函數就會當即調用。做爲參數的JSON數據被視爲JavaScript對象,而不是字符串,所以避免了使用JSON.parse的步驟。

注意,通常的JSONP接口和普通接口返回數據是有區別的,因此接口若是要作JSONO兼容,須要進行判斷是否有對應callback關鍵字參數,若是有則是JSONP請求,返回JSONP數據,不然返回普通數據

使用注意

基於JSONP的實現原理,因此JSONP只能是「GET」請求,不能進行較爲複雜的POST和其它請求,因此遇到那種狀況,就得參考下面的CORS解決跨域了(因此現在它也基本被淘汰了)

CORS解決跨域問題

CORS的原理上文中已經介紹了,這裏主要介紹的是,實際項目中,後端應該如何配置以解決問題(由於大量項目實踐都是由後端進行解決的),這裏整理了一些常見的後端解決方案:

PHP後臺配置

PHP後臺得配置幾乎是全部後臺中最爲簡單的,遵循以下步驟便可:

  • 第一步:配置Php 後臺容許跨域
<?php
header('Access-Control-Allow-Origin: *');
header('Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept');
//主要爲跨域CORS配置的兩大基本信息,Origin和headers
複製代碼
  • 第二步:配置Apache web服務器跨域(httpd.conf中)

原始代碼

<Directory />
    AllowOverride none
    Require all denied
</Directory>
複製代碼

改成如下代碼

<Directory />
    Options FollowSymLinks
    AllowOverride none
    Order deny,allow
    Allow from all
</Directory>
複製代碼

Node.js後臺配置(express框架)

Node.js的後臺也相對來講比較簡單就能夠進行配置。只需用express以下配置:

app.all('*', function(req, res, next) {
    res.header("Access-Control-Allow-Origin", "*");
    res.header("Access-Control-Allow-Headers", "X-Requested-With");
    res.header("Access-Control-Allow-Methods", "PUT,POST,GET,DELETE,OPTIONS");
    res.header("X-Powered-By", ' 3.2.1')
        //這段僅僅爲了方便返回json而已
    res.header("Content-Type", "application/json;charset=utf-8");
    if(req.method == 'OPTIONS') {
        //讓options請求快速返回
        res.sendStatus(200); 
    } else { 
        next(); 
    }
});
複製代碼

JAVA後臺配置

JAVA後臺配置只須要遵循以下步驟便可:

  • 第一步:獲取依賴jar包

    下載 cors-filter-1.7.jarjava-property-utils-1.9.jar 這兩個庫文件放到lib目錄下。(放到對應項目的webcontent/WEB-INF/lib/下)

  • 第二步:若是項目用了Maven構建的,請添加以下依賴到pom.xml中:(非maven請忽視)

<dependency>
    <groupId>com.thetransactioncompany</groupId>
    <artifactId>cors-filter</artifactId>
    <version>[ version ]</version>
</dependency>
複製代碼

其中版本應該是最新的穩定版本,CORS過濾器

  • 第三步:添加CORS配置到項目的Web.xml中( App/WEB-INF/web.xml)
<!-- 跨域配置-->    
<filter>
        <!-- The CORS filter with parameters -->
        <filter-name>CORS</filter-name>
        <filter-class>com.thetransactioncompany.cors.CORSFilter</filter-class>
        
        <!-- Note: All parameters are options, if omitted the CORS Filter will fall back to the respective default values. -->
        <init-param>
            <param-name>cors.allowGenericHttpRequests</param-name>
            <param-value>true</param-value>
        </init-param>
        
        <init-param>
            <param-name>cors.allowOrigin</param-name>
            <param-value>*</param-value>
        </init-param>
        
        <init-param>
            <param-name>cors.allowSubdomains</param-name>
            <param-value>false</param-value>
        </init-param>
        
        <init-param>
            <param-name>cors.supportedMethods</param-name>
            <param-value>GET, HEAD, POST, OPTIONS</param-value>
        </init-param>
        
        <init-param>
            <param-name>cors.supportedHeaders</param-name>
            <param-value>Accept, Origin, X-Requested-With, Content-Type, Last-Modified</param-value>
        </init-param>
        
        <init-param>
            <param-name>cors.exposedHeaders</param-name>
            <!--這裏能夠添加一些本身的暴露Headers -->
            <param-value>X-Test-1, X-Test-2</param-value>
        </init-param>
        
        <init-param>
            <param-name>cors.supportsCredentials</param-name>
            <param-value>true</param-value>
        </init-param>
        
        <init-param>
            <param-name>cors.maxAge</param-name>
            <param-value>3600</param-value>
        </init-param>

    </filter>

    <filter-mapping>
        <!-- CORS Filter mapping -->
        <filter-name>CORS</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
複製代碼

請注意,以上配置文件請放到web.xml的前面,做爲第一個filter存在(能夠有多個filter的)

  • 第四步:可能的安全模塊配置錯誤(注意,某些框架中-譬如公司私人框架,有安全模塊的,有時候這些安全模塊配置會影響跨域配置,這時候能夠先嚐試關閉它們)

NET後臺配置

.NET後臺配置能夠參考以下步驟:

  • 第一步:網站配置

打開控制面板,選擇管理工具,選擇iis;右鍵單擊本身的網站,選擇瀏覽;打開網站所在目錄,用記事本打開web.config文件添加下述配置信息,重啓網站

請注意,以上截圖較老,若是配置仍然出問題,能夠考慮增長更多的headers容許,好比:

"Access-Control-Allow-Headers":"X-Requested-With,Content-Type,Accept,Origin"            
複製代碼
  • 第二步:其它更多配置,若是第一步進行了後,仍然有跨域問題,多是:

    • 接口中有限制死一些請求類型(好比寫死了POST等),這時候請去除限 制

    • 接口中,重複配置了Origin:*,請去除便可

    • IIS服務器中,重複配置了Origin:*,請去除便可

代理請求方式解決接口跨域問題

注意,因爲接口代理是有代價的,因此這個僅是開發過程當中進行的。

與前面的方法不一樣,前面CORS是後端解決,而這個主要是前端對接口進行代理,也就是:

  • 前端ajax請求的是本地接口

  • 本地接口接收到請求後向實際的接口請求數據,而後再將信息返回給前端

  • 通常用node.js便可代理

關於如何實現代理,這裏就不重點描述了,方法和多,也不難,基本都是基於node.js的。

搜索關鍵字node.js,代理請求便可找到一大票的方案。

如何分析ajax跨域

上述已經介紹了跨域的原理以及如何解決,但實際過程當中,發現仍然有不少人對照着相似的文檔沒法解決跨域問題,主要體如今,前端人員不知道何時是跨域問題形成的,何時不是,所以這裏稍微介紹下如何分析一個請求是否跨域:

抓包請求數據

第一步固然是得知道咱們的ajax請求發送了什麼數據,接收了什麼,作到這一步並不難,也不須要fiddler等工具,僅基於Chrome便可

  • Chrome瀏覽器打開對應發生ajax的頁面,F12打開Dev Tools

  • 發送ajax請求

  • 右側面板->NetWork->XHR,而後找到剛纔的ajax請求,點進去

示例一(正常的ajax請求)

上述請求是一個正確的請求,爲了方便,我把每個頭域的意思都代表了,咱們能夠清晰的看到,接口返回的響應頭域中,包括了

Access-Control-Allow-Headers: X-Requested-With,Content-Type,Accept
Access-Control-Allow-Methods: Get,Post,Put,OPTIONS
Access-Control-Allow-Origin: *
複製代碼

因此瀏覽器接收到響應時,判斷的是正確的請求,天然不會報錯,成功的拿到了響應數據。

示例二(跨域錯誤的ajax請求)

爲了方便,咱們仍然拿上面的錯誤表現示例舉例。

這個請求中,接口Allow裏面沒有包括OPTIONS,因此請求出現了跨域、

這個請求中, Access-Control-Allow-Origin: *出現了兩次,致使了跨域配置沒有正確配置,出現了錯誤。

更多跨域錯誤基本都是相似的,就是以上三樣沒有知足(Headers,Allow,Origin),這裏再也不一一贅述。

示例三(與跨域無關的ajax請求)

固然,也並非全部的ajax請求錯誤都與跨域有關,因此請不要混淆,好比如下:

好比這個請求,它的跨域配置沒有一點問題,它出錯僅僅是由於request的Accept和response的Content-Type不匹配而已。

更多

基本上都是這樣去分析一個ajax請求,經過Chrome就能夠知道了發送了什麼數據,收到了什麼數據,而後再一一比對就知道問題何在了。

寫在最後的話

跨域是一個老生常談的話題,網上也有大量跨域的資料,而且有很多精品(好比阮一峯前輩的),可是身爲一個前端人員不該該淺嘗而止,故而纔有了本文。

漫漫前端路,望與諸君共勉之!

附錄

參考資料

博客

初次發佈2017.03.22於我的博客

想了想,最終只搬了一篇過來了,其它的在我的博客中

相關文章
相關標籤/搜索