写点什么

如何通过 Nginx 解决跨域问题

作者:观测云
  • 2022 年 9 月 28 日
    上海
  • 本文字数:6426 字

    阅读完需:约 21 分钟

如何通过 Nginx 解决跨域问题

一、简介

CORS(Cross-Origin Resources sharding)


CORS 是一个 W3C 标准,全称是"跨域资源共享"(Cross-origin resource sharing)。


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


本文详细介绍 CORS 的内部机制。


CORS 需要浏览器和服务器同时支持。目前,所有浏览器都支持该功能,IE 浏览器不能低于 IE10。


整个 CORS 通信过程,都是浏览器自动完成,不需要用户参与。对于开发者来说,CORS 通信与同源的 AJAX 通信没有差别,代码完全一样。浏览器一旦发现 AJAX 请求跨源,就会自动添加一些附加的头信息,有时还会多出一次附加的请求,但用户不会有感觉。


因此,实现 CORS 通信的关键是服务器。只要服务器实现了 CORS 接口,就可以跨源通信。

二、跨域请求类型

浏览器将 CORS 请求分成两类:简单请求(simple request)和非简单请求(not-so-simple request)。


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


(1) 请求方法是以下三种方法之一:


HEADGETPOST
复制代码


(2)HTTP 的头信息不超出以下几种字段:


AcceptAccept-LanguageContent-LanguageLast-Event-ID
复制代码


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


凡是不同时满足上面两个条件,就属于非简单请求。


浏览器对这两种请求的处理,是不一样的。

三、简单请求

3.1 基本流程

对于简单请求,浏览器直接发出 CORS 请求。具体来说,就是在头信息之中,增加一个 Origin 字段。


下面是一个例子,浏览器发现这次跨源 AJAX 请求是简单请求,就自动在头信息之中,添加一个 Origin 字段。


GET /cors HTTP/1.1Origin: 'https://www.guance.com'Host: 'www.jiagouyun.com'Accept-Language: en-USConnection: keep-aliveUser-Agent: Mozilla/5.0
复制代码


上面的头信息中,Origin 字段用来说明,本次请求来自哪个源(协议 + 域名 + 端口)。服务器根据这个值,决定是否同意这次请求。


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


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


Access-Control-Allow-Origin: 'https://www.guance.com'Access-Control-Allow-Credentials: trueAccess-Control-Expose-Headers: FooBarContent-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://www.jiagouyun.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.1Origin: https://www.guance.comAccess-Control-Request-Method: PUTAccess-Control-Request-Headers: X-Custom-HeaderHost: www.jiagouyun.comAccept-Language: en-USConnection: keep-aliveUser-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 OKDate: Mon, 01 Dec 2008 01:15:39 GMTServer: Apache/2.0.61 (Unix)Access-Control-Allow-Origin: 'https://www.guance.com'Access-Control-Allow-Methods: GET, POST, PUTAccess-Control-Allow-Headers: X-Custom-HeaderContent-Type: text/html; charset=utf-8Content-Encoding: gzipContent-Length: 0Keep-Alive: timeout=2, max=100Connection: Keep-AliveContent-Type: text/plain
复制代码


上面的 HTTP 回应中,关键的是 Access-Control-Allow-Origin 字段,表示 https://www.guance.com 可以请求数据。该字段也可以设为通配符 ' * ',表示同意任意跨源请求。


Access-Control-Allow-Origin: *
复制代码


如果浏览器否定了"预检"请求,会返回一个正常的 HTTP 回应,但是没有任何 CORS 相关的头信息字段。这时,浏览器就会认定,服务器不同意预检请求,因此触发一个错误,被 XMLHttpRequest 对象的 onerror 回调函数捕获。控制台会打印出如下的报错信息。


XMLHttpRequest cannot load "http://www.jiagouyun.com"Origin "https://www.guance.com" is not allowed by Access-Control-Allow-Origin.
复制代码


服务器回应的其他 CORS 相关字段如下。


Access-Control-Allow-Methods: GET, POST, PUTAccess-Control-Allow-Headers: X-Custom-HeaderAccess-Control-Allow-Credentials: trueAccess-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.1Origin: 'https://www.guance.com'Host: 'www.jiagouyun.com'X-Custom-Header: valueAccept-Language: en-USConnection: keep-aliveUser-Agent: Mozilla/5.0
复制代码


上面头信息的 Origin 字段是浏览器自动添加的。


下面是服务器正常的回应。


Access-Control-Allow-Origin: 'https://www.guance.com'Content-Type: text/html; charset=utf-8
复制代码


上面头信息中,Access-Control-Allow-Origin 字段是每次回应都必定包含的。

五、与 JSONP 的比较

