跨域资源共享 CORS 详解

一、简介

1.1 跨域

URL的格式为：协议+域名+端口号+资源地址
示例：https://www.baidu.com/
只要协议、域名、端口号有一项不同，就可以认为是不同的域。不同的域之间互相访问资源，就被称为跨域。

1.2 CORS

CORS是一个w3c标准，全称是跨域资源共享（Cross-origin resource sharing）。它允许浏览器向跨源服务器发出XMLHttpRequest请求，从而克服AJAX只能同源使用的限制。

1.3 如何实现CORS

CORS需要浏览器和服务器同时支持。目前所有的浏览器都支持该功能，IE浏览器不能低于IE10。整个CORS通信过程，都是浏览器自动完成，不需要用户参与。对于开发者来说，CORS通信与同源的AJAX通信没有差别，代码完全一样。浏览器一旦发现AJAX请求跨域，就会自动添加一些附加的头信息，有时还会多出一次附加的请求，但用户不会有感觉。

因此，实现CORS通信的关键是服务器。只要服务器实现了CORS接口，就可以跨源通信。每一个页面需要http相应中返回一个名为Access-Control-Allow-Origin响应头来允许外域的站点访问。即如果一个请求需要允许跨域访问，则需要在http响应头中设置Access-Control-Allow-Origin响应头来决定需要允许哪些站点来访问，假如需要允许 https://www.baidu.com/ 这个站点的请求跨域，则可以设置：Access-Control-Allow-Origin:https://www.baidu.com/ 。

二、talk is easy，show me the code

既然已经知道了CORS可以解决跨域，也知道了如何设置。看下代码里如何设置，其实在nginx层也可以处理的这里暂时展示在代码里如何解决跨域。

2.1 跨域的现象

有如下接口

package com.lucky.spring.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * Created by zhangdd on 2020/9/4
 *
 * 测试跨域
 */
@Controller
@ResponseBody
public class CorsController {

    @GetMapping("/cross/fun")
    public String fun(){
        return "success";
    }
}

我们在 https://www.baidu.com/ 这个页面执行如下脚本，注意这里是PUT请求

var url = 'http://127.0.0.1:8080/cross/fun';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url, true);
xhr.send();

打开任意网站，这里以百度 https://www.baidu.com/ 为例
按F12打开调试页面，在console面板里输入上面的js脚本
- 即在当前https://www.baidu.com/ 域下访问其他域 http://127.0.0.1:8080 的资源
输入完之后按回车就可以返回结果
- 我们看到返回一个错误 Access to XMLHttpRequest at 'http://127.0.0.1:8080/cross/fun' from origin 'https://www.baidu.com' has been blocked by CORS policy: Response to preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource. 从www.baidu.com这里发起访问127.0.0.1:8080的请求被CORS policy策略阻塞了，预请求的返回结果没有通过，在请求头里没有Access-Control-Allow-Origin这个内容。
另外打开network面板，看到两次错误的请求
- 一次是预请求返回403，如下图所示 OPTIONS 表示此次请求是预请求
- 另外一个错误的请求就是每有发送的资源请求，如果预请求通过这个请求会执行。如下图所示：

2.2 解决跨域

看到了跨域现象，知道了如何解决跨域。这里就来解决跨域。这里是在Spring boot环境下处理跨域问题。解决思路如下：

实现WebMvcConfigurer接口
重写addCorsMappings方法

package com.lucky.spring.config;

import com.lucky.spring.interceptor.WebInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * Created by zhangdd on 2020/8/25
 */
@Configuration
public class WebConfigurer implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new WebInterceptor())
                .excludePathPatterns("/error");
    }

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**").
                allowedOrigins("https://www.baidu.com", "https://zhangdd.com")//必须字段，允许跨域的域名，可以用*表示允许任何域名使用
        //.allowedMethods("*")//可选字段，允许跨域的方法，使用*表示允许任何方法
        //.allowCredentials(true)//可选字段，布尔值，表示是否允许发送cookie信息
        //.allowedHeaders("*")//允许任何请求头
        //.exposedHeaders("name")//可选字段，指定响应头里的字段信息
        //.maxAge(1000) //可选字段，用来指定本次预检请求的有效期，单位为秒
        ;
    }
}

