小皮博客 | Xiaopi's Blog

99-跨域请求详解

以前每次遇到跨域的问题,都是case by case解决掉了,从来没有系统的分析过这里面的原理,这次整理一下各种框架和情况下会遇到的问题。

跨域问题解释

跨域访问,是指浏览器在一个网站下不能执行其他网站的脚本,它是由浏览器的同源策略造成的,是浏览器对JavaScript试试的安全限制。

同源策略限制了以下行为:

  • Cookie、LocalStorage和IndexDB无法读取。
  • DOM和JS对象无法获取。
  • Ajax请求发送不出去。

跨域场景说明

跨域的反义词是同源,那么同源是指的域名、端口、协议均相同。

http://www.xiaoyuyu.net/index.html 调用 http://www.xiaoyuyu.net/helloworld.do 非跨域

http://www.xiaoyuyu.net/index.html 调用 http://www.baidu.com/helloworld.do 跨域,主域名不同。

http://www.xiaoyuyu.net/index.html 调用 http://blog.xiaoyuyu.net/hello.do 跨域,子域名不同。

http://www.xiaoyuyu.net/index.html 调用 http://www.xiaoyuyu.net:8080/hello.do 跨域,端口不同

http://www.xiaoyuyu.net/index.html 调用 https://www.xiaoyuyu.net/hello.do 跨域,协议不同

localhost 调用127.0.0.1 跨域,IP不同(浏览器并不会去查路由表)

解决方案-降低浏览器安全策略

由于跨域限制是浏览器行为,所以首先可以通过降低浏览器安全策略的方式来进行调试。这种方式适用于联调阶段且生产环境最后是同源的情况。比如开发在本地进行联调,最后代码会部署到同源的服务器上。这样做的意义在于不要为了解决跨域问题引入跨站攻击(当然跨站攻击应该额外防御)。

Chrome

mkdir ~/.chrome-config-for-cors # 文件夹是用来保存关闭安全策略后的用户信息的

open -n /Applications/Google\ Chrome.app/ –args –disable-web-security –user-data-dir=~/.chrome-config-for-cors

Firefox

  • 进入浏览器配置页,浏览器地址栏输入: about:config
  • 点击我了解此风险。
  • 搜索 security.fileuri.strict_origin_policy, 设置为false
  • 重启浏览器

跨域解决方案-技术方案

如果本来就需要使用非同源策略来进行最终的生产环境部署,那么我们不应该采用上面的策略。

JSONP跨域

jsonp跨域其实也是JavaScript设计模式中的一种代理模式,在HTML页面中通过相应的标签从不同域名下加载静态资源文件是被浏览器允许的,所以可以用这种方式先绕过跨域限制。一般我们可以动态的创建Script标签,再去请求一个带参数网址来实现跨域通信。

原生方式实现

let script = document.createElement('script');

script.src = 'http://www.xiaoyuyu.net/login?username=shengl&callback=callback';

document.body.appendChild(script);

function callback(res) {
    console.log(res);
}

JQuery方式实现

$.ajax({
    url: "http://www.xiaoyuyu.net/login',
    type: "GET",
    dataType: "jsonp", // 请求方式为jsonp
    jsonpCallback: "callback",
    data: {
        "username": "shengl"
    }
})

使用JSONP只能满足GET请求。

document.domain + iframe跨域

这种跨域方式主要要求主域名相同。
假设a.xiaoyuyu.net和b.xiaoyuyu.net分别指向不同ip的服务器。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
// a.xiaoyuyu.net/text.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>html</title>
<script type="text/javascript" src = "jquery-1.12.1.js"></script>
</head>
<body>
<div>A页面</div>
<iframe
style = "display : none"
name = "iframe1"
id = "iframe"
src="http://b.xiaoyuyu.net/1.html" frameborder="0"></iframe>
<script type="text/javascript">
$(function(){
try{
document.domain = "xiaoyuyu.net"
}catch(e){}
$("#iframe").load(function(){
var jq = document.getElementById('iframe').contentWindow.$
jq.get("http:/xiaoyuyu.net/test.json",function(data){
console.log(data);
});
})
})
</script>
</body>
</html>

跨域资源共享CORS

目前主流的跨域解决方案

简介

  • CORS是一个W3C标准,全称是“跨域资源共享”(Cross-Origin Resource Sharing)。他允许浏览器向跨院服务器发出XMLHttpRequest请求,从而克制AJAX只能同源使用的限制。
  • CORS需要浏览器和服务器同时支持,IE8以下不能支持,IE8/IE9需要使用XDomainRequest对象来支持CORS。
  • 整个CORS通信过程都是浏览器自动完成,不需要用户参与。对于开发者来说,CORS通信与同源的AJAX通信没有差别。浏览器一旦发现AJAX请求跨源,就会自动添加一些附加的头信息,有时候还会多出一次附加请求。

两种请求

