korey的前端笔记

Appearance

10 种常见的前端跨域解决方案（转） ​

原文链接 https://juejin.im/post/5d1ecb96f265da1b6d404433

什么是跨域 ​

当一个资源从与该资源本身所在的服务器不同的域、协议、端口请求一个资源时，资源会发起一个跨域 HTTP 请求。

出于安全原因，浏览器做出了一些限制，跨站请求可以正常发起，但是返回结果被浏览器拦截了。

什么是同源策略 ​

同源策略是一种约定，由 Netscape 公司 1995 年引入浏览器，它是浏览器最核心也最基本的安全功能，如果缺少了同源策略，浏览器很容易受到 XSS、CSRF 等攻击。所谓同源是指"协议+域名+端口"三者相同，即便两个不同的域名指向同一个 ip 地址，也非同源。

同源策略限制以下几种行为：

  • Cookie、LocalStorage 和 IndexDB 无法读取
  • DOM 和 JS 对象无法获得
  • AJAX 请求不能发送

常见的跨域场景 ​

URL说明是否允许通信
www.domain.com/a.js/
www.domain.com/b.js
www.domain.com/lab/c.js		同一域名，不同文件或路径允许
www.domain.com:8000/a.js
www.domain.com/b.js		同一域名，不同端口不允许
http://www.domain.com/a.js
https://www.domain.com/b.js		同一域名，不同协议不允许
http://www.domain.com/a.js
http://192.168.4.12/b.js		域名和域名对应相同 ip不允许
http://www.domain.com/a.js
http://x.domain.com/b.js
http://domain.com/c.js		主域相同，子域不同不允许
http://www.domain1.com/a.js
http://www.domain2.com/b.js		不同域名不允许

10 种跨域解决方案 ​

JSONP 跨域 ​

jsonp 的原理就是利用 <script> 标签没有跨域限制，通过 <script> 标签 src 属性，发送带有 callback 参数的 GET 请求，服务端将接口返回数据拼凑到 callback 函数中，返回给浏览器，浏览器解析执行，从而前端拿到 callback 函数返回的数据。

原生 JS 实现 ​

html
<script>
  var script = document.createElement('script');
  script.type = 'text/javascript';

  // 传参一个回调函数名给后端，方便后端返回时执行这个在前端定义的回调函数
  script.src = 'http://www.domain2.com:8080/login?user=admin&callback=handleCallback';
  document.head.appendChild(script);

  // 回调执行函数
  function handleCallback(res) {
    alert(JSON.stringify(res));
  }
</script>

服务端返回如下（返回时即执行全局函数）：

js
handleCallback({ success: true, user: 'admin' });

jquery Ajax 实现 ​

js
$.ajax({
  url: 'http://www.domain2.com:8080/login',
  type: 'get',
  dataType: 'jsonp', // 请求方式为jsonp
  jsonpCallback: 'handleCallback', // 自定义回调函数名
  data: {},
});

Vue axios 实现 ​

js
this.$http = axios;
this.\$http
  .jsonp('http://www.domain2.com:8080/login', {
    params: {},
    jsonp: 'handleCallback',
  })
  .then((res) => {
    console.log(res);
  });

后端 node.js 代码：

js
var querystring = require('querystring');
var http = require('http');
var server = http.createServer();

server.on('request', function (req, res) {
  var params = querystring.parse(req.url.split('?')[1]);
  var fn = params.callback;

  // jsonp返回设置
  res.writeHead(200, { 'Content-Type': 'text/javascript' });
  res.write(fn + '(' + JSON.stringify(params) + ')');

  res.end();
});

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

jsonp 的缺点：只能发送 get 一种请求。

跨域资源共享（CORS） ​

CORS 是一个 W3C 标准，全称是"跨域资源共享"（Cross-origin resource sharing）。它允许浏览器向跨源服务器，发出 XMLHttpRequest 请求，从而克服了 AJAX 只能同源使用的限制。CORS 需要浏览器和服务器同时支持。目前，所有浏览器都支持该功能，IE 浏览器不能低于 IE10。

更多参考

浏览器将 CORS 跨域请求分为 简单请求 和 非简单请求。

只要同时满足一下两个条件，就属于简单请求:

使用下列方法之一：

  • head
  • get
  • post

请求的 Heder 是：

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

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

简单请求 ​

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

