跨域资源共享 CORS 详解
解决方法来源
解决方法来源二 vuejs之axios获取http响应头 https://segmentfault.com/a/1190000009125333?utm_source=tag-newest
今天遇到了自定义请求头的发送和接收响应,遇到了问题,花费了一些时间解决了,又去查了一些资料去看,没想到之前阮一峰写的内容里面有,但是没有仔细查看,把他的拿过了记录一下。
前端请求用的 axios
我的第一个问题:
为什么这个报错了,是因为我的请求头中的自定义内容没有在后台服务的响应列表里面。
第二个问题,ajax请求响应中如何拿到后台自定义的内容。
第一步加上这个自定义的字段
第二步响应内容
请求与响应
查看结果
阮一峰的网络日志
cors是一个w3c标准,全称是"跨域资源共享"(cross-origin resource sharing)。
它允许浏览器向跨源服务器,发出xmlhttprequest
请求,从而克服了ajax只能使用的限制。
本文详细介绍cors的内部机制。
(图片说明:摄于阿联酋艾因(al ain)的绿洲公园)
一、简介
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
凡是不同时满足上面两个条件,就属于非简单请求。
浏览器对这两种请求的处理,是不一样的。
三、简单请求
3.1 基本流程
对于简单请求,浏览器直接发出cors请求。具体来说,就是在头信息之中,增加一个origin
字段。
下面是一个例子,浏览器发现这次跨源ajax请求是简单请求,就自动在头信息之中,添加一个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...
上面的头信息中,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-
开头。
(1)access-control-allow-origin
该字段是必须的。它的值要么是请求时origin
字段的值,要么是一个*
,表示接受任意域名的请求。
(2)access-control-allow-credentials
该字段可选。它的值是一个布尔值,表示是否允许发送cookie。默认情况下,cookie不包括在cors请求之中。设为true
,即表示服务器明确许可,cookie可以包含在请求中,一起发给服务器。这个值也只能设为true
,如果服务器不要浏览器发送cookie,删除该字段即可。
(3)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
字段的值。
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.1 预检请求
非简单请求是那种对服务器有特殊要求的请求,比如请求方法是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
字段,"预检"请求的头信息包括两个特殊字段。
(1)access-control-request-method
该字段是必须的,用来列出浏览器的cors请求会用到哪些http方法,上例是put
。
(2)access-control-request-headers
该字段是一个逗号分隔的字符串,指定浏览器cors请求会额外发送的头信息字段,上例是x-custom-header
。
4.2 预检请求的回应
服务器收到"预检"请求以后,检查了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
上面的http回应中,关键的是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
(1)access-control-allow-methods
该字段必需,它的值是逗号分隔的一个字符串,表明服务器支持的所有跨域请求的方法。注意,返回的是所有支持的方法,而不单是浏览器请求的那个方法。这是为了避免多次"预检"请求。
(2)access-control-allow-headers
如果浏览器请求包括access-control-request-headers
字段,则access-control-allow-headers
字段是必需的。它也是一个逗号分隔的字符串,表明服务器支持的所有头信息字段,不限于浏览器在"预检"中请求的字段。
(3)access-control-allow-credentials
该字段与简单请求时的含义相同。
(4)access-control-max-age
该字段可选,用来指定本次预检请求的有效期,单位为秒。上面结果中,有效期是20天(1728000秒),即允许缓存该条回应1728000秒(即20天),在此期间,不用发出另一条预检请求。
4.3 浏览器的正常请求和回应
一旦服务器通过了"预检"请求,以后每次浏览器正常的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的网站请求数据。