在此场景下分为两种请求,一种是简单请求,一种是非简单请求。简单请求的条件如下:

  • 请求方式为HEAD、POST或者GET。
  • http头信息不超过以下字段:Accept、Accept-Language、Content-Language、Last-Event-ID、Content-Type(限于三个值: application/x-www-form-urlencoded、multipart/form-data、text/plain)
  • 浏览器对于简单请求和非简单请求的处理方式不同。

简单请求基本流程

对于简单请求,浏览器直接发出CORS请求。具体来说,就是在头信息中加一个origin字段。下面是一个例子,浏览器发现这次跨源AJAX请求是简单请求,就自动在头信息之中,添加一个Origin字段。

1
2
3
4
5
6
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指定的域名在许可范围内,服务器返回的响应,会多出几个头信息字段。

1
2
3
4
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-开头

Access-Control-Allow-Origin :该字段是必须的。它的值要么是请求时Origin字段的值,要么是一个*,表示接受任意域名的请求
Access-Control-Allow-Credentials: 该字段可选。它的值是一个布尔值,表示是否允许发送Cookie。默认情况下,Cookie不包括在CORS请求之中。设为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里面指定

withCredentials 属性

上面说到,CORS请求默认不发送Cookie和HTTP认证信息。如果要把Cookie发到服务器,一方面要服务器同意,指定Access-Control-Allow-Credentials字段。
另一方面,开发者必须在AJAX请求中打开withCredentials属性。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
var xhr = new XMLHttpRequest(); // IE8/9需用window.XDomainRequest兼容

// 前端设置是否带cookie
xhr.withCredentials = true;

xhr.open('post', 'http://www.domain2.com:8080/login', true);
xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
xhr.send('user=admin');

xhr.onreadystatechange = function() {
if (xhr.readyState == 4 && xhr.status == 200) {
alert(xhr.responseText);
}
};

// jquery
$.ajax({
...
   xhrFields: {
       withCredentials: true // 前端设置是否带cookie
   },
   crossDomain: true, // 会让请求头中包含跨域的额外信息,但不会含cookie
...
});

否则即使服务器同意发送cookie,浏览器也不会发送。或者服务器要求设置Cookie,浏览器也不会处理。但是如果省略withCredentials设置,有的浏览器还是会一起发送Cookie。这时可以显式关闭withCredentials。
需要注意的是,如果要发送cookie,Access-Control-Allow-Origin就不能设置为星号,必须指定明确的,与请求网页一致的域名。同时Cookie依然需要遵循同源策略,只有用服务器域名设置的Cookie才会上传,其他域名的Cookie并不会上传,且(跨源)原网页代码中的document.cookie也无法读取服务器域名下的Cookie。

非简单请求

非简单请求是那种对服务器有特殊要求的请求,比如请求方法是PUT或DELETE,或者Content-Type字段的类型是application/json。
非简单请求的CORS请求,会在正式通信之前,增加一次HTTP查询请求,称为”预检”请求(preflight)。
浏览器先询问服务器,当前网页所在的域名是否在服务器的许可名单之中,以及可以使用哪些HTTP动词和头信息字段。只有得到肯定答复,浏览器才会发出正式的XMLHttpRequest请求,否则就报错。

1
2
3
4
5
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头信息。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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,表示请求来自于哪个源。
* Access-Control-Request-Method: 该字段是必须的,用来列出浏览器的CORS请求会用到哪些HTTP方法,比如这里的PUT。
* Access-Control-Request-Headers:该字段是一个逗号分隔的字符串,指定浏览器CORS请求会额外发送的头信息字段,上例是X-Custom-Header

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

