天天看點
傳回

ajax 跨域----好用的解決方案

一、前言 

跨域這個詞就一直以很高的頻率在身邊重複出現，一直到現在，已經調試過N個跨域相關的問題了!

但是感覺還是差了點什麼，于是現在重新梳理了一下。個人見識有限，如有差錯，請多多見諒

二、前言

關于跨域，有N種類型，本文隻專注于

ajax請求跨域

(ajax跨域隻是屬于浏覽器"同源政策"中的一部分，其它的還有Cookie跨域iframe跨域，LocalStorage跨域等這裡不做介紹)，内容大概如下：

  • 什麼是ajax跨域
  • 原理
  • 表現(整理了一些遇到的問題以及解決方案)
  • 如何解決ajax跨域
  • JSONP方式
  • CORS方式
  • 代理請求方式
  • 如何分析ajax跨域
  • http抓包的分析
  • 一些示例

ajax跨域的原理

ajax出現請求跨域錯誤問題,主要原因就是因為浏覽器的“同源政策”,可以參考

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

CORS請求原理

CORS是一個W3C标準，全稱是"跨域資源共享"（Cross-origin resource sharing）。它允許浏覽器向跨源伺服器，發出XMLHttpRequest請求，進而克服了AJAX隻能同源使用的限制。

基本上目前所有的浏覽器都實作了CORS标準,其實目前幾乎所有的浏覽器ajax請求都是基于CORS機制的,隻不過可能平時前端開發人員并不關心而已(是以說其實作在CORS解決方案主要是考慮背景該如何實作的問題)。

ajax 跨域----好用的解決方案

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

浏覽器将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'headerispresent on the requested resource

,并且

Theresponse had HTTP status code404
ajax 跨域----好用的解決方案

出現這種情況的原因如下：

  • 本次ajax請求是“非簡單請求”,是以請求前會發送一次預檢請求(OPTIONS)
  • 伺服器端背景接口沒有允許OPTIONS請求,導緻無法找到對應接口位址

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

第二種現象

No'Access-Control-Allow-Origin'headerispresent on the requested resource

Theresponse had HTTP status code405

這種現象和第一種有差別,這種情況下，背景方法允許OPTIONS請求,但是一些配置檔案中(如

安全配置

),阻止了OPTIONS請求,才會導緻這個現象

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

第三種現象

No'Access-Control-Allow-Origin'headerispresent on the requested resource

status200

這種現象和第一種和第二種有差別,這種情況下，伺服器端背景允許OPTIONS請求,并且接口也允許OPTIONS請求,但是頭部比對時出現不比對現象

比如origin頭部檢查不比對,比如少了一些頭部的支援(如常見的X-Requested-With頭部),然後服務端就會将response傳回給前端,前端檢測到這個後就觸發XHR.onerror,導緻前端控制台報錯

解決方案：後端增加對應的頭部支援

第四種現象

heade contains multiple values'*,*'
ajax 跨域----好用的解決方案
ajax 跨域----好用的解決方案

表現現象是，背景響應的http頭部資訊有兩個

Access-Control-Allow-Origin:*

說實話，這種問題出現的主要原因就是進行跨域配置的人不了解原理，導緻了重複配置，如：

  • 常見于.net背景(一般在web.config中配置了一次origin,然後代碼中又手動添加了一次origin(比如代碼手動設定了傳回*))
  • 常見于.net背景(在IIS和項目的webconfig中同時設定Origin:*)

解決方案(一一對應):

  • 建議删除代碼中手動添加的*，隻用項目配置中的即可
  • 建議删除IIS下的配置*，隻用項目配置中的即可

一般ajax跨域解決就是通過JSONP解決或者CORS解決,如以下:(注意，現在已經幾乎不會再使用JSONP了，是以JSONP了解下即可)

JSONP方式解決跨域問題

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

實作原理

JSONP之是以能夠用來解決跨域方案,主要是因為

<script>