sh
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 字段用来说明，本次请求来自哪个源（协议 + 域名 + 端口）。服务器根据这个值，决定是否同意这次请求。

CORS 请求设置的响应头字段，都以 Access-Control- 开头:

  • Access-Control-Allow-Origin：必选

    它的值要么是请求时 Origin 字段的值，要么是一个*，表示接受任意域名的请求，也可以设为动态 ${origin.protocol}//${origin.host} 支持所有访问者的地址

  • 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 里面指定。上面的例子指定，getResponseHeader('FooBar') 可以返回 FooBar 字段的值。

非简单请求 ​

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

预检请求 ​

预检请求用的请求方法是 OPTIONS，表示这个请求是用来询问的。请求头信息里面，关键字段是 Origin，表示请求来自哪个源。除了 Origin 字段，"预检"请求的头信息包括两个特殊字段。

sh
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..
  • 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 回应中，除了关键的是 Access-Control-Allow-Origin 字段，其他 CORS 相关字段如下：

  • Access-Control-Allow-Methods：必选

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

  • Access-Control-Allow-Headers

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

  • Access-Control-Allow-Credentials：可选

    该字段与简单请求时的含义相同。

  • Access-Control-Max-Age：可选

    用来指定本次预检请求的有效期，单位为秒。

请求附带身份凭证 -> cookies ​

如果发起请求时设置 withCredentials 标志设置为 true，从而向服务器发送 cookie， 但是如果服务器端的响应中未携带 Access-Control-Allow-Credentials: true，浏览器将不会把响应内容返回给请求的发送者

对于附带身份凭证的请求，服务器不得设置 Access-Control-Allow-Origin 的值为 *， 必须是某个具体的域名

CORS 跨域示例 ​

前端设置 ​

原生 ajax：

js
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：

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

nodejs 代码

js
var http = require('http');
var server = http.createServer();
var qs = require('querystring');

server.on('request', function (req, res) {
  var postData = '';

  // 数据块接收中
  req.addListener('data', function (chunk) {
    postData += chunk;
  });

  // 数据接收完毕
  req.addListener('end', function () {
    postData = qs.parse(postData);

    // 跨域后台设置
    res.writeHead(200, {
      'Access-Control-Allow-Credentials': 'true', // 后端允许发送Cookie
      'Access-Control-Allow-Origin': 'http://www.domain1.com', // 允许访问的域（协议+域名+端口）
      /*
       * 此处设置的cookie还是domain2的而非domain1，因为后端也不能跨域写cookie(nginx反向代理可以实现)，
       * 但只要domain2中写入一次cookie认证，后面的跨域接口都能从domain2中获取cookie，从而实现所有的接口都能跨域访问
       */
      'Set-Cookie': 'l=a123456;Path=/;Domain=www.domain2.com;HttpOnly', // HttpOnly的作用是让js无法读取cookie
    });

    res.write(JSON.stringify(postData));
    res.end();
  });
});

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

nginx 代理跨域 ​

nginx 代理跨域，实质和 CORS 跨域原理一样，通过配置文件设置请求响应头 Access-Control-Allow-Origin... 等字段。

nginx 配置解决 iconfont 跨域 ​

浏览器跨域访问 js、css、img 等常规静态资源被同源策略许可，但 iconfont 字体文件(eot|otf|ttf|woff|svg)例外，此时可在 nginx 的静态资源服务器中加入以下配置。

sh
location / {
    add_header Access-Control-Allow-Origin *;
}

nginx 反向代理接口跨域 ​

跨域问题：同源策略仅是针对浏览器的安全策略。服务器端调用 HTTP 接口只是使用 HTTP 协议，不需要同源策略，也就不存在跨域问题。

实现思路：通过 Nginx 配置一个代理服务器域名与 domain1 相同，端口不同）做跳板机，反向代理访问 domain2 接口，并且可以顺便修改 cookie 中 domain 信息，方便当前域 cookie 写入，实现跨域访问。

nginx 具体配置：

sh
#proxy 服务器
server {
listen 81;
server_name www.domain1.com;

    location / {
        proxy_pass   http://www.domain2.com:8080;  #反向代理
        proxy_cookie_domain www.domain2.com www.domain1.com; #修改cookie里域名
        index  index.html index.htm;

        # 当用webpack-dev-server等中间件代理接口访问nignx时，此时无浏览器参与，故没有同源限制，下面的跨域配置可不启用
        add_header Access-Control-Allow-Origin http://www.domain1.com;  #当前端只跨域不带cookie时，可为*
        add_header Access-Control-Allow-Credentials true;
    }

}

