CORS解决跨域问题

2024-02-21 16:56:58

参考：
http://www.ruanyifeng.com/blog/2016/04/cors.html
https://blog.51cto.com/15089766/2602513

CORS解决跨域问题

一、什么是CORS

CORS是一个W3C标准，全称是"跨域资源共享"（Cross-origin resource sharing）。跨域资源共享（CORS）是一个浏览器和服务器之间关于跨域问题的协议。

它允许浏览器向跨源服务器，发出XMLHttpRequest请求，从而克服了AJAX只能同源使用的限制。

CORS需要浏览器和服务器同时支持。实现CORS通信的关键是服务器。 只要服务器实现了CORS接口，就可以跨源通信。

浏览器端：

目前，所有浏览器都支持该功能（IE10以下不行）。整个CORS通信过程，都是浏览器自动完成，不需要用户参与。
注意：ie下 localhost:8000=localhost:8001=localhost 视为同域，以免本地进行测试的时候踩坑。
服务端：

CORS通信与AJAX没有任何差别，因此不需要改变以前的业务逻辑。只不过，浏览器会在请求中携带一些头信息，以此判断是否运行其跨域，然后在响应头中加入一些信息即可。这一般通过过滤器完成即可。

二、原理

浏览器会将ajax请求分为两类，其处理方案略有差异：简单请求（simple request）和非简单请求（not-so-simple request）。

1. 简单请求

只要同时满足以下两大条件，就属于简单请求：

（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

当浏览器发现发现的ajax请求是简单请求时，会在请求头中携带一个字段：Origin

Origin中会指出当前请求属于哪个域（协议+域名+端口）。服务会根据这个值决定是否允许其跨域。

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

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