5.1 CORS 与 JSONP 的使用目的相同,但是比 JSONP 更强大。

JSONP 只支持 GET 请求,CORS 支持所有类型的 HTTP 请求。JSONP 的优势在于支持老式浏览器,以及可以向不支持 CORS 的网站请求数据。


注:有的浏览器不允许 https 跨站访问 http 网站。

六、常见跨域配置示例

6.1 单域名跨域请求

server {listen 80;server_name *.51fugj.com;add_header Access-Control-Allow-Origin 'https://docs.guance.com';add_header Access-Control-Allow-Headers Origin,Accept,Authorization,platformId,ut,DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type;add_header Access-Control-Allow-Methods GET,POST,OPTIONS;add_header Access-Control-Allow-Credentials true;
location ^~/ {index index.html;proxy_pass http://frontier.egeo.com/appUnion/;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;break;}
复制代码

6.2 多域名跨域请求


map $http_origin $corsHost { default 0; "~http://boss.guance.com" http://boss.guance.com; "~http://auth.guance.com" http://auth.guance.com;}server { listen 80; server_name www.jiagouyun.com; location / { if ($request_method = 'OPTIONS') { return 204; } root /usr/share/nginx/html; index index.html index.htm; add_header 'Access-Control-Allow-Origin' $corsHost; add_header 'Access-Control-Max-Age' 86400; add_header 'Access-Control-Allow-Credentials' 'true'; add_header 'Access-Control-Allow-Headers' 'Authorization,Content-Type,Accept,Origin,User-Agent,DNT,Cache-Control,X-Mx-ReqToken,X-Requested-With'; add_header 'Access-Control-Allow-Methods' 'GET,POST,OPTIONS';
}}
复制代码



server { listen 80; server_name www.jiagouyun.com; location / { root /usr/share/nginx/html; index index.html index.htm; set $cors ''; if ($http_origin ~* 'https?://(localhost|boss.guance.com.com|auth.guance.com)') { set $cors 'true'; }
if ($cors = 'true') { add_header 'Access-Control-Allow-Origin' "$http_origin"; add_header 'Access-Control-Allow-Credentials' 'true'; add_header 'Access-Control-Allow-Methods' 'GET,POST,OPTIONS'; add_header 'Access-Control-Allow-Headers' 'Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Mx-ReqToken,X-Requested-With'; }
if ($request_method = 'OPTIONS') { return 204; } }}
复制代码



server { listen 80; server_name www.jiagouyun.com; location / { root /usr/share/nginx/html; index index.html index.htm; if ( $http_origin ~ http://(.*).guance.com){ set $allow_url $http_origin; } #CORS(Cross Orign Resource-Sharing)跨域控制配置 #是否允许请求带有验证信息 add_header 'Access-Control-Allow-Credentials' 'true'; #允许跨域访问的域名,可以是一个域的列表,也可以是通配符* add_header 'Access-Control-Allow-Origin' "$allow_url"; #允许脚本访问的返回头 add_header 'Access-Control-Allow-Headers' 'x-requested-with,content-type,Cache-Control,Pragma,Date,x-timestamp'; #允许使用的请求方法,以逗号隔开 add_header 'Access-Control-Allow-Methods' 'POST,GET,OPTIONS,PUT,DELETE'; #允许自定义的头部,以逗号隔开,大小写不敏感 add_header 'Access-Control-Expose-Headers' 'WWW-Authenticate,Server-Authorization'; #P3P支持跨域cookie操作 add_header P3P 'policyref="/w3c/p3p.xml", CP="NOI DSP PSAa OUR BUS IND ONL UNI COM NAV INT LOC"'; }}
复制代码

6.3 按请求方法区分跨域


server{ listen 80; server_name www.jiagouyun.com; root root /usr/share/nginx/html; location / { if ($request_method = 'OPTIONS') { add_header 'Access-Control-Allow-Origin' '*'; add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS'; add_header 'Access-Control-Allow-Headers' 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type'; add_header 'Access-Control-Max-Age' 864000; add_header 'Content-Type' 'text/plain charset=UTF-8'; add_header 'Content-Length' 0; return 204; } if ($request_method = 'POST') { add_header 'Access-Control-Allow-Origin' '*'; add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS'; add_header 'Access-Control-Allow-Headers' 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type'; } if ($request_method = 'GET') { add_header 'Access-Control-Allow-Origin' '*'; add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS'; add_header 'Access-Control-Allow-Headers' 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type'; } }}
复制代码


用户头像

观测云

关注

还未添加个人签名 2021.02.08 加入

云时代的系统可观测平台

评论

发布
暂无评论
如何通过 Nginx 解决跨域问题_观测云_InfoQ写作社区