跨域资源共享 CORS

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(只限于三个值: application/x-www-form-urlencoded, multipart/form-data, text/plain)

凡是不能同时满足上面两个条件的, 就属于非简单请求.

简单请求

基本流程

对于简单请求, 浏览器直接发出 CORS 请求, 具体来说, 就是在头信息中增加一个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...
`</pre>

上面的头信息中, `Origin`字段用来说明, 本次请求来此哪个源(协议+域名+端口), 服务器根据这个值, 决定是否同意此次请求.

如果`Origin`指定的源, 不在许可范围内, 服务器会返回一个正常的 HTTP 响应. **浏览器**发现这个回应的头信息中没有包含`Access-Control-Allow-Origin`字段, 就知道出错了, 从而抛出一个错误, 被`XMLHttpRequest`的`onerror`回调函数捕获. 注意, 这种错误无法通过状态码识别, 因为 HTTP 回应的状态码可能是200.

如果`Origin`指定的域名在许可范围内, 服务器返回的相应, 会多出几个头信息字段

<pre>`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
`</pre>

上面的头信息中, 有三个与 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()` 方法只能拿到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` 字段

<pre>`Access-Control-Allow-Credientials: true
`</pre>

另一方面, 开发者需要在 AJAX 请求中打开`withCredientials`属性

<pre>`var xhr = new XMLHttpRequest();
xhr.withCredientials = true;
`</pre>

否则即使服务器同意发送 Cookie, 浏览器也不会发送

要注意, 如果要发送 Cookie, `Access-Control-Allow-Origin` 不能设置为 `*`, 必须指定明确的, 与请求网页一致的域名. 同时 Cookie 依然遵循同源政策, 只有用服务器域名设置的 Cookie 才会上传, 其他域名的 Cookie 不会上传.

### 非简单请求

#### 预检请求

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

非简单请求的 CORS 请求, 会在正是通信钱, 增加一次 HTTP 查询请求, 称为 "预检请求" (preflight)

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

下面是一段浏览器的 JavaScript 脚本

<pre>`var url = 'http://api.alice.com/cors'
var xhr = new XMLHttpRequest();
xhr.open('PUT', url, true);
xhr.setRequestHeader('X-Custom-Header', 'value');
xhr.send()
`</pre>

上面代码中, HTTP 请求的方法是 `PUT`, 并且发送一个自定义头信息 `X-Custom-Header`

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

<pre>`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
Connection: keep-alive
User-Agent: Molliza/5.0...
`</pre>

"预检" 请求用的请求方法是 `OPTIONS`, 表示这个请求是用来询问的, 头信息里面, 关键字段是 `Origin`, "预检" 秦秋的头信息包括两个特殊字段
- Access-Control-Request-Method
  这个字段是必须的, 用来列出请求方法
  • Access-Control-Request-Headers
    该字段是一个逗号分隔的字符串, 永安里指定浏览器 CORS 请求会格外发送的头信息字段

    预检请求的响应

    服务器取得”预检”请求后, 检查Origin, Access-Control-Request-MethodAccess-Control-Request-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 可以请求数据, 该字段也可以设置为*, 表示同意跨源请求.

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

    `XMLHttpRequest cannot load http://api.alice.com.
    Origin http://api.bob.com is not allowed by Access-Control-Allow-Origin.
    `

    服务器回应其他 CORES 相关字段如下:

    `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-Method

    该字段是必须的, 他的值是逗号分隔的一个字符串, 表明服务器支持的跨域请求方式

    Access-Control-Allow-Headers

    如果浏览器包含Access-Control-Request-Headers, 则 Access-Control-Allow-Headers 也是必须的, 其值也是一个逗号分隔的字符串

    Access-Control-Allow-Credentials

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

    Access-Control-Max-Age

    该字段可选, 永安里指定本次预检请求的有效期(s), 有效期内发起跨域请求不需要预检请求.

    浏览器的正常请求与回应

    一旦服务器通过”预检”请求, 以后每次浏览器正常的 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
    Access-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

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×