Access-Control-Allow-Origin: 一个域名/*  
Access-Control-Allow-Credentials: true  
Access-Control-Expose-Headers: XXX
Content-Type: text/html; charset=utf-8

上面的头信息之中，有三个与CORS请求相关的字段，都以Access-Control- 开头。

Access-Control-Allow-Origin：该字段是必须的。它的值要么是请求时Origin字段的值，要么是一个*，表示接受任意域名的请求。

Access-Control-Allow-Credentials：该字段可选。它的值是一个布尔值，表示是否允许发送Cookie。默认情况下，cors不会携带cookie。设为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(‘XXX’)可以返回XXX字段的值。

注意：
如果跨域请求要想操作cookie，需要满足3个条件：

服务的响应头中需要携带 Access-Control-Allow-Credentials 并且为 true

浏览器发起ajax需要指定withCredentials 为 true
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
响应头中的Access-Control-Allow-Origin一定不能为 * ，必须是指定的域名。

注意：Cookie依然遵循同源政策，只有用服务器域名设置的Cookie才会上传，其他域名的Cookie并不会上传，且（跨源）原网页代码中的document.cookie也无法读取服务器域名下的Cookie。

2. 非简单请求

非简单请求是那种对服务器有特殊要求的请求，比如请求方法是PUT或DELETE，或者Content-Type字段的类型是application/json。非简单请求会在正式通信之前，增加一次HTTP查询请求，称为"预检"请求（preflight）。

预检请求

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

var url = 'http://api.boc.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.boc.com
Access-Control-Request-Method: PUT
Access-Control-Request-Headers: X-Custom-Header
Host: api.tangyu.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.boc.com
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, PUT
Access-Control-Allow-Headers: X-Custom-Header
Access-Control-Max-Age: 1728000
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.boc.com 可以请求数据。该字段也可以设为星号，表示同意任意跨源请求。

除了Access-Control-Allow-Origin和Access-Control-Allow-Credentials以外，这里又额外多出3个头：

Access-Control-Allow-Methods：该字段必需，它的值是逗号分隔的一个字符串，表明服务器支持的所有跨域请求的方法。注意: 返回的是所有支持的方法，而不单是浏览器请求的那个方法。这是为了避免多次"预检"请求。

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

Access-Control-Max-Age：该字段可选，用来指定本次预检请求的有效期，单位为秒，由服务端和浏览器默认值共同决定。在此期间，不用发出另一条预检请求。
如果服务器否定了"预检"请求，会返回一个正常的HTTP回应，但是没有任何CORS相关的头信息字段。这时，浏览器就会认定，服务器不同意预检请求，因此触发一个错误，被XMLHttpRequest对象的onerror回调函数捕获。控制台会打印出如下的报错信息。
```
XMLHttpRequest cannot load http://api.tangyu.com.
Origin http://api.boc.com is not allowed by Access-Control-Allow-Origin.
```

浏览器的正常请求和回应

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

提升性能

预检请求，在大多数情况下，它会对响应时间造成很大的延迟，从而影响 web 应用程序的性能。

绕过预检请求或者减少预检响应时间，以提高 web 应用程序的性能。

1. 使用浏览器的预检缓存

如前所述，预检请求对应用程序性能有影响。根据前端调用 API 的数量，很可能会发送许多预检请求。
作为一种解决方案，预检缓存是减少影响的常用方法之一。这背后的原理很简单。
预检缓存的行为与任何其他缓存机制类似。每当浏览器发出预检请求时，它首先检查预检缓存，看看是否有对该请求的响应。如果浏览器找到了响应，它不会向服务器发送预检请求，而是使用缓存的响应。只有在预检缓存中没有找到响应时，浏览器才会发送预检请求。
Access-Control-Max-Age 响应头表示结果可以在浏览器缓存中缓存多长时间。

2. 使用代理、网关或负载均衡实现服务器端缓存

在前面的方法中，我们讨论了在浏览器中缓存预检请求的方法，现在我们来看看服务器端缓存。

尽管这种方法不是专门用于预检请求缓存，但我们可以使用代理、网关甚至像 AWS CloudFront 这样的 CDN 的默认缓存机制来减少预检请求延迟时间。

其思想就是通过缩短预检请求的传输距离来减少响应时间。

例如，以 AWS CloudFront CDN 为示例。它是一个代理，使用了一种被称为边缘位置（比原始服务器更接近用户的浏览器）的概念来拦截 HTTP 请求。

在这里，可以在边缘位置附近缓存预检响应，这样预检请求甚至不需要访问源服务器。

3. 使用代理、网关或负载均衡避免预检请求

可以通过同一个域同时服务前端和后端，我们就可以完全避免预检请求，因为此时不存在 CORS。

假设正在本地环境开发一个应用, 前端运行在 http://localhost:4200，后端运行在 http://localhost:3000/api。

必须在后端开启 CORS 才能在二者之间通信。但是，可以在前端配置简单的代理以在前后端之间形成映射，这样就可以完全避免 CORS。

只需要定义一个代理配置来转发前往 http://localhost:3000 的 /api 路径请求。然后在前端（http://localhost:4200/api/…）就可以请求同一域名下的后端 API，此时浏览器不会再发送任何预检请求。

在生产环境可以使用 API 网关，负载均衡，代理或者 CDN，比如 NGINX，Traefik，AWS CloudFront，AWS Application Load Balancer，Azure Application Gateway 来做基于路由的配置。

4. 简单请求

另一种避免预检请求的方法是使用简单请求。但是，简单请求的限制对于现代的 web 应用程序来说太过严格，我们不能限定在这些范围之内来为客户提供最佳的解决方案。例如，在简单请求中不允许使用授权头，现在几乎所有的 HTTP 请求都在使用授权头。

建议

建议只在必要时才使用 CORS，因为与启用后端 API 的同源访问来改善项目延迟的工作相比，我们可以节省大量开发时间。在这种情况下，可以很容易地使用代理配置、API 网关或负载均衡来减少麻烦。

但有些情况下无法避免 CORS。此时，可以简单地遵循浏览器缓存或服务器端缓存机制来最小化响应时间。

码农公寓

CORS解决跨域问题

一、什么是CORS

二、原理

1. 简单请求

2. 非简单请求

提升性能

1. 使用浏览器的预检缓存

2. 使用代理、网关或负载均衡实现服务器端缓存

3. 使用代理、网关或负载均衡避免预检请求

4. 简单请求

建议

相关文章