CORS和JSONP

JSONP和CORS

跨域的基本概念

• 瀏覽器爲了一定的安全因素，增加了同源策略。有違同源策略的操作都是被禁止的，這個時候就會發生我們所說的跨域。
• 但其實瀏覽器加載的資源很多都是跨域的，只是有些資源的加載瀏覽器是允許的。
• 圖片（img）、CSS、Script等資源是不受同源策略限制的。
  -我們所說的跨域主要說的是ajax請求無法完成。

跨域解決方案

JSONP

• JSONP的優點就是因爲他夠老，能兼容各種瀏覽器，無兼容問題。
• 他發送的不是ajax請求，而是利用了script標籤加載機制。
• JSONP缺點：只支持get，而且存在安全問題。
• 技術發展至今，jsonp這種前後端耦合的方式肯定要被代替。

CORS跨域解決方案

• CORS從具體的代碼實現上來說比較方便，前端幾乎不需要寫任何代碼就可以支持。主要是靠服務端進行配置。
• CORS需要瀏覽器和服務器同時支持。目前所有瀏覽器都支持該功能，IE瀏覽器不能低於IE10。
• 整個CORS通信過程，都是瀏覽器自動完成，不需要用戶參與。對於開發者來說，CORS通信與同源的AJAX通信沒有差別，代碼完全一樣。
• 瀏覽器一旦發現AJAX請求跨源，就會自動添加一些附加的頭信息，有時還會多出一次附加的請求，但用戶不會有感覺。
• 因此，實現CORS通信的關鍵是服務器。只要服務器實現了CORS接口，就可以跨源通信。

CORS的兩種請求

• 瀏覽器將CORS請求分成兩類：簡單請求（simple request）和非簡單請求（預檢請求）（not-so-simple request）。

只要同時滿足以下兩大條件，就屬於簡單請求。

1. 請求方法是以下三種方法之一：

• HEAD
• GET
• POST

2. HTTP請求頭信息不超出以下幾種字段：

• Accept

• Accept-Language

• Content-Language

• Last-Event-ID

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

• 凡是不同時滿足上面兩個條件，就屬於非簡單請求。

• 瀏覽器對這兩種請求的處理，是不一樣的。

1.CORS的簡單請求

• 對於簡單請求，瀏覽器直接發出CORS請求。具體來說，就是在頭信息之中，增加一個Origin字段。
• 下面是一個例子，瀏覽器發現這次跨源AJAX請求是簡單請求，就自動在頭信息之中，添加一個Origin字段。

GET /cors HTTP/1.1 
Origin: http://m.xin.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-開頭。

1. Access-Control-Allow-Origin

• 該字段是必須的。它的值要麼是請求時Origin字段的值，要麼是一個*，表示接受任意域名的請求。

2. Access-Control-Allow-Credentials

• 該字段可選。它的值是一個布爾值，表示是否允許發送Cookie。默認情況下，Cookie不包括在CORS請求之中。設爲true，即表示服務器明確許可，Cookie可以包含在請求中，一起發給服務器。這個值也只能設爲true，如果服務器不要瀏覽器發送Cookie，刪除該字段即可。

3. Access-Control-Expose-Headers

• 該字段可選。CORS請求時，XMLHttpRequest對象的getResponseHeader()方法只能拿到6個基本字段：Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma。如果想拿到其他字段，就必須在Access-Control-Expose-Headers裏面指定。上面的例子指定，getResponseHeader(‘FooBar’)可以返回FooBar字段的值。

withCredentials 屬性

• 上面說到，CORS請求默認不發送Cookie和HTTP認證信息。如果要把Cookie發到服務器，一方面要服務器同意，客戶端：Access-Control-Allow-Credentials = true。
• Access-Control-Allow-Credentials: true
• 另一方面，開發者必須在AJAX請求中打開withCredentials屬性。

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

• 否則，即使服務器同意發送Cookie，瀏覽器也不會發送。或者，服務器要求設置Cookie，瀏覽器也不會處理。

• 但是，如果省略withCredentials設置，有的瀏覽器還是會一起發送Cookie。這時，可以顯式關閉withCredentials。

xhr.withCredentials = false;