发送如下代码，注意这里改成了GET请求，因为访问的接口是GetMapping。

var url = 'http://127.0.0.1:8080/cross/fun';
var xhr = new XMLHttpRequest();
xhr.open('GET', url, true);
xhr.send();

结果如下图所示：通过了跨域请求

三、两种请求

浏览器将CORS请求分成两类：简单请求（simple request）和非简单请求（not-so-simple request）。
只要同时满足以下两大条件，就属于简单请求。

请求方法是以下三种方法之一：

HEAD

GET

POST

HTTP的头信息不超过以下几种字段：

Accept

Accept-Language

Content-Language

Last-Event-ID

Content-Type只限于三个值application/x-www-form-urlencoded、multipart/form-data、text/plain

凡是不同时满足上面两个条件，就属于非简单请求。浏览器对这两种请求的处理，是不一样的。

上面的演示流程，可以看出非简单请求会发出一次预请求。

四、简单请求

4.1 基本流程

对于简单请求，浏览器直接发出CORS请求。具体来说，就是在头信息之中，自动增加一个origin字段。origin字段用来说明，本次请求来自哪个源（协议+域名+端口）。服务器根据这个值，决定是否同意这次请求。

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

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

Access-Control-Allow-Origin

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

Access-Control-Allow-Credentials

该字段可选。它的值是一个布尔值，表示是否允许发送Cookie。默认情况下，Cookie不包括在CORS请求之中。设为true，即表示服务器明确许可，Cookie可以包含在请求中，一起发给服务器。这个值也只能设为true，如果服务器不要浏览器发送Cookie，删除该字段即可。

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

另一方面，开发者必须在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。

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.1 预检请求

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

非简单请求的CORS请求，会在正式通信之前，增加一次HTTP查询请求，称为预检请求preflight。

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

var url = 'http://127.0.0.1:8080/cross/fun';
var xhr = new XMLHttpRequest();
xhr.open('GET', url, true);
xhr.setRequestHeader('X-Custom-Header', 'value');
xhr.send();

上面代码中，在发送HTTP请求是设置了一个自定义的头信息。浏览器发现，这是一个非简单请求，就自动发出一个预检请求，要求服务器确认可以这样请求。如下图所示：

预检请求用的方法是OPTIONS，表示这个请求是用来询问的。
头信息里面关键字origin表示请求来自哪个源。

除了origin字段，预检请求的头信息里还包括两个特殊字段：

Access-Control-Request-Method

该字段是必须的，用来列出浏览器的CORS请求会用到哪些HTTP方法，上例是GET

Access-Control-Request-Headers

该字段是一个逗号分隔的字符串，指定浏览器CORS请求会额外发送的头信息字段，上例是X-Custom-Header。

5.2 预检请求的回应

服务器收到"预检"请求以后，检查了Origin、Access-Control-Request-Method和Access-Control-Request-Headers字段以后，确认允许跨源请求，就可以做出回应。

上面的HTTP回应中，关键的是Access-Control-Allow-Origin字段，表示htts://www.baidu.com可以请求数据。该字段也可以设为星号，表示同意任意跨源请求。

如果服务器否定了预检请求，会返回一个正常的HTTP回应，但是没有任何CORS相关的头信息字段。这时，浏览器就会认定，服务器不同意预检检查，因此触发一个错误，被XMLHttpRequest对象的onerror回调函数捕获。还有一个返回字段没有提到：

Access-Control-Max-Age

该字段可选，用来指定本次预检请求的有效期，单位为秒。上面结果中，有效期是20天（1728000秒），即允许缓存该条回应1728000秒（即20天），在此期间，不用发出另一条预检请求。

到这里，跨域相关的东西就描述完了。

posted @ 2020-09-10 20:49 在线打工者阅读(588) 评论(0) 编辑收藏举报

刷新页面返回顶部

跨域资源共享 CORS 详解

跨域资源共享 CORS 详解

一、简介

1.1 跨域

1.2 CORS

1.3 如何实现CORS

二、talk is easy，show me the code

2.1 跨域的现象

2.2 解决跨域

三、两种请求

四、简单请求

4.1 基本流程

五、非简单请求

5.1 预检请求

5.2 预检请求的回应

公告