跨域资源共享CORS

发表于 | 分类于 ， | 本文总阅读量 次
字数统计: 2.4k | 阅读时长 ≈ 9

参考阮一峰博客文章
CORS是一个w3c标准，全称是快于资源共享。它允许浏览器向跨源服务器，发出XMLHttpRequet请求，从而克服了AJAX只能同源使用的限制。

简介

CORS需要浏览器和服务器同时支持。目前所有浏览器都支持该功能。整个CORS通信过程，都是浏览器自动完成。不需要用户参与。对于开发者来说，CORS通信与同源AJAX通信没有差别，代码完全一样。浏览器一旦发现AJAX请求跨源，就会自动添加一些附加的头信息，有时还会多出一次附加的请求，当用户不会有感觉。

因此实现CORS通信的关键时服务器。只要服务器实现了CORS接口，就可以跨源通信。

两种请求

浏览器将CORS请求分成两类：简单请求和非简单请求。
只要同时满足以下两大条件就属于简单请求：

  • 请求方法时以下三种方法之一：
    • HEAD
    • GET
    • POST
  • HTTP的头信息不超过以下几种字段：
    • Accept
    • Accept-Language
    • Content-Language
    • Last-Event-Id
    • Content-Type：只限于三个只application/x-www-form-urlencoded、mutipart/form-data、text/plain

凡是不满足以上两个条件，就属于非简单请求。

浏览器对这两种请求的处理是不一样的。

简单请求

基本流程

对于简单请求，浏览器直接发出CORS请求。具体来说，就是在头信息之中，增加一个Origin字段

浏览器发现这次跨源AJAX请求是简单请求，就自动在头信息之中，添加一个Origin字段。

1
2
3
4
5
6
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指定的域名在许可范围内，服务器返回的响应，会多出几个头信息字段

1
2
3
4
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()方法只能拿到六个基本字段Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Progma。如果想要拿到其他字段就必须在Access-Control-Expose-Headers里面指定。上面的例子指定，getResponseHeader('FooBar')可以返回FooBar字段的值。

withCredentials属性

上面说到，CORS请求默认不发送cookie和HTTP认证信息。如果要把cookie发到服务器，一方面要服务器同意，指定Access-Control-Allow-Credentials字段

1
Access-Control-Allow-Credentials: true

另一方面，开发者必须在AJAX请求中打开withCredentials属性

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

否则即使服务器同意发送cookie，浏览器也不会发送。或者服务器要求设置cookie，浏览器也不会处理。

但是如果省略withCredentials设置，有的浏览器还是会一起发送cookie。这时，可以显式关闭withCredentials。

1
xhr.withCredentials = true;

需要注意的是，如果要发送cookie，Access-Control-Allow-Origin就不能设为星号，必须指定明确的、与请求网页一致的域名。同时，cookie依然遵循同源政策，只有用服务器域名设置的cookie才会上传，其他域名的cookie并不会上传，且（跨源）原网页代码中的document.cookie也无法读取服务器域名下的cookie。

非简单请求

预检请求

非简单请求是那种对服务器有特殊要求的请求，比如请求方法是PUT或DELETE，或者Content-Type字段的类型是application/json。

非简单请求的CORS请求，会在正式通信之前，增加一次HTTP查询请求，成为预检请求。

浏览器先访问服务器，当前网页所在的域名是否在服务器的许可名单之中，以及可以使用哪些HTTP动词和头信息字段。只有得到肯定答复，浏览器才会发出正式的XMLHttpRequest请求，否则就报错。

1
2
3
4
5
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。

浏览器发现，这时一个非简单请求，就自动发出一个“预检”请求，要求服务器确认可以这样请求。下面是这个“预检”请求的HTTP头信息。

1
2
3
4
5
6
7
8
OPTIONS /cors HTTP/1.1
Origin: http: //api.bob.com
Access-Control-Request-Method: PUT
Access-Control-Request-Header: X-Custom-Header
Host: api.alice.com
Access-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...

“预检”请求用的是OPTIONS，表示这个请求是用来询问的。头信息里面，关键字段是Origin，表示请求来自哪个源。

除了Origin字段，“预检”请求的头信息还包括两个特殊字段

Access-Control-Request-Method

该字段是必须的，用来列出浏览器的CORS请求会用到哪些HTTP方法，上例是PUT。

Access-Control-Request-Header

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

预检请求的响应

服务器收到“预检”请求以后，检查了Origin、Access-Control-Request-Method、Access-Control-Request-Header字段以后，确认允许跨源请求，就可以做出回应。

1
2
3
4
5
6
7
8
9
10
11
12
HTTP/1.1 200 OK
Date: Mon, 01 Dec 2008 01:15:39 GMT
Server: Apache/2.0.61(Unix)
Access-Control-Request-Origin: http://api.bob.com
Access-Control-Request-Methods: GET, POST, PUT
Access-Control-Request-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-Request-Origin字段，表示http://api.bob.com可以请求数据。该字段也可以设为型号，表示同意任意跨源请求。

1
Access-Control-Request-Origin: *

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

1
2
XMLHttpRequest cannot load http://api.bob.com
Origin http://api.bob.com is not allowed by Access-Control-Request-Origin

服务器回应的其他CORS相关字段如下所示：

1
2
3
4
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-Methods字段，则Access-Control-Allow-Methods字段是必须的。它也是一个逗号分割的字符串，表明服务器支持的所有头信息字段，不限于浏览器“预检”中请求的字段。

Access-Control-Allow-Credentials

该字段与简单请求时的含义相同

Access-Control-Max-Age

该字段可选，用来指定本次预检请求的有效期，单位为秒。上面结果中，有效期时20天，即允许缓存该条回应20天，再次期间不用发出另一条预检请求。

浏览器的正常请求与回应

一旦服务器通过“预检”请求，以后每次浏览器正常的CORS请求，就都跟简单请求一样，会有一个Origin头信息字段。服务器的回应也都会有一个Access-Control-Allow-Origin头信息字段。

下面时“预检”请求之后，浏览器的正常CORS请求。

1
2
3
4
5
6
7
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字段是浏览器自动添加的

下面是服务器正常的回应：

1
2
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的网站请求数据

-------------本文结束感谢您的阅读-------------