CORS跨域资源共享

2020-08-20  本文已影响0人  泡杯感冒灵

CORS是一个W3C标准，全称是"跨域资源共享"（Cross-origin resource sharing）。
它允许浏览器向跨源服务器发出XMLHttpRequest请求，从而客服了 AJAX只能同源使用的限制。

一. 简介

CORS需要浏览器和服务器的同时支持。目前所有的浏览器都支该功能，IE浏览器不低于IE10。
整个CORS通信过程，都是浏览器自动完成的，不需要用户参与。对于开发者来说，CORS通信和同源的AJAX通信没有差别，代码完全一样。浏览器一旦发现AJAX请求跨源，就会自动添加一些附近的头信息，有时还会多出一次附加的请求，但用户不会有感觉。
因此，实现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   // 实体头部用于指示资源的MIME类型,只限于三个值application/x-www-form-urlencoded、multipart/form-data、text/plain

这是为了兼容表单（form），因为历史上表单一直可以发出跨域请求。AJAX 的跨域设计就是，只要表单可以发，AJAX 就可以直接发。
凡是不同时满足上面两个条件，就属于非简单请求。
浏览器对这两种请求的处理，是不一样的

三. 简单请求

对于简单请求，浏览器直接发出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-开头
（1）Access-Control-Allow-Origin
该字段是必须的，它的值要么是请求时 Origin字段的值，要么是一个*，表示接受任意域名的请求。
（2）Access-Control-Allow-Credentials
该字段可选，它的值是一个布尔值，表示是否允许发送cookie。默认情况下，cookie不包括在CORS请求中。设为true,则表示服务器明确许可，Cookie可以包含在请求中，一起发给服务器。这个字段的值也只能设置为true,如果服务器不需要浏览器发送 Cookie,删除这个字段即可
（3）Access-Control-Exposs-Headers
该字段可选。CORS请求时，XMLHttpRequest对象的getResponseHeader()方法只能拿到6个基本字段：Cache-Control,Content-Language,Content-Type,Expires,Last-Modified,Pragma.如果想拿到其他字段，就必须在Access-Control-Exposs-Headers里面指定。上面的例子指定，getResponseHead('FooBar')可以返回字段FooBar的值

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

四. 非简单请求

非简单请求是那种对服务器有特殊要求的请求，比如请求方法是PUT和DELETE,或者Content-Type字段的类型是application/json
非简单请求的CORS请求，会在正式通信之前，增加一次HTTP查询请求，称为预检请求（preflight）
浏览器先询问服务器，当前网页所在的域名是否在服务器的许可名单之中，以及可以使用哪些HTTP动词和头信息字段，只有得到肯定答复，浏览器才会发出正式的XMLHttpRequest请求，否则就报错。
下面是一段浏览器的JavaScript脚本。

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请求的方法是PUT，并且发送一个自定义头信息X-Custom-Header。
浏览器发现这是一个非简单请求，就自动发出一个预检请求，要求服务器确认可以这样请求。下面是这个预检请求的头信息

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字段，预检请求的头信息包括两个特殊字段。

(1)  Access-Control-Request-Method
该字段是必须的，用来列出浏览器的CORS请求会用到哪些HTTP方法，上例是PUT

(2)  Access-Control-Request-Headers
该字段是一个逗号分割的字符串，指定浏览器CORS请求会额外发送的头信息字段，上例是X-Custom-Header

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可以请求数据。该字段也可以设为星号，表示同意任意跨源请求。

Access-Control-Allow-Origin: *

如果服务器否定了预检请求，会返回一个正常的HTTP响应，但是没有任何CORS相关的头信息字段。这时，浏览器就会认定服务器不同意预检请求，因此触发一个错误，被XMLHttpRequest对象的onerror回调函数捕获到。控制台会打印出如下报错信息

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
该字段是必须的，它的值是一个逗号分割的字符串，表明服务器支持的所有跨域请求的方法。注意，返回的是支持的所有跨域的方法，而不单是浏览器请求的那个方法。这是为了避免多次预检请求。
(1) Access-Control-Allow-Headers
如果浏览器请求包含Access-Control-Request-Headers字段，则Access-Controll-Allow-Headers字段是必须的。它也是一个逗号分隔的字符串，表示服务器支持的所有头信息字段，不限于浏览器在预检请求中的字段。
(3) Access-Control-Allow-Credentials
该字段与简单请求时的含义相同。
(3) Access-Control-Max-Age
该字段可选，用来指定本次预检请求的有效期，单位为秒。上面结果中，有效期式20天(1728000秒)，即允许缓存该条回应1728000秒(20天)，在此期间，不用发出另一条预检请求

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...

上面头信息的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的优势在于，简单易用，支持老式浏览器，以及可以向不支持CORS的网站请求数据。

From: 阮一峰的网络日志

上一篇下一篇

猜你喜欢

热点阅读