CORS通信

目錄

1.簡介

2.兩種請求

3.簡單請求

3.1基本流程

3.2withCredentials 屬性

4.非簡單請求

4.1預檢請求

4.2預檢請求的回應

4.3瀏覽器的正常請求和回應

5.與 JSONP 的比較


CORS 是一個 W3C 標準,全稱是“跨域資源共享”(Cross-origin resource sharing)辅髓。它允許瀏覽器向跨域的服務器擎鸠,發(fā)出XMLHttpRequest請求,從而克服了AJAX只能同源使用的限制没讲。

簡介

CORS 需要瀏覽器和服務器同時支持。目前,所有瀏覽器都支持該功能座硕。

整個 CORS 通信過程趾浅,都是瀏覽器自動完成愕提,不需要用戶參與。對于開發(fā)者來說皿哨,CORS 通信與普通的 AJAX 通信沒有差別浅侨,代碼完全一樣。瀏覽器一旦發(fā)現(xiàn) AJAX 請求跨域证膨,就會自動添加一些附加的頭信息如输,有時還會多出一次附加的請求,但用戶不會有感知央勒。因此不见,實現(xiàn) CORS 通信的關鍵是服務器。只要服務器實現(xiàn)了 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

凡是不同時滿足上面兩個條件捏悬,就屬于非簡單請求撞蚕。一句話,簡單請求就是簡單的 HTTP 方法與簡單的 HTTP 頭信息的結(jié)合过牙。

這樣劃分的原因是甥厦,表單在歷史上一直可以跨域發(fā)出請求纺铭。簡單請求就是表單請求,瀏覽器沿襲了傳統(tǒng)的處理方式刀疙,不把行為復雜化舶赔,否則開發(fā)者可能轉(zhuǎn)而使用表單,規(guī)避 CORS 的限制谦秧。對于非簡單請求竟纳,瀏覽器會采用新的處理方式。

簡單請求

基本流程

對于簡單請求疚鲤,瀏覽器直接發(fā)出 CORS 請求锥累。具體來說,就是在頭信息之中集歇,增加一個Origin字段桶略。

下面是一個例子,瀏覽器發(fā)現(xiàn)這次跨域 AJAX 請求是簡單請求诲宇,就自動在頭信息之中际歼,添加一個Origin字段。

GET/corsHTTP/1.1Origin:http://api.bob.comHost:api.alice.comAccept-Language:en-USConnection:keep-aliveUser-Agent:Mozilla/5.0...

上面的頭信息中姑蓝,Origin字段用來說明蹬挺,本次請求來自哪個域(協(xié)議 + 域名 + 端口)。服務器根據(jù)這個值它掂,決定是否同意這次請求。

如果Origin指定的源溯泣,不在許可范圍內(nèi)虐秋,服務器會返回一個正常的 HTTP 回應。瀏覽器發(fā)現(xiàn)垃沦,這個回應的頭信息沒有包含Access-Control-Allow-Origin字段(詳見下文)客给,就知道出錯了,從而拋出一個錯誤肢簿,被XMLHttpRequest的onerror回調(diào)函數(shù)捕獲靶剑。注意,這種錯誤無法通過狀態(tài)碼識別池充,因為 HTTP 回應的狀態(tài)碼有可能是200桩引。

如果Origin指定的域名在許可范圍內(nèi),服務器返回的響應收夸,會多出幾個頭信息字段坑匠。

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

該字段可選。它的值是一個布爾值闪朱,表示是否允許發(fā)送 Cookie月匣。默認情況下,Cookie 不包括在 CORS 請求之中监透。設為true桶错,即表示服務器明確許可,瀏覽器可以把 Cookie 包含在請求中胀蛮,一起發(fā)給服務器院刁。這個值也只能設為true,如果服務器不要瀏覽器發(fā)送 Cookie粪狼,不發(fā)送該字段即可退腥。

