cors简介
CORS是一个W3C标准,全称是“跨域资源共享”(Cross-origin resource sharing)。
- cross-origin resource sharing 跨域资源共享 ( cors都是第一个字母的缩写 )
- 它允许浏览器向跨源服务器,发出
XMLHttpRequest
请求,从而克服了AJAX只能同源使用的限制。 - CORS需要浏览器和服务器同时支持。
- 对于开发者来说,CORS通信与同源的AJAX通信没有差别,代码完全一样。
- 实现CORS通信的关键是服务器。只要服务器实现了CORS接口,就可以跨源通信。
CORS请求
浏览器将CORS请求分成两类:简单请求(simple request)和非简单请求(not-so-simple request)。
- 简单请求(simple request)
- 非简单请求(not-so-simple request)。
简单请求
cors简单请求需要同时满足以下两个条件:凡是不同时满足这两个条件,就属于非简单请求。浏览器对这两种请求的处理,是不一样的。
简单请求满足的条件
(1) 求方法为 HEAD , GET , POST 三个中的一个
- 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字段。
- 简单请求,是浏览器直接发出cors请求 ---------- 在头信息中,添加 Origin 字段
- Origin 字段:用来说明本次请求来自哪个源
( 协议, 域名,端口 )
- 如果Origin指定的源,不在许可范围内,服务器会返回一个正常的HTTP回应。
浏览器发现,这个回应的头信息
没有包含Access-Control-Allow-Origin字段
,就知道出错了,从而抛出一个错误,被XMLHttpRequest的onerror回调函数捕获。注意,这种错误无法通过状态码识别,因为HTTP回应的状态码有可能是200。 - 如果Origin指定的域名在许可范围内,服务器返回的响应,会多出几个头信息字段。
GET /cors HTTP/1.1
Origin: http://api.bob.com // roigin字段:用来说明本次请求来自哪个源
Host: api.alice.com
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...
// 浏览器发现这次跨源AJAX请求是简单请求,就自动在头信息之中,添加一个Origin字段。
-
(重要)
如果Origin指定的域名在许可范围内,服务器返回的响应,会多出几个头信息字段。
Access-Control-Allow-Origin ------------------------- 必须
该字段是必须的,它的值: (1) 要么是请求时 Origin 字段的值; (2) 要么是一个 * 表示接受任意域名的请求Access-Control-Allow-Credentials ------------------- 可选
该字段可选,它的值是一个布尔值,表示是否允许发送Cookie。默认情况下,Cookie不包括在CORS请求之中。设为true,即表示服务器明确许可,Cookie可以包含在请求中,一起发给服务器。这个值也只能设为true,如果服务器不要浏览器发送Cookie,删除该字段即可。
Credentials是证书,许可的意思
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字段的值。
Expose是暴露,曝光的意思
// 如果origin指定的域名在许可的范围内,服务器返回的响应,会多出几个头信息字段
// 服务器返回的响应 ------- 多出的 头信息 字段
Access-Control-Allow-Origin: http://api.bob.com // 值是请求时Origin的值,或者*
Access-Control-Allow-Credentials: true // 是否允许浏览器发送cookie,(true 或者 没有字段)
Access-Control-Expose-Headers: FooBar // 指定getResponseHeader()可以返回 FooBar字段的值
Content-Type: text/html; charset=utf-8
withCredentials 属性
CORS请求默认不包含Cookie信息(以及HTTP认证信息等)。如果需要包含Cookie信息:
- 一方面,要服务器同意,指定Access-Control-Allow-Credentials字段。
- 另一方面,开发者必须在AJAX请求中打开withCredentials属性。
- 否则,即使服务器同意发送Cookie,浏览器也不会发送。或者,服务器要求设置Cookie,浏览器也不会处理。
- 但是,如果省略withCredentials设置,有的浏览器还是会一起发送Cookie。这时,可以显式关闭withCredentials。
发送cors请求要携带cookie信息: 需要做到下面两点
(1) 需要服务器同意,在响应头信息中必须有 Access-Control-Allow-Credentials: true 字段
(2) 在前端需要在 AJAX 请求中打开 withCredentials 属性
响应头:
Access-Control-Allow-Credentials: true
前端:
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
显式开启withCredentials属性: xhr.withCredentials = true;
显式关闭withCredentials属性: xhr.withCredentials = false;
(重要)
需要注意的是,如果要发送Cookie,Access-Control-Allow-Origin就不能设为星号,必须指定明确的、与请求网页一致的域名。同时,Cookie依然遵循同源政策,只有用服务器域名设置的Cookie才会上传,其他域名的Cookie并不会上传,且(跨源)原网页代码中的document.cookie也无法读取服务器域名下的Cookie。
- 要发送cookie,Access-Control-Allow-Origin字段不能为 * ,必须与请求网页的域名一致
- 同时,只有用服务器域名设置的cookie才会上传,其他域名的cookie不会上传
- 并且,前端中的document.cookie无法读取服务器域名下的cookie
非简单请求
非简单请求是那种对服务器有特殊要求的请求,比如请求方法是PUT或DELETE,或者Content-Type字段的类型是application/json。
预检请求
非简单请求的CORS请求,会在正式通信之前,增加一次HTTP查询请求,称为“预检”请求(preflight)。
- 浏览器先询问服务器,当前网页所在的域名是否在服务器的许可名单之中,以及可以使用哪些HTTP动词和头信息字段。只有得到肯定答复,浏览器才会发出正式的XMLHttpRequest请求,否则就报错
https://blog.csdn.net/ssisse/article/details/52576882
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。
浏览器发现,这是一个非简单请求 ( 因为是Put请求
),就自动发出一个“预检”请求,要求服务器确认可以这样请求。下面是这个“预检”请求的HTTP头信息。
OPTIONS /cors HTTP/1.1 // 预检请求的请求方法是 OPTIONS,表示该请求是用来询问的
Origin: http://api.bob.com // Origin字段: 表示请求来自哪个源
Access-Control-Request-Method: PUT // 该字段,表示HTTP请求的方法,如PUT DELETE POST GET 增删改查
Access-Control-Request-Headers: X-Custom-Header // 指定浏览器CORS请求会额外发送的头信息字段
Host: api.alice.com
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...
(重要)
“预检”请求用的请求方法是OPTIONS,表示这个请求是用来询问的。头信息里面,关键字段是Origin,表示请求来自哪个源。
- 预检请求的请求方法是 OPTIONS ,表示这个请求是用来询问的
- 头信息里面,Origin关键字表示请求来自哪个源
除了Origin字段,“预检”请求的头信息包括两个特殊字段:
(1) Access-Control-Request-Method ------------------- 必须
该字段是必须的,用来列出浏览器的CORS请求会用到哪些HTTP方法,上例是PUT。(2) 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.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回应,但是没有任何CORS相关的头信息字段。这时,浏览器就会认定,服务器不同意预检请求,因此触发一个错误,被XMLHttpRequest对象的onerror回调函数捕获。控制台会打印出如下的报错信息。
服务器回应的其他CORS相关字段:
- Access-Control-Allow-Methods ------------ 必须
该字段必需,它的值是逗号分隔的一个字符串,表明服务器支持的所有跨域请求的方法。注意,返回的是所有支持的方法,而不单是浏览器请求的那个方法。这是为了避免多次“预检”请求。
Access-Control-Allow-Headers ----------- 请求时有该字段,则返回时就是必须
如果浏览器请求包括Access-Control-Request-Headers字段,则Access-Control-Allow-Headers字段是必需的。它也是一个逗号分隔的字符串,表明服务器支持的所有头信息字段,不限于浏览器在“预检”中请求的字段。
表示服务器支持的所有头信息字段
Access-Control-Allow-Credentials
与请求时字段的含义相同,都表示是否可以携带cookie,值是boolean值,只能是true或者 没有该字段 (没有该字段,表示服务器不允许浏览器携带cookie)Access-Control-Max-Age
该字段可选,用来指定本次预检请求的有效期,单位为秒。在此期间,不用发出另一条预检请求。
表示本次预检请求的有效期,单位是秒,在此期间,不用再发预检请求
Access-Control-Allow-Methods: GET, POST, PUT
Access-Control-Allow-Headers: X-Custom-Header
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 1728000
浏览器的正常请求和回应
一旦服务器通过了“预检”请求,以后每次浏览器正常的CORS请求,就都跟简单请求一样,会有一个Origin头信息字段。服务器的回应,也都会有一个Access-Control-Allow-Origin头信息字段
服务器通过了预检请求后,以后的cors非简单请求,就和cors简单请求一样
- 浏览器请求时有Origin头信息字段
- 服务器回应时有Access-Contorl-Allow-Origin头信息字段
“预检”请求之后,浏览器的正常CORS请求。
// “预检”请求之后,浏览器的正常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...
cors 与 jsonp 的比较
CORS与JSONP的使用目的相同,但是比JSONP更强大。
JSONP只支持GET请求,CORS支持所有类型的HTTP请求。JSONP的优势在于支持老式浏览器,以及可以向不支持CORS的网站请求数据。
- jsonp只支get请求, cors支持所有类型的HTTP请求
- jsonp的优势在于支持老式浏览器,和 可以向不支持 cors 的网站请求数据