nodejs 中间件代理跨域 ​

node 中间件实现跨域代理，原理大致与 nginx 相同，都是通过启一个代理服务器，实现数据的转发，也可以通过设置 cookieDomainRewrite 参数修改响应头中 cookie 中域名，实现当前域的 cookie 写入，方便接口登录认证。

非 vue 框架的跨域 ​

使用 node + express + http-proxy-middleware 搭建一个 proxy 服务器。

前端代码：

js
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();

中间件服务器代码：

js
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 框架的跨域 ​

node + vue + webpack + webpack-dev-server 搭建的项目，跨域请求接口，直接修改 webpack.config.js 配置。开发环境下，vue 渲染服务和接口代理服务都是 webpack-dev-server 同一个，所以页面与代理接口之间不再跨域。

webpack.config.js 部分配置：

js
module.exports = {
  entry: {},
  module: {},
  //...
  devServer: {
    historyApiFallback: true,
    proxy: [
      {
        context: '/login',
        target: 'http://www.domain2.com:8080', // 代理跨域目标接口
        changeOrigin: true,
        secure: false, // 当代理某些 https 服务报错时用
        cookieDomainRewrite: 'www.domain1.com', // 可以为 false，表示不修改
      },
    ],
    noInfo: true,
  },
};

document.domain + iframe 跨域 ​

此方案仅限主域相同，子域不同的跨域应用场景。实现原理：两个页面都通过 js 强制设置 document.domain 为基础主域，就实现了同域。

  • 父窗口：(www.domain.com/a.html)
html
<iframe id="iframe" src="http://child.domain.com/b.html"></iframe>
<script>
  document.domain = 'domain.com';
  var user = 'admin';
</script>
  • 子窗口：(child.domain.com/a.html)
html
<script>
  document.domain = 'domain.com';
  // 获取父窗口中变量
  console.log('get js data from parent ---> ' + window.parent.user);
</script>

location.hash + iframe 跨域 ​

实现原理： a 欲与 b 跨域相互通信，通过中间页 c 来实现。 三个页面，不同域之间利用 iframe 的 location.hash 传值，相同域之间直接 js 访问来通信。

具体实现：A 域：a.html -> B 域：b.html -> A 域：c.html，a 与 b 不同域只能通过 hash 值单向通信，b 与 c 也不同域也只能单向通信，但 c 与 a 同域，所以 c 可通过 parent.parent 访问 a 页面所有对象。

  • a.html：(www.domain1.com/a.html)
html
<iframe id="iframe" src="http://www.domain2.com/b.html" style="display:none;"></iframe>
<script>
  var iframe = document.getElementById('iframe');

  // 向b.html传hash值
  setTimeout(function () {
    iframe.src = iframe.src + '#user=admin';
  }, 1000);

  // 开放给同域c.html的回调方法
  function onCallback(res) {
    alert('data from c.html ---> ' + res);
  }
</script>
  • b.html：(www.domain2.com/b.html)
html
<iframe id="iframe" src="http://www.domain1.com/c.html" style="display:none;"></iframe>
<script>
  var iframe = document.getElementById('iframe');

  // 监听a.html传来的hash值，再传给c.html
  window.onhashchange = function () {
    iframe.src = iframe.src + location.hash;
  };
</script>
  • c.html：(www.domain1.com/c.html)
html
<script>
  // 监听b.html传来的hash值
  window.onhashchange = function () {
    // 再通过操作同域a.html的js回调，将结果传回
    window.parent.parent.onCallback('hello: ' + location.hash.replace('#user=', ''));
  };
</script>

window.name + iframe 跨域 ​

window.name 属性的独特之处：name 值在不同的页面（甚至不同域名）加载后依旧存在，并且可以支持非常长的 name 值（2MB）。

  • a.html：(www.domain1.com/a.html)