• 需要注意的是，如果要發送Cookie，Access-Control-Allow-Origin就不能設爲星號，必須指定明確的、與請求網頁一致的域名。同時，Cookie依然遵循同源政策，只有用服務器域名設置的Cookie纔會上傳，其他域名的Cookie並不會上傳，且（跨源）原網頁代碼中的document.cookie也無法讀取服務器域名下的Cookie。

2.CORS非簡單請求-預檢請求

• 非簡單請求是那種對服務器有特殊要求的請求，比如請求方法是PUT或DELETE，或者Content-Type字段的類型是application/json。

• 非簡單請求的CORS請求，會在正式通信之前，增加一次HTTP查詢請求，稱爲"預檢"請求（preflight）。

• 瀏覽器先詢問服務器，當前網頁所在的域名是否在服務器的許可名單之中，以及可以使用哪些HTTP動詞和頭信息字段。只有得到肯定答覆，瀏覽器纔會發出正式的XMLHttpRequest請求，否則就報錯。

• 代碼

var url = 'http://api.uxin.com/user';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url, true);
xhr.setRequestHeader('X-Custom-Header', 'value');
xhr.send();

• 上面代碼中，HTTP請求的方法是PUT，並且發送一個自定義頭信息X-Custom-Header。
• 瀏覽器發現，這是一個非簡單請求，就自動發出一個"預檢"請求，要求服務器確認可以這樣請求。下面是這個"預檢"請求的HTTP頭信息。

OPTIONS /cors HTTP/1.1
Origin: http://m.a.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。

CORS預檢請求的響應

• 服務器收到"預檢"請求以後，檢查了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://m.a.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://m.a.com可以請求數據。該字段也可以設爲星號，表示同意任意跨源請求。

Access-Control-Allow-Origin: *

• 如果瀏覽器否定了"預檢"請求，會返回一個正常的HTTP迴應，但是沒有任何CORS相關的頭信息字段。這時瀏覽器就會認定，服務器不同意預檢請求，因此觸發一個錯誤，被XMLHttpRequest對象的onerror回調函數捕獲。控制檯會打印出如下的報錯信息。

XMLHttpRequest cannot load http://m.a.com.
Origin http://m.a.com is not allowed by Access-Control-Allow-Origin.

• 服務器迴應的其他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

1. Access-Control-Allow-Methods

• 該字段必需，它的值是逗號分隔的一個字符串，表明服務器支持的所有跨域請求的方法。注意，返回的是所有支持的方法，而不單是瀏覽器請求的那個方法。這是爲了避免多次"預檢"請求。

2. Access-Control-Allow-Headers

• 如果瀏覽器請求包括Access-Control-Request-Headers字段，則Access-Control-Allow-Headers字段是必需的。它也是一個逗號分隔的字符串，表明服務器支持的所有頭信息字段，不限於瀏覽器在"預檢"中請求的字段。

3. Access-Control-Allow-Credentials

• 該字段與簡單請求時的含義相同。

4. Access-Control-Max-Age

• 該字段可選，用來指定本次預檢請求的有效期，單位爲秒。上面結果中，有效期是20天（1728000秒），即允許緩存該條迴應1728000秒（即20天），在此期間，不用發出另一條預檢請求。
• CORS瀏覽器的正常請求和迴應

一旦服務器通過了"預檢"請求，以後每次瀏覽器正常的CORS請求，就都跟簡單請求一樣，會有一個Origin頭信息字段。服務器的迴應，也都會有一個Access-Control-Allow-Origin頭信息字段。

• 下面是"預檢"請求之後，瀏覽器的正常CORS請求。

PUT /cors HTTP/1.1
Origin: http://m.a.com
Host: api.alice.com
X-Custom-Header: value
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0..

• 上面頭信息的Origin字段是瀏覽器自動添加的。

• 下面是服務器正常的迴應。

Access-Control-Allow-Origin: http://m.a.com
Content-Type: text/html; charset=utf-8

• 上面頭信息中，Access-Control-Allow-Origin字段是每次迴應都必定包含的。

• 我們要知道CORS是http協議的一部分，由瀏覽器和服務器來完成。所以對於前端來說還是比較簡單的。我們要做的是理解這個協議和實現機制，在遇到類似問題的時候可以快速的定位。