跨域资源共享 CORS 详解

CORS

CORS：跨域资源共享（Cross-origin resource sharing），是一个 W3C 标准。

作用：允许浏览器向跨源服务器发出 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：只限于 application/x-www-form-urlencoded、multipart/form-data、text/plain

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

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

简单请求

基本流程

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

比如，浏览器发现这次跨源 AJAX 请求是简单请求：

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-Expose-Headers

可选。

CORS 请求时，XMLHttpRequest 对象的 getResponseHeader() 方法只能拿到6个基本字段：

• Cache-Control
• Content-Language
• Content-Type
• Expires
• Last-Modified
• Pragma

如果想拿到其他字段，就必须在 Access-Control-Expose-Headers 里面指定。

比如，上面的例子中要获取 FooBar 字段，就要 getResponseHeader('FooBar')。

Access-Control-Allow-Credentials

可选。

它的值是一个布尔值，表示：是否允许发送 Cookie。默认情况下 Cookie 不包括在 CORS 请求中。

true：服务器明确允许 Cookie 可以包含在请求中（这个值只能设为 true，如果服务器不要浏览器发送 Cookie，删除该字段即可）。

withCredentials 属性

上面说到，CORS 请求默认不发送 Cookie 和 HTTP 认证信息。

如果要把 Cookie 发到服务器，要满足两个条件：

• 服务器同意：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。

浏览器发现这是一个非简单请求，就自动发出一个”预检”请求，要求服务器确认可以这样请求。下面是这个”预检”请求的 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

响应中的关键是 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

Access-Control-Allow-Methods

必需。

它的值是逗号分隔的一个字符串，表明服务器支持的所有跨域请求的方法。

注：返回的是所有支持的方法，而不单是浏览器请求的那个方法。这是为了避免多次”预检”请求。

Access-Control-Allow-Headers

如果浏览器请求包括 Access-Control-Request-Headers 字段，则 Access-Control-Allow-Headers 字段是必需的。它也是一个逗号分隔的字符串，表明服务器支持的所有头信息字段，不限于浏览器在”预检”中请求的字段。

Access-Control-Allow-Credentials

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

Access-Control-Max-Age

可选。

指定本次预检请求的有效期，单位：秒。上面示例中的有效期是1728000秒，即允许缓存该条响应1728000秒，在此期间，不用发出另一条预检请求。

浏览器的正常请求和响应

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

下面是”预检”请求之后，浏览器的正常 CORS 请求：

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