腳本擁有跨域能力,而JSONP正是利用這一點來實作。具體原理如圖

ajax 跨域----好用的解決方案

實作流程

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

原始代碼

  1. <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.jar, java-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檔案添加下述配置資訊,重新開機網站

ajax 跨域----好用的解決方案

請注意,以上截圖較老,如果配置仍然出問題,可以考慮增加更多的headers允許,比如:

  1. "Access-Control-Allow-Headers":"X-Requested-With,Content-Type,Accept,Origin"            

第二步：其它更多配置，如果第一步進行了後，仍然有跨域問題，可能是

  • 接口中有限制死一些請求類型(比如寫死了POST等)，這時候請去除限 制
  • 接口中，重複配置了 

    Origin:*

     ，請去除即可
  • IIS伺服器中，重複配置了 

    Origin:*

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

注意，由于接口代理是有代價的，是以這個僅是開發過程中進行的。

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

  • 前端ajax請求的是本地接口
  • 本地接口接收到請求後向實際的接口請求資料，然後再将資訊傳回給前端
  • 一般用node.js即可代理

關于如何實作代理，這裡就不重點描述了，方法和多，也不難，基本都是基于node.js的。

搜尋關鍵字

node.js

,

代理請求

即可找到一大票的方案。

上述已經介紹了跨域的原理以及如何解決，但實際過程中，發現仍然有很多人對照着類似的文檔無法解決跨域問題，主要展現在，前端人員不知道什麼時候是跨域問題造成的，什麼時候不是，是以這裡稍微介紹下如何分析一個請求是否跨域:

抓包請求資料

第一步當然是得知道我們的ajax請求發送了什麼資料，接收了什麼，做到這一步并不難，也不需要

fiddler

等工具，僅基于

Chrome

即可

  • Chrome

     浏覽器打開對應發生ajax的頁面， 

    F12

     打開 

    DevTools
  • 發送ajax請求
  • 右側面闆-> 

    NetWork

     -> 

    XHR

     ，然後找到剛才的ajax請求，點進去

示例一(正常的ajax請求)

ajax 跨域----好用的解決方案

上述請求是一個正确的請求，為了友善，我把每一個頭域的意思都表明了，我們可以清晰的看到，接口傳回的響應頭域中，包括了

  1. Access-Control-Allow-Headers: X-Requested-With,Content-Type,Accept

  2. Access-Control-Allow-Methods: Get,Post,Put,OPTIONS

  3. Access-Control-Allow-Origin: *

是以浏覽器接收到響應時，判斷的是正确的請求，自然不會報錯，成功的拿到了響應資料。

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

為了友善，我們仍然拿上面的錯誤表現示例舉例。

ajax 跨域----好用的解決方案

這個請求中，接口Allow裡面沒有包括

OPTIONS

，是以請求出現了跨域、

ajax 跨域----好用的解決方案

這個請求中，

Access-Control-Allow-Origin:*

出現了兩次，導緻了跨域配置沒有正确配置，出現了錯誤。

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

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

當然，也并不是所有的ajax請求錯誤都與跨域有關，是以請不要混淆，比如以下:

ajax 跨域----好用的解決方案
ajax 跨域----好用的解決方案

比如這個請求，它的跨域配置沒有一點問題，它出錯僅僅是因為request的

Accept

和response的

Content-Type

不比對而已。

寫在最後的話

跨域是一個老生常談的話題，網上也有大量跨域的資料，并且有不少精品(比如阮一峰前輩的)，但是身為一個前端人員不應該淺嘗而止，故而才有了本文。

漫漫前端路，望與諸君共勉之！

來自：撒網要見魚

https://segmentfault.com/a/1190000012469713

Web App開發 前端開發 javascript 安全 java 資料格式 json php Maven apache ajax跨域 ajax跨域調用 問題ajax跨域 ajax跨域問題 ajax完美解決跨域
上一篇: Android 滑動定位+吸附懸停效果實作
下一篇: 圖書管理系統

繼續閱讀