js
var proxy = function (url, callback) {
  var state = 0;
  var iframe = document.createElement('iframe');

  // 加载跨域页面
  iframe.src = url;

  // onload事件会触发2次，第1次加载跨域页，并留存数据于window.name
  iframe.onload = function () {
    if (state === 1) {
      // 第2次onload(同域proxy页)成功后，读取同域window.name中数据
      callback(iframe.contentWindow.name);
      destoryFrame();
    } else if (state === 0) {
      // 第1次onload(跨域页)成功后，切换到同域代理页面
      iframe.contentWindow.location = 'http://www.domain1.com/proxy.html';
      state = 1;
    }
  };

  document.body.appendChild(iframe);

  // 获取数据以后销毁这个iframe，释放内存；这也保证了安全（不被其他域frame js访问）
  function destoryFrame() {
    iframe.contentWindow.document.write('');
    iframe.contentWindow.close();
    document.body.removeChild(iframe);
  }
};

// 请求跨域 b 页面数据
proxy('http://www.domain2.com/b.html', function (data) {
  alert(data);
});
  • proxy.html：(www.domain1.com/proxy.html)

中间代理页，与 a.html 同域，内容为空即可。

  • b.html：(www.domain2.com/b.html)
html
<script>
  window.name = 'This is domain2 data!';
</script>

通过 iframe 的 src 属性由外域转向本地域，跨域数据即由 iframe 的 window.name 从外域传递到本地域。这个就巧妙地绕过了浏览器的跨域访问限制，但同时它又是安全操作。

postMessage 跨域 ​

postMessage 是 HTML5 XMLHttpRequest Level 2 中的 API，且是为数不多可以跨域操作的 window 属性之一，它可用于解决以下方面的问题：

  • 页面和其打开的新窗口的数据传递
  • 多窗口之间消息传递
  • 页面与嵌套的 iframe 消息传递
  • 上面三个场景的跨域数据传递

用法：postMessage(data,origin) 方法接受两个参数：

  • data： html5 规范支持任意基本类型或可复制的对象，但部分浏览器只支持字符串，所以传参时最好用 JSON.stringify() 序列化。
  • origin： 协议+主机+端口号，也可以设置为"*"，表示可以传递给任意窗口，如果要指定和当前窗口同源的话设置为"/"。

a.html：(www.domain1.com/a.html)

html
<iframe id="iframe" src="http://www.domain2.com/b.html" style="display:none;"></iframe>
<script>
  var iframe = document.getElementById('iframe');
  iframe.onload = function () {
    var data = {
      name: 'aym',
    };
    // 向domain2传送跨域数据
    iframe.contentWindow.postMessage(JSON.stringify(data), 'http://www.domain2.com');
  };

  // 接受domain2返回数据
  window.addEventListener(
    'message',
    function (e) {
      alert('data from domain2 ---> ' + e.data);
    },
    false
  );
</script>

b.html：(www.domain2.com/b.html)

html
<script>
  // 接收domain1的数据
  window.addEventListener(
    'message',
    function (e) {
      alert('data from domain1 ---> ' + e.data);

      var data = JSON.parse(e.data);
      if (data) {
        data.number = 16;

        // 处理后再发回domain1
        window.parent.postMessage(JSON.stringify(data), 'http://www.domain1.com');
      }
    },
    false
  );
</script>

WebSocket 协议跨域 ​

WebSocket protocol 是 HTML5 一种新的协议。它实现了浏览器与服务器全双工通信，同时允许跨域通讯，是 server push 技术的一种很好的实现。

原生 WebSocket API 使用起来不太方便，我们使用 Socket.io，它很好地封装了 webSocket 接口，提供了更简单、灵活的接口，也对不支持 webSocket 的浏览器提供了向下兼容。

前端代码：

html
<div>user input：<input type="text" /></div>
<script src="https://cdn.bootcss.com/socket.io/2.2.0/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>

Nodejs socket 后台：

js
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.');
  });
});

修改 host 跨域 ​

修改本机 host 为接口同域，可以在本地测试接口。

小结 ​

以上就是 10 种常见的跨域解决方案：

  • jsonp（只支持 get 请求，支持老的 IE 浏览器）适合加载不同域名的 js、css，img 等静态资源；
  • CORS（支持所有类型的 HTTP 请求，但浏览器 IE10 以下不支持）适合做 ajax 各种跨域请求；
  • Nginx 代理跨域和 nodejs 中间件跨域原理都相似，都是搭建一个服务器，直接在服务器端请求 HTTP 接口，这适合前后端分离的前端项目调后端接口；
  • document.domain+iframe 适合主域名相同，子域名不同的跨域请求；
  • postMessage、websocket 都是 HTML5 新特性，兼容性不是很好，只适用于主流浏览器和 IE10+；
  • 修改 host 用于本地测试接口