```html
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可以请求数据。该字段也可以设为星号,表示同意任意跨源请求。
如果浏览器否定了”预检”请求,会返回一个正常的HTTP回应,但是没有任何CORS相关的头信息字段。这时,浏览器就会认定,服务器不同意预检请求,因此触发一个错误,被XMLHttpRequest对象的onerror回调函数捕获。控制台会打印出如下的报错信息。
服务器回应的其他CORS相关字段如下:

1
2
3
4
Access-Control-Allow-Methods: GET, POST, PUT
Access-Control-Allow-Headers: X-Custom-Header
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 1728000
  • Access-Control-Allow-Methods:该字段必需,它的值是逗号分隔的一个字符串,表明服务器支持的所有跨域请求的方法。注意,返回的是所有支持的方法,而不单是浏览器请求的那个方法。这是为了避免多次”预检”请求。
  • Access-Control-Allow-Headers:如果浏览器请求包括Access-Control-Request-Headers字段,则Access-Control-Allow-Headers字段是必需的。它也是一个逗号分隔的字符串,表明服务器支持的所有头信息字段,不限于浏览器在”预检”中请求的字段。
  • Access-Control-Allow-Credentials: 该字段与简单请求时的含义相同。
  • Access-Control-Max-Age: 该字段可选,用来指定本次预检请求的有效期,单位为秒。上面结果中,有效期是20天(1728000秒),即允许缓存该条回应1728000秒(即20天),在此期间,不用发出另一条预检请求。

浏览器正常请求回应

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

1
2
3
4
5
6
7
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请求。上面头信息的Origin字段是浏览器自动添加的。下面是服务器正常的回应。

1
2
Access-Control-Allow-Origin: http://api.bob.com
Content-Type: text/html; charset=utf-8

Access-Control-Allow-Origin字段是每次回应都必定包含的。

结论

CORS与JSONP的使用目的相同,但是比JSONP更强大。JSONP只支持GET请求,CORS支持所有类型的HTTP请求。JSONP的优势在于支持老式浏览器,以及可以向不支持CORS的网站请求数据。

WebSocket协议跨域

  • WebSocket protocol是HTML5一种新的协议。它实现了浏览器与服务器全双工通信,同时允许跨域通讯,是server push技术的一种很好的实现。
  • 原生WebSocket API使用起来不太方便,我们使用Socket.io,它很好地封装了webSocket接口,提供了更简单、灵活的接口,也对不支持webSocket的浏览器提供了向下兼容。

前端代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<div>user input:<input type="text"></div>
<script src="./socket.io.js"></script>
<script>
var socket = io('http://www.domain2.com:8080');

// 连接成功处理
socket.on('connect', function() {
// 监听服务端消息
socket.on('message', function(msg) {
console.log('data from server: ---> ' + msg);
});

// 监听服务端关闭
socket.on('disconnect', function() {
console.log('Server socket has closed.');
});
});

document.getElementsByTagName('input')[0].onblur = function() {
socket.send(this.value);
};
</script>

node server

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
var http = require('http');
var socket = require('socket.io');

// 启http服务
var server = http.createServer(function(req, res) {
res.writeHead(200, {
'Content-type': 'text/html'
});
res.end();
});

server.listen('8080');
console.log('Server is running at port 8080...');

// 监听socket连接
socket.listen(server).on('connection', function(client) {
// 接收信息
client.on('message', function(msg) {
client.send('hello:' + msg);
console.log('data from client: ---> ' + msg);
});

// 断开处理
client.on('disconnect', function() {
console.log('Client socket has closed.');
});
});

node代理跨域

  • node中间件实现跨域代理,是通过启一个代理服务器,实现数据的转发,也可以通过设置 * cookieDomainRewrite参数修改响应头中cookie中域名,实现当前域的cookie写入,方便接口登录认证。
  • 利用node + express + http-proxy-middleware搭建一个proxy服务器

前端代码

1
2
3
4
5
6
7
8
var xhr = new XMLHttpRequest();

// 前端开关:浏览器是否读写cookie
xhr.withCredentials = true;

// 访问http-proxy-middleware代理服务器
xhr.open('get', 'http://www.domain1.com:3000/login?user=admin', true);
xhr.send();

后端代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
var express = require('express');
var proxy = require('http-proxy-middleware');
var app = express();

app.use('/', proxy({
// 代理跨域目标接口
target: 'http://www.domain2.com:8080',
changeOrigin: true,

// 修改响应头信息,实现跨域并允许带cookie
onProxyRes: function(proxyRes, req, res) {
res.header('Access-Control-Allow-Origin', 'http://www.domain1.com');
res.header('Access-Control-Allow-Credentials', 'true');
},

// 修改响应信息中的cookie域名
cookieDomainRewrite: 'www.domain1.com' // 可以为false,表示不修改
}));

app.listen(3000);
console.log('Proxy server is listen at port 3000...');

VUE-CLI解决跨域

  • 首先创建项目
1
vue init webpack cors
  • 在vue-cli项目文件夹中找到/config/index.js,找到proxyTable: {} 加入如下配置:
1
2
3
4
5
6
7
8
9
 proxyTable: {
'/v1': {
target: 'http://tingapi.ting.baidu.com', //需要代理的网址
changeOrigin: true,
pathRewrite: {
'^/v1': '/v1'
}
}
},
  • 在/src/main.js中引入axios
1
2
import axios from 'axios'
Vue.prototype.$http = axios;
  • 在vue-cli项目中找到/src/App.vue 在方法中添加如下代码:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<template>
<div id="app">
<button v-on:click="sbt">访问跨域</button>
</div>
</template>

<script>
import axios from 'axios'
import VueAxios from 'vue-axios'

export default {
name: 'App',
methods: {
sbt: function() {
this.$http.get("/v1/restserver/ting?type=1&size=30&offset=0&method=baidu.ting.billboard.billList").then(m=>console.log(m));
}
}
}

参考文献

https://www.jianshu.com/p/abbfe1143ff1
https://juejin.im/post/5a2f92c65188253e2470f16d

版权声明

本文标题:99-跨域请求详解

文章作者:盛领

发布时间:2020年05月31日 - 15:20:08

原始链接:http://blog.xiaoyuyu.net/post/2b54d784.html

许可协议: 署名-非商业性使用-禁止演绎 4.0 国际 转载请保留原文链接及作者。

如您有任何商业合作或者授权方面的协商,请给我留言:sunsetxiao@126.com

盛领 wechat
欢迎您扫一扫上面的微信公众号,订阅我的博客!
坚持原创技术分享,您的支持将鼓励我继续创作!