(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字段鼠冕。

Access-Control-Allow-Credentials: true

另一方面添寺,開發(fā)者必須在 AJAX 請求中打開withCredentials屬性。

varxhr=newXMLHttpRequest();xhr.withCredentials=true;

否則懈费,即使服務器同意發(fā)送 Cookie畦贸,瀏覽器也不會發(fā)送。或者薄坏,服務器要求設置 Cookie趋厉,瀏覽器也不會處理。

但是胶坠,如果省略withCredentials設置君账,有的瀏覽器還是會一起發(fā)送 Cookie。這時沈善,可以顯式關閉withCredentials乡数。

xhr.withCredentials=false;

需要注意的是,如果要發(fā)送 Cookie闻牡,Access-Control-Allow-Origin就不能設為星號净赴,必須指定明確的、與請求網(wǎng)頁一致的域名罩润。同時玖翅,Cookie 依然遵循同源政策,只有用服務器域名設置的 Cookie 才會上傳割以,其他域名的 Cookie 并不會上傳金度,且(跨域)原網(wǎng)頁代碼中的document.cookie也無法讀取服務器域名下的 Cookie。

非簡單請求

預檢請求

非簡單請求是那種對服務器提出特殊要求的請求严沥,比如請求方法是PUT或DELETE猜极,或者Content-Type字段的類型是application/json。

非簡單請求的 CORS 請求消玄,會在正式通信之前跟伏,增加一次 HTTP 查詢請求,稱為“預檢”請求(preflight)翩瓜。瀏覽器先詢問服務器受扳,當前網(wǎng)頁所在的域名是否在服務器的許可名單之中,以及可以使用哪些 HTTP 動詞和頭信息字段奥溺。只有得到肯定答復,瀏覽器才會發(fā)出正式的XMLHttpRequest請求骨宠,否則就報錯浮定。這是為了防止這些新增的請求,對傳統(tǒng)的沒有 CORS 支持的服務器形成壓力层亿,給服務器一個提前拒絕的機會桦卒,這樣可以防止服務器大量收到DELETE和PUT請求,這些傳統(tǒng)的表單不可能跨域發(fā)出的請求匿又。

下面是一段瀏覽器的 JavaScript 腳本方灾。

varurl='http://api.alice.com/cors';varxhr=newXMLHttpRequest();xhr.open('PUT',url,true);xhr.setRequestHeader('X-Custom-Header','value');xhr.send();

上面代碼中,HTTP 請求的方法是PUT,并且發(fā)送一個自定義頭信息X-Custom-Header裕偿。

瀏覽器發(fā)現(xiàn)洞慎,這是一個非簡單請求,就自動發(fā)出一個“預檢”請求嘿棘,要求服務器確認可以這樣請求劲腿。下面是這個“預檢”請求的 HTTP 頭信息。

OPTIONS/corsHTTP/1.1Origin:http://api.bob.comAccess-Control-Request-Method:PUTAccess-Control-Request-Headers:X-Custom-HeaderHost:api.alice.comAccept-Language:en-USConnection:keep-aliveUser-Agent:Mozilla/5.0...

“預檢”請求用的請求方法是OPTIONS鸟妙,表示這個請求是用來詢問的焦人。頭信息里面,關鍵字段是Origin重父,表示請求來自哪個源花椭。

除了Origin字段,“預檢”請求的頭信息包括兩個特殊字段房午。

(1)Access-Control-Request-Method

該字段是必須的矿辽,用來列出瀏覽器的 CORS 請求會用到哪些 HTTP 方法,上例是PUT歪沃。

(2)Access-Control-Request-Headers

該字段是一個逗號分隔的字符串嗦锐,指定瀏覽器 CORS 請求會額外發(fā)送的頭信息字段,上例是X-Custom-Header沪曙。

預檢請求的回應

服務器收到“預檢”請求以后奕污,檢查了Origin、Access-Control-Request-Method和Access-Control-Request-Headers字段以后液走,確認允許跨源請求碳默,就可以做出回應。

HTTP/1.1200OKDate:Mon, 01 Dec 2008 01:15:39 GMTServer:Apache/2.0.61 (Unix)Access-Control-Allow-Origin:http://api.bob.comAccess-Control-Allow-Methods:GET, POST, PUTAccess-Control-Allow-Headers:X-Custom-HeaderContent-Type:text/html; charset=utf-8Content-Encoding:gzipContent-Length:0Keep-Alive:timeout=2, max=100Connection:Keep-AliveContent-Type:text/plain

上面的 HTTP 回應中缘眶,關鍵的是Access-Control-Allow-Origin字段嘱根,表示http://api.bob.com可以請求數(shù)據(jù)。該字段也可以設為星號巷懈,表示同意任意跨源請求该抒。

Access-Control-Allow-Origin: *

如果服務器否定了“預檢”請求,會返回一個正常的 HTTP 回應顶燕,但是沒有任何 CORS 相關的頭信息字段凑保,或者明確表示請求不符合條件。

OPTIONShttp://api.bob.comHTTP/1.1Status:200Access-Control-Allow-Origin:https://notyourdomain.comAccess-Control-Allow-Method:POST

上面的服務器回應涌攻,Access-Control-Allow-Origin字段明確不包括發(fā)出請求的http://api.bob.com欧引。

這時,瀏覽器就會認定恳谎,服務器不同意預檢請求芝此,因此觸發(fā)一個錯誤憋肖,被XMLHttpRequest對象的onerror回調(diào)函數(shù)捕獲』槠唬控制臺會打印出如下的報錯信息岸更。

XMLHttpRequest cannot load http://api.alice.com.

Origin http://api.bob.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

該字段可選剥汤,用來指定本次預檢請求的有效期,單位為秒排惨。上面結(jié)果中吭敢,有效期是20天(1728000秒),即允許緩存該條回應1728000秒(即20天)暮芭,在此期間鹿驼,不用發(fā)出另一條預檢請求。

瀏覽器的正常請求和回應

一旦服務器通過了“預檢”請求辕宏,以后每次瀏覽器正常的 CORS 請求畜晰,就都跟簡單請求一樣,會有一個Origin頭信息字段瑞筐。服務器的回應凄鼻,也都會有一個Access-Control-Allow-Origin頭信息字段。

下面是“預檢”請求之后聚假,瀏覽器的正常 CORS 請求块蚌。

PUT/corsHTTP/1.1Origin:http://api.bob.comHost:api.alice.comX-Custom-Header:valueAccept-Language:en-USConnection:keep-aliveUser-Agent:Mozilla/5.0...

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

下面是服務器正常的回應魔策。

Access-Control-Allow-Origin: http://api.bob.com

Content-Type: text/html; charset=utf-8

上面頭信息中匈子,Access-Control-Allow-Origin字段是每次回應都必定包含的河胎。

與 JSONP 的比較

CORS 與 JSONP 的使用目的相同闯袒,但是比 JSONP 更強大。JSONP 只支持GET請求,CORS 支持所有類型的 HTTP 請求政敢。JSONP 的優(yōu)勢在于支持老式瀏覽器其徙,以及可以向不支持 CORS 的網(wǎng)站請求數(shù)據(jù)。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末喷户,一起剝皮案震驚了整個濱河市唾那,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌褪尝,老刑警劉巖闹获,帶你破解...
    沈念sama閱讀 217,509評論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件掰曾,死亡現(xiàn)場離奇詭異雹顺,居然都是意外死亡,警方通過查閱死者的電腦和手機河爹,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,806評論 3 394
  • 文/潘曉璐 我一進店門璃谨,熙熙樓的掌柜王于貴愁眉苦臉地迎上來沙庐,“玉大人,你說我怎么就攤上這事佳吞」俺” “怎么了?”我有些...
    開封第一講書人閱讀 163,875評論 0 354
  • 文/不壞的土叔 我叫張陵底扳,是天一觀的道長铸抑。 經(jīng)常有香客問我,道長花盐,這世上最難降的妖魔是什么羡滑? 我笑而不...
    開封第一講書人閱讀 58,441評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮算芯,結(jié)果婚禮上柒昏,老公的妹妹穿的比我還像新娘。我一直安慰自己熙揍,他們只是感情好职祷,可當我...
    茶點故事閱讀 67,488評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著届囚,像睡著了一般有梆。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上意系,一...
    開封第一講書人閱讀 51,365評論 1 302
  • 那天泥耀,我揣著相機與錄音,去河邊找鬼蛔添。 笑死痰催,一個胖子當著我的面吹牛兜辞,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播夸溶,決...
    沈念sama閱讀 40,190評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼逸吵,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了缝裁?” 一聲冷哼從身側(cè)響起扫皱,我...
    開封第一講書人閱讀 39,062評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎捷绑,沒想到半個月后韩脑,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,500評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡粹污,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,706評論 3 335
  • 正文 我和宋清朗相戀三年扰才,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片厕怜。...
    茶點故事閱讀 39,834評論 1 347
  • 序言:一個原本活蹦亂跳的男人離奇死亡衩匣,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出粥航,到底是詐尸還是另有隱情琅捏,我是刑警寧澤,帶...
    沈念sama閱讀 35,559評論 5 345
  • 正文 年R本政府宣布递雀,位于F島的核電站柄延,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏缀程。R本人自食惡果不足惜搜吧,卻給世界環(huán)境...
    茶點故事閱讀 41,167評論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望杨凑。 院中可真熱鬧滤奈,春花似錦、人聲如沸撩满。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,779評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽伺帘。三九已至昭躺,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間伪嫁,已是汗流浹背领炫。 一陣腳步聲響...
    開封第一講書人閱讀 32,912評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留张咳,地道東北人帝洪。 一個月前我還...
    沈念sama閱讀 47,958評論 2 370
  • 正文 我出身青樓针史,卻偏偏與公主長得像,于是被迫代替她去往敵國和親碟狞。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,779評論 2 354

推薦閱讀更多精彩內(nèi)容