×

跨域资源共享CORS总结

96
苹果小王子写字的地方
2016.08.02 17:54* 字数 2516
摘要:CORS是一个W3C标准,全程是“跨域资源共享”(Cross-origin resource sharing)。CORS允许浏览器向跨源服务器发出XMLHttpRequest请求,以克服AJAX只能基于同源策略的使用限制。本文将详细介绍CORS的内部机制。
1. 简介

  CORS需要浏览器与服务器同时支持。目前,所有浏览器都支持该功能,IE浏览器不能低于IE10。
  整个CORS通信过程,都是浏览器自动完成,不需要用户参与。对于开发者来说,CORS通信与同源的AJAX通信没有差别,代码完全一样。浏览器一旦发现AJAX请求跨源,就会自动添加一些附加的头信息,有时还会多出一次附加的请求(如添加了Origin : http://localhost:63343,Access-Control-Request-Headers : accept, content-type,Access-Control-Request-Method : POST),但是用户不会有感觉。
  因此,实现CORS通信的关键是服务器。只要服务器实现了CORS接口或者约定,就可以跨源通信。

2.两种请求

  浏览器把CORS请求分成:简单请求(Simple Request)和非简单请求(Not-so simple request)。
  只要同时满足一下两个条件,就属于简单请求。
  (1)请求方法是HEAD/GET/POST三种方法之一;
  (2)HTTP的头信息不超出一下几种字段:Accept/Accept-Encoding/Accept-Language/Cache-Control/Connection/Cookie/Host/If-Modified-Since/Referer/User-Agent/Content-Type/Content-Language。其中Content-Type仅限于三个值:application/x-www-form-urlencoded、multipart/form-data、text/pain
  凡是不满足上面两个条件,就属于非简单请求。浏览器对于两种请求的处理是不一样的。

3. 简单请求
3.1 基本流程

  对于简单请求,浏览器直接发出CORS请求,在HTTP HEADER中增加了Origin字段。如下:

POST /nlp/segment HTTP/1.1
Host: 10.1.222.80:8084
Connection: keep-alive
Content-Length: 90
Accept: */*; q=0.01
Origin: http://localhost:63343
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.102 Safari/537.36
Content-Type: application/ x-www-form-urlencoded;charset=UTF-8
Referer: http://localhost:63343/BZZZ/bz.html?_ijt=eu8vkf2u50ccl1gshpr4lhjt3r
Accept-Encoding: gzip, deflate
Accept-Language: zh-CN,zh;q=0.8

  上面的头信息中,Origin字段用来说明,本次请求来自哪个源(协议+域名+端口)。服务器根据这个值,决定是否同意这次请求。
如果Origin制定的源不在许可范围之内,服务器会返回一个正常的HTTP回应。浏览器发现Http Response头信息中没有包含Access-Control-Allow-Origin字段,就判断出错并抛出一个错误,被XMLHttpRequest的onerror回调函数捕获。注意,这种错误无法通过状态码识别,因为HTTP回应的状态码有可能是200.
  如果Origin制定的域名在许可范围内,服务器返回的响应中多出几个头信息字段:

Access-Control-Allow-Headers:Content-Type
Access-Control-Allow-Methods:GET,POST,PUT,OPTIONS,DELETE
Access-Control-Expose-Headers: FooBar
Access-Control-Allow-Origin:*
Content-Type:text/html; charset=UTF-8

  上面的头信息中,有三个与CORS请求相关的字段,均以Access-Control-开头。
(1). Access-Control-Allow-Origin
  该字段是必须的,它的值要么是请求时Origin字段的值,要么是一个*,表示接受任意域名的请求。
(2). Access-Control-Allow-Credentials
  该字段可选,它是一个Bool值,表示是否允许发送Cookie。默认情况下,Cookie不包括在CORS请求中,设为true,即表示服务器明确许可,Cookie可以包含在请求中,一起发给服务器。这个值只能设为true,没有false取值,如果服务器不要浏览器发送Cookie,删除该字段即可。
(3). Access-Control-Allow-Methods
  该字段可选,如果允许跨域请求的方法是PUT/GET/POST/OPTIONS/DELETE等其中的一项或几项,就需要设置该字段的值为”PUT,GET,POST,OPTIONS”。
(4). 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字段的值。
(5). Access-Control-Allow-Headers
  该字段可选,CORS请求时,如果是自定义Http Request Header,就必须在该字段中指定对应的Header Name,如例子中自定义Header为’Test’,那么需要在服务器端制定该字段为’Test’。

3.2 withCredentials属性

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

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。

4. 非简单请求
4.1 预检请求

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

var test1 = {method:"segment", format:"json", message:["我是中国人!","欢迎来到中国"]};
$.ajax({
            url : "http://10.1.222.80:8084/nlp/segment",
            type : "post",
            dataType : "json",
            contentType:"application/json;charset=utf-8",
            data :JSON.stringify(test1),
            crossDomain: true,
            /*headers:{
              "Content-Type":"application/x-www-form-urlencoded"
            },*/
            timeout : 10000 
});

  上面的请求中是Content-Type为application/json的请求。浏览器认为这是一个非简单请求,自动向服务器发送一个预检请求,要求服务器确认可以这样请求。下面是预检请求的HTTP头信息:

OPTIONS /nlp/segment HTTP/1.1
Host: 10.1.222.80:8084
Connection: keep-alive
Access-Control-Request-Method: POST
Origin: http://localhost:63343
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.102 Safari/537.36
Access-Control-Request-Headers: accept, content-type
Accept: */*
Referer: http://localhost:63343/BZZZ/bz.html?_ijt=eu8vkf2u50ccl1gshpr4lhjt3r
Accept-Encoding: gzip, deflate, sdch
Accept-Language: zh-CN,zh;q=0.8

  预检请求使用的请求方法是OPTIONS,表示这个请求用来询问。头信息中关键字段是Origin,表示请求来自哪个源。
除了Origin字段,预检请求的头信息还包括两个特殊字段:
  (1). Access-Control-Request-Method
  该字段是必须的,用来列出浏览器的CORS请求会用到哪些HTTP方法,例子中是POST。
  (2). Access-Control-Request-Headers
  该字段是都好分割的字符串,指定浏览器CORS请求会额外发送的头信息字段,上面的例子默认application/json对应的额外字段是”Content-Type”。

4.2 预检请求的回应Response

  服务器收到预检请求后,检查Origin、Access-Control-Request-Method和Access-Control-Request-Headers字段以后,确认允许跨源请求,并做出回应。如下:

HTTP/1.1 200 OK
Content-Type: text/html; charset=UTF-8
Connection: close
Time-Used: 25ms
Content-Length-UnGzipped: 7
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET,POST,PUT,OPTIONS,DELETE
Access-Control-Allow-Headers: Content-Type
Content-Encoding: gzip
Content-Length: 33

  上面的Http Response中,关键是Access-Control-Allow-Origin字段,表示http://localhost:63343可以请求数据,该字段可以设为”*”,表示同意任意跨源请求。
  如果服务器否定了预检请求,会返回一个正常的HTTP Response,但是没有任何CORS相关的头信息字段。这时候浏览器认为i额服务器不同意预检请求,因此出发一个错误,被XMLHttpRequest对象的onerror毁掉函数捕获。控制台会打印出如下报错信息。

XMLHttpRequest cannot load http://localhost:63343.
Origin http://localhost:63343 is not allowed by Access-Control-Allow-Origin.

  服务器响应的CORS其他相关字段如下:

Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET,POST,PUT,OPTIONS,DELETE
Access-Control-Allow-Headers: Content-Type

  (1). Access-Control-Allow-Methods
  该字段是必需的,其取值是逗号分割的字符串,表明服务器支持的所有跨域请求的方法。注意,返回的是所有支持的方法,而不单是浏览器请求的哪个方法。这个是为了避免多次预检请求。
  (2). Access-Control-Allow-Headers
  如果浏览器请求包括Access-Control-Allow-Headers字段,则该字段是必须的,其取值是一个逗号分割的字符串,表明服务器支持的所有头信息字段,不限于浏览器在预检中请求的字段。
  (3). Access-Control-Allow-Credentials
  该字段与简单请求时字段含义相同。
  (4). Access-Control-Max-Age
  该字段可选,用来制定本次预检请求的有效期,单位为秒。缓存于浏览器中,在有效期中,不需要发出另一条预检请求。

4.3 浏览器的正常请求和回应

  一旦服务器通过了预检请求,以后每次浏览器正常的CORS请求就都与简单请求一样,包括Origin字段信息。服务器的回应也会有Access-Control-Allow-Origin字段。

5. 与JSONP比较

  CORS与Jsonp使用目的相同,但是Jsonp只支持GET请求,CORS支持所有类型的HTTP请求。JSONP的有时在于支持老式浏览器,以及向不支持CORS的网站请求数据。


黄博博
2016年8月2日

日记本
Web note ad 1