作者:Neal_yang github.com/Nealyang/YOU-SHOULD-KNOW-JS/blob/master/doc/basic_js/JavaScript中的跨域總結.md 前端開發中,跨域使我們經常遇到的一個問題,也是面試中經常被問到的一些問題,所以,這裡,我們做個總結。小小問 ...
作者:Neal_yang
github.com/Nealyang/YOU-SHOULD-KNOW-JS/blob/master/doc/basic_js/JavaScript中的跨域總結.md
前端開發中,跨域使我們經常遇到的一個問題,也是面試中經常被問到的一些問題,所以,這裡,我們做個總結。小小問題,不足擔心
什麼是跨域
跨域,是指瀏覽器不能執行其他網站的腳本。它是由瀏覽器的同源策略造成的,是瀏覽器對JavaScript實施的安全限制。
同源策略限制了一下行為:
-
Cookie、LocalStorage 和 IndexDB 無法讀取
-
DOM 和 JS 對象無法獲取
-
Ajax請求發送不出去
常見的跨域場景
所謂的同源是指,功能變數名稱、協議、埠均為相同。
http://www.nealyang.cn/index.html 調用 http://www.nealyang.cn/server.php 非跨域
http://www.nealyang.cn/index.html 調用 http://www.neal.cn/server.php 跨域,主域不同
http://abc.nealyang.cn/index.html 調用 http://def.neal.cn/server.php 跨域,子功能變數名稱不同
http://www.nealyang.cn:8080/index.html 調用 http://www.nealyang.cn/server.php 跨域,埠不同
https://www.nealyang.cn/index.html 調用 http://www.nealyang.cn/server.php 跨域,協議不同
localhost 調用 127.0.0.1 跨域
跨域的解決辦法
jsonp跨域
jsonp跨域其實也是JavaScript設計模式中的一種代理模式。在html頁面中通過相應的標簽從不同功能變數名稱下載入靜態資源文件是被瀏覽器允許的,所以我們可以通過這個“犯罪漏洞”來進行跨域。一般,我們可以動態的創建script標簽,再去請求一個帶參網址來實現跨域通信
//原生的實現方式
let script = document.createElement('script');
script.src = 'http://www.nealyang.cn/login?username=Nealyang&callback=callback';
document.body.appendChild(script);
function callback(res) {
console.log(res);
}
當然,jquery也支持jsonp的實現方式
$.ajax({
url:'http://www.nealyang.cn/login',
type:'GET',
dataType:'jsonp',//請求方式為jsonp
jsonpCallback:'callback',
data:{
"username":"Nealyang"
}
})
雖然這種方式非常好用,但是一個最大的缺陷是,只能夠實現get請求
document.domain + iframe 跨域
這種跨域的方式最主要的是要求主功能變數名稱相同。什麼是主功能變數名稱相同呢? www.nealyang.cn aaa.nealyang.cn ba.ad.nealyang.cn 這三個主功能變數名稱都是nealyang.cn,而主功能變數名稱不同的就不能用此方法。
假設目前a.nealyang.cn 和 b.nealyang.cn 分別對應指向不同ip的伺服器。
a.nealyang.cn 下有一個test.html文件
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>html</title>
<script type="text/javascript" src = "jquery-1.12.1.js"></script>
</head>
<body>
<div>A頁面</div>
<iframe
style = "display : none"
name = "iframe1"
id = "iframe"
src="http://b.nealyang.cn/1.html" frameborder="0"></iframe>
<script type="text/javascript">
$(function(){
try{
document.domain = "nealyang.cn"
}catch(e){}
$("#iframe").load(function(){
var jq = document.getElementById('iframe').contentWindow.$
jq.get("http://nealyang.cn/test.json",function(data){
console.log(data);
});
})
})
</script>
</body>
</html>
利用 iframe 載入 其他域下的文件(nealyang.cn/1.html), 同時 document.domain 設置成 nealyang.cn ,當 iframe 載入完畢後就可以獲取 nealyang.cn 域下的全局對象, 此時嘗試著去請求 nealyang.cn 功能變數名稱下的 test.json (此時可以請求介面),就會發現數據請求失敗了~~ 驚不驚喜,意不意外!!!!!!!
數據請求失敗,目的沒有達到,自然是還少一步:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>html</title>
<script type="text/javascript" src = "jquery-1.12.1.js"></script>
<script type="text/javascript">
$(function(){
try{
document.domain = "nealyang.com"
}catch(e){}
})
</script>
</head>
<body>
<div id = "div1">B頁面</div>
</body>
</html>
此時在進行刷新瀏覽器,就會發現數據這次真的是成功了
window.name + iframe 跨域
window.name屬性可設置或者返回存放視窗名稱的一個字元串。他的神器之處在於name值在不同頁面或者不同域下載入後依舊存在,沒有修改就不會發生變化,並且可以存儲非常長的name(2MB)
假設index頁面請求遠端伺服器上的數據,我們在該頁面下創建iframe標簽,該iframe的src指向伺服器文件的地址(iframe標簽src可以跨域),伺服器文件里設置好window.name的值,然後再在index.html裡面讀取改iframe中的window.name的值。完美~
<body>
<script type="text/javascript">
iframe = document.createElement('iframe'),
iframe.src = 'http://localhost:8080/data.php';
document.body.appendChild(iframe);
iframe.onload = function() {
console.log(iframe.contentWindow.name)
};
</script>
</body>
當然,這樣還是不夠的。
因為規定如果index.html頁面和和該頁面里的iframe框架的src如果不同源,則也無法操作框架里的任何東西,所以就取不到iframe框架的name值了,告訴你我們不是一家的,你也休想得到我這裡的數據。 既然要同源,那就換個src去指,前面說了無論怎樣載入window.name值都不會變化,於是我們在index.html相同目錄下,新建了個proxy.html的空頁面,修改代碼如下:
<body>
<script type="text/javascript">
iframe = document.createElement('iframe'),
iframe.src = 'http://localhost:8080/data.php';
document.body.appendChild(iframe);
iframe.onload = function() {
iframe.src = 'http://localhost:81/cross-domain/proxy.html';
console.log(iframe.contentWindow.name)
};
</script>
</body>
理想似乎很美好,在iframe載入過程中,迅速重置iframe.src的指向,使之與index.html同源,那麼index頁面就能去獲取它的name值了!但是現實是殘酷的,iframe在現實中的表現是一直不停地刷新, 也很好理解,每次觸發onload時間後,重置src,相當於重新載入頁面,又觸發onload事件,於是就不停地刷新了(但是需要的數據還是能輸出的)。修改後代碼如下:
<body>
<script type="text/javascript">
iframe = document.createElement('iframe');
iframe.style.display = 'none';
var state = 0;
iframe.onload = function() {
if(state === 1) {
var data = JSON.parse(iframe.contentWindow.name);
console.log(data);
iframe.contentWindow.document.write('');
iframe.contentWindow.close();
document.body.removeChild(iframe);
} else if(state === 0) {
state = 1;
iframe.contentWindow.location = 'http://localhost:81/cross-domain/proxy.html';
}
};
iframe.src = 'http://localhost:8080/data.php';
document.body.appendChild(iframe);
</script>
</body>
所以如上,我們就拿到了伺服器返回的數據,但是有幾個條件是必不可少的:
-
iframe標簽的跨域能力
-
window.names屬性值在文檔刷新後依然存在的能力
location.hash + iframe 跨域
此跨域方法和上面介紹的比較類似,一樣是動態插入一個iframe然後設置其src為服務端地址,而服務端同樣輸出一端js代碼,也同時通過與子視窗之間的通信來完成數據的傳輸。
關於錨點相信大家都已經知道了,其實就是設置錨點,讓文檔指定的相應的位置。錨點的設置用a標簽,然後href指向要跳轉到的id,當然,前提是你得有個滾動條,不然也不好滾動嘛是吧。
而location.hash其實就是url的錨點。比如http://www.nealyang.cn#Nealyang的網址打開後,在控制台輸入location.hash就會返回#Nealyang的欄位。
基礎知識補充完畢,下麵我們來說下如何實現跨域
如果index頁面要獲取遠端伺服器的數據,動態的插入一個iframe,將iframe的src執行伺服器的地址,這時候的top window 和包裹這個iframe的子視窗是不能通信的,因為同源策略,所以改變子視窗的路徑就可以了,將數據當做改變後的路徑的hash值載入路徑上,然後就可以通信了。將數據加在index頁面地址的hash上, index頁面監聽hash的變化,h5的hashchange方法
<body>
<script type="text/javascript">
function getData(url, fn) {
var iframe = document.createElement('iframe');
iframe.style.display = 'none';
iframe.src = url;
iframe.onload = function() {
fn(iframe.contentWindow.location.hash.substring(1));
window.location.hash = '';
document.body.removeChild(iframe);
};
document.body.appendChild(iframe);
}
// get data from server
var url = 'http://localhost:8080/data.php';
getData(url, function(data) {
var jsondata = JSON.parse(data);
console.log(jsondata.name + ' ' + jsondata.age);
});
</script>
</body>
補充說明:其實location.hash和window.name都是差不多的,都是利用全局對象屬性的方法,然後這兩種方法和jsonp也是一樣的,就是只能夠實現get請求
postMessage跨域
這是由H5提出來的一個炫酷的API,IE8+,chrome,ff都已經支持實現了這個功能。這個功能也是非常的簡單,其中包括接受信息的Message時間,和發送信息的postMessage方法。
發送信息的postMessage方法是向外界視窗發送信息
otherWindow.postMessage(message,targetOrigin);
otherWindow指的是目標視窗,也就是要給哪一個window發送消息,是window.frames屬性的成員或者是window.open方法創建的視窗。 Message是要發送的消息,類型為String,Object(IE8、9不支持Obj),targetOrigin是限定消息接受範圍,不限制就用星號 *
接受信息的message事件
var onmessage = function(event) {
var data = event.data;
var origin = event.origin;
}
if(typeof window.addEventListener != 'undefined'){
window.addEventListener('message',onmessage,false);
}else if(typeof window.attachEvent != 'undefined'){
window.attachEvent('onmessage', onmessage);
}
舉個慄子
a.html(http://www.nealyang.cn/a.html)
<iframe id="iframe" src="http://www.neal.cn/b.html" style="display:none;"></iframe>
<script>
var iframe = document.getElementById('iframe');
iframe.onload = function() {
var data = {
name: 'aym'
};
// 向neal傳送跨域數據
iframe.contentWindow.postMessage(JSON.stringify(data), 'http://www.neal.cn');
};
// 接受domain2返回數據
window.addEventListener('message', function(e) {
alert('data from neal ---> ' + e.data);
}, false);
</script>
b.html(http://www.neal.cn/b.html)
<script>
// 接收domain1的數據
window.addEventListener('message', function(e) {
alert('data from nealyang ---> ' + e.data);
var data = JSON.parse(e.data);
if (data) {
data.number = 16;
// 處理後再發回nealyang
window.parent.postMessage(JSON.stringify(data), 'http://www.nealyang.cn');
}
}, false);
</script>
跨域資源共用 CORS
因為是目前主流的跨域解決方案。所以這裡多介紹點。
簡介
CORS是一個W3C標準,全稱是"跨域資源共用"(Cross-origin resource sharing)。 它允許瀏覽器向跨源伺服器,發出XMLHttpRequest請求,從而剋服了AJAX只能同源使用的限制。
CORS需要瀏覽器和伺服器同時支持。目前,所有瀏覽器都支持該功能,IE瀏覽器不能低於IE10。IE8+:IE8/9需要使用XDomainRequest對象來支持CORS。
整個CORS通信過程,都是瀏覽器自動完成,不需要用戶參與。對於開發者來說,CORS通信與同源的AJAX通信沒有差別,代碼完全一樣。瀏覽器一旦發現AJAX請求跨源,就會自動添加一些附加的頭信息,有時還會多出一次附加的請求,但用戶不會有感覺。 因此,實現CORS通信的關鍵是伺服器。只要伺服器實現了CORS介面,就可以跨源通信。
兩種請求
說起來很搞笑,分為兩種請求,一種是簡單請求,另一種是非簡單請求。只要滿足下麵條件就是簡單請求
-
請求方式為HEAD、POST 或者 GET
-
http頭信息不超出一下欄位:Accept、Accept-Language 、 Content-Language、 Last-Event-ID、 Content-Type(限於三個值:application/x-www-form-urlencoded、multipart/form-data、text/plain)
為什麼要分為簡單請求和非簡單請求,因為瀏覽器對這兩種請求方式的處理方式是不同的。
簡單請求
基本流程
對於簡單請求,瀏覽器直接發出CORS請求。具體來說,就是在頭信息之中,增加一個Origin欄位。 下麵是一個例子,瀏覽器發現這次跨源AJAX請求是簡單請求,就自動在頭信息之中,添加一個Origin欄位。
GET /cors HTTP/1.1
Origin: http://api.bob.com
Host: api.alice.com
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0
...
Origin欄位用來說明,本次請求來自哪個源(協議 + 功能變數名稱 + 埠)。伺服器根據這個值,決定是否同意這次請求。
如果Origin指定的源,不在許可範圍內,伺服器會返回一個正常的HTTP回應。 瀏覽器發現,這個回應的頭信息沒有包含Access-Control-Allow-Origin欄位(詳見下文),就知道出錯了,從而拋出一個錯誤,被XMLHttpRequest的onerror回調函數捕獲。
註意,這種錯誤無法通過狀態碼識別,因為HTTP回應的狀態碼有可能是200。
如果Origin指定的功能變數名稱在許可範圍內,伺服器返回的響應,會多出幾個頭信息欄位。
Access-Control-Allow-Origin: http://api.bob.com
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: FooBar
Content-Type: text/html; charset=utf-8
上面的頭信息之中,有三個與CORS請求相關的欄位,都以Access-Control-開頭
-
Access-Control-Allow-Origin :該欄位是必須的。它的值要麼是請求時Origin欄位的值,要麼是一個*,表示接受任意功能變數名稱的請求
-
Access-Control-Allow-Credentials: 該欄位可選。它的值是一個布爾值,表示是否允許發送Cookie。預設情況下,Cookie不包括在CORS請求之中。設為true,即表示伺服器明確許可,Cookie可以包含在請求中,一起發給伺服器。這個值也只能設為true,如果伺服器不要瀏覽器發送Cookie,刪除該欄位即可。
-
Access-Control-Expose-Headers:該欄位可選。CORS請求時,XMLHttpRequest對象的getResponseHeader()方法只能拿到6個基本欄位:Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma。如果想拿到其他欄位,就必須在Access-Control-Expose-Headers裡面指定。
withCredentials 屬性
上面說到,CORS請求預設不發送Cookie和HTTP認證信息。如果要把Cookie發到伺服器,一方面要伺服器同意,指定Access-Control-Allow-Credentials欄位。
另一方面,開發者必須在AJAX請求中打開withCredentials屬性。
var xhr = new XMLHttpRequest(); // IE8/9需用window.XDomainRequest相容
// 前端設置是否帶cookie
xhr.withCredentials = true;
xhr.open('post', 'http://www.domain2.com:8080/login', true);
xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
xhr.send('user=admin');
xhr.onreadystatechange = function() {
if (xhr.readyState == 4 && xhr.status == 200) {
alert(xhr.responseText);
}
};
// jquery
$.ajax({
...
xhrFields: {
withCredentials: true // 前端設置是否帶cookie
},
crossDomain: true, // 會讓請求頭中包含跨域的額外信息,但不會含cookie
...
});
否則,即使伺服器同意發送Cookie,瀏覽器也不會發送。或者,伺服器要求設置Cookie,瀏覽器也不會處理。 但是,如果省略withCredentials設置,有的瀏覽器還是會一起發送Cookie。這時,可以顯式關閉withCredentials。
需要註意的是,如果要發送Cookie,Access-Control-Allow-Origin就不能設為星號,必須指定明確的、與請求網頁一致的功能變數名稱。同時,Cookie依然遵循同源政策,只有用伺服器功能變數名稱設置的Cookie才會上傳,其他功能變數名稱的Cookie並不會上傳,且(跨源)原網頁代碼中的document.cookie也無法讀取伺服器功能變數名稱下的Cookie。
非簡單請求
非簡單請求是那種對伺服器有特殊要求的請求,比如請求方法是PUT或DELETE,或者Content-Type欄位的類型是application/json。
非簡單請求的CORS請求,會在正式通信之前,增加一次HTTP查詢請求,稱為"預檢"請求(preflight)。
瀏覽器先詢問伺服器,當前網頁所在的功能變數名稱是否在伺服器的許可名單之中,以及可以使用哪些HTTP動詞和頭信息欄位。只有得到肯定答覆,瀏覽器才會發出正式的XMLHttpRequest請求,否則就報錯。
var url = 'http://api.alice.com/cors';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url, true);
xhr.setRequestHeader('X-Custom-Header', 'value');
xhr.send();
瀏覽器發現,這是一個非簡單請求,就自動發出一個"預檢"請求,要求伺服器確認可以這樣請求。下麵是這個"預檢"請求的HTTP頭信息。
OPTIONS /cors HTTP/1.1
Origin: http://api.bob.com
Access-Control-Request-Method: PUT
Access-Control-Request-Headers: X-Custom-Header
Host: api.alice.com
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...
"預檢"請求用的請求方法是OPTIONS,表示這個請求是用來詢問的。頭信息裡面,關鍵欄位是Origin,表示請求來自哪個源。
除了Origin欄位,"預檢"請求的頭信息包括兩個特殊欄位。
-
Access-Control-Request-Method:該欄位是必須的,用來列出瀏覽器的CORS請求會用到哪些HTTP方法,上例是PUT。
-
Access-Control-Request-Headers:該欄位是一個逗號分隔的字元串,指定瀏覽器CORS請求會額外發送的頭信息欄位,上例是X-Custom-Header
預檢請求的回應
伺服器收到"預檢"請求以後,檢查了Origin、Access-Control-Request-Method和Access-Control-Request-Headers欄位以後,確認允許跨源請求,就可以做出回應
HTTP/1.1 200 OK
Date: Mon, 01 Dec 2008 01:15:39 GMT
Server: Apache/2.0.61 (Unix)
Access-Control-Allow-Origin: http://api.bob.com
Access-Control-Allow-Methods: GET, POST, PUT
Access-Control-Allow-Headers: X-Custom-Header
Content-Type: text/html; charset=utf-8
Content-Encoding: gzip
Content-Length: 0
Keep-Alive: timeout=2, max=100
Connection: Keep-Alive
Content-Type: text/plain
上面的HTTP回應中,關鍵的是Access-Control-Allow-Origin欄位,表示http://api.bob.com可以請求數據。該欄位也可以設為星號,表示同意任意跨源請求。
如果瀏覽器否定了"預檢"請求,會返回一個正常的HTTP回應,但是沒有任何CORS相關的頭信息欄位。這時,瀏覽器就會認定,伺服器不同意預檢請求,因此觸發一個錯誤,被XMLHttpRequest對象的onerror回調函數捕獲。控制台會列印出如下的報錯信息。
伺服器回應的其他CORS相關欄位如下:
Access-Control-Allow-Methods: GET, POST, PUT
Access-Control-Allow-Headers: X-Custom-Header
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 1728000
-
Access-Control-Allow-Methods:該欄位必需,它的值是逗號分隔的一個字元串,表明伺服器支持的所有跨域請求的方法。註意,返回的是所有支持的方法,而不單是瀏覽器請求的那個方法。這是為了避免多次"預檢"請求。
-
Access-Control-Allow-Headers:如果瀏覽器請求包括Access-Control-Request-Headers欄位,則Access-Control-Allow-Headers欄位是必需的。它也是一個逗號分隔的字元串,表明伺服器支持的所有頭信息欄位,不限於瀏覽器在"預檢"中請求的欄位。
-
Access-Control-Allow-Credentials: 該欄位與簡單請求時的含義相同。
-
Access-Control-Max-Age: 該欄位可選,用來指定本次預檢請求的有效期,單位為秒。上面結果中,有效期是20天(1728000秒),即允許緩存該條回應1728000秒(即20天),在此期間,不用發出另一條預檢請求。
瀏覽器正常請求回應
一旦伺服器通過了"預檢"請求,以後每次瀏覽器正常的CORS請求,就都跟簡單請求一樣,會有一個Origin頭信息欄位。伺服器的回應,也都會有一個Access-Control-Allow-Origin頭信息欄位。
PUT /cors HTTP/1.1
Origin: http://api.bob.com
Host: api.alice.com
X-Custom-Header: value
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...
瀏覽器的正常CORS請求。上面頭信息的Origin欄位是瀏覽器自動添加的。下麵是伺服器正常的回應。
Access-Control-Allow-Origin: http://api.bob.com
Content-Type: text/html; charset=utf-8
Access-Control-Allow-Origin欄位是每次回應都必定包含的
結束語
CORS與JSONP的使用目的相同,但是比JSONP更強大。JSONP只支持GET請求,CORS支持所有類型的HTTP請求。JSONP的優勢在於支持老式瀏覽器,以及可以向不支持CORS的網站請求數據。
WebSocket協議跨域
WebSocket protocol是HTML5一種新的協議。它實現了瀏覽器與伺服器全雙工通信,同時允許跨域通訊,是server push技術的一種很好的實現。
原生WebSocket API使用起來不太方便,我們使用Socket.io,它很好地封裝了webSocket介面,提供了更簡單、靈活的介面,也對不支持webSocket的瀏覽器提供了向下相容。
前端代碼:
<div>user input:<input type="text"></div>
<script src="./socket.io.js"></script>
<script>
var socket = io('http://www.domain2.com:8080');
// 連接成功處理
socket.on('connect', function() {
// 監聽服務端消息
socket.on('message', function(msg) {
console.log('data from server: ---> ' + msg);
});
// 監聽服務端關閉
socket.on('disconnect', function() {
console.log('Server socket has closed.');
});
});
document.getElementsByTagName('input')[0].onblur = function() {
socket.send(this.value);
};
</script>
node Server
var http = require('http');
var socket = require('socket.io');
// 啟http服務
var server = http.createServer(function(req, res) {
res.writeHead(200, {
'Content-type': 'text/html'
});
res.end();
});
server.listen('8080');
console.log('Server is running at port 8080...');
// 監聽socket連接
socket.listen(server).on('connection', function(client) {
// 接收信息
client.on('message', function(msg) {
client.send('hello:' + msg);
console.log('data from client: ---> ' + msg);
});
// 斷開處理
client.on('disconnect', function() {
console.log('Client socket has closed.');
});
});
node代理跨域
node中間件實現跨域代理,是通過啟一個代理伺服器,實現數據的轉發,也可以通過設置cookieDomainRewrite參數修改響應頭中cookie中功能變數名稱,實現當前域的cookie寫入,方便介面登錄認證。
利用node + express + http-proxy-middleware搭建一個proxy伺服器
前端代碼
var xhr = new XMLHttpRequest();
// 前端開關:瀏覽器是否讀寫cookie
xhr.withCredentials = true;
// 訪問http-proxy-middleware代理伺服器
xhr.open('get', 'http://www.domain1.com:3000/login?user=admin', true);
xhr.send();
後端代碼
var express = require('express');
var proxy = require('http-proxy-middleware');
var app = express();
app.use('/', proxy({
// 代理跨域目標介面
target: 'http://www.domain2.com:8080',
changeOrigin: true,
// 修改響應頭信息,實現跨域並允許帶cookie
onProxyRes: function(proxyRes, req, res) {
res.header('Access-Control-Allow-Origin', 'http://www.domain1.com');
res.header('Access-Control-Allow-Credentials', 'true');
},
// 修改響應信息中的cookie功能變數名稱
cookieDomainRewrite: 'www.domain1.com' // 可以為false,表示不修改
}));
app.listen(3000);
console.log('Proxy server is listen at port 3000...');
nginx代理跨域
NGINX其實個人沒有怎麼玩過,所以暫且也就不能誤人子弟了,原諒筆者才疏尚淺~ 有機會學習研究再回來補充~~
參考文檔
http://www.ruanyifeng.com/blog/2016/04/cors.html
https://segmentfault.com/a/1190000011145364