前端常见跨域解决方案

什么是跨域？

跨域是指一个域下的文档或脚本试图去请求另一个域下的资源，这里跨域是广义的。

广义的跨域：

• 1、资源跳转： A链接、重定向、表单提交
• 2、资源嵌入： 、

  服务端处理：

  const Koa = require('koa');
  const app = new Koa();
  
  app.use(async (ctx, next) => {
    if (ctx.path === '/api/jsonp') {
      const { cb } = ctx.query;
      const data = "www.shanzhonglei.com";
      ctx.body = `${cb}(data)`;
      return;
    }
  })
  app.listen(8080);
  

  解析：

  • 1、当执行到第二个script的时候就会发起请求。
  • 2、后端拿到cb，就知道前端那里是会有一个叫做jsonpCallback的函数来接收后端想要返回的数据，而后端你只需要在返回体中写入jsonpCallback()就可以了。
  • 3、前端在得到了后端返回的内容jsonpCallback("www.shanzhonglei.com")，发现里面是一段执行函数的语句，因此就会去执行第一个script中的jsonpCallback方法了，传递的参数就是我们要获取的数据。

  1.3.2、jquery ajax

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

  1.3.3、vue

  this.$http.jsonp('http://localhost:8080/login', {
      params: {},
      jsonp: 'handleCallback'
  }).then((res) => {
      console.log(res); 
  })
  

  二、document.domain + iframe跨域

  此方案仅限主域相同，子域不同的跨域应用场景。

  实现原理

  两个页面都通过js强制设置document.domain为基础主域，就实现了同域。

  2.1、父窗口

  http://www.domain.com/a.html

  2.2、子窗口

  http://child.domain.com/b.html

  三、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

  http://www.domain1.com/a.html

  b.html

  http://www.domain2.com/b.html

  c.html

  http://www.domain1.com/c.html

  四、window.name + iframe跨域

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

  a.html

  http://www.domain1.com/a.html

  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);
      }
  };
  

  proxy.html

  http://www.domain1.com/proxy....
  中间代理页，与a.html同域，内容为空即可。

  b.html

  http://www.domain2.com/b.html

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

  五、 postMessage跨域

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

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

  用法

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

  data： html5规范支持任意基本类型或可复制的对象，但部分浏览器只支持字符串，所以传参时最好用JSON.stringify()序列化。

  origin： 协议+主机+端口号，也可以设置为"*"，表示可以传递给任意窗口，如果要指定和当前窗口同源的话设置为"/"。

  a.html

  http://www.domain1.com/a.html

  b.html

  http://www.domain2.com/b.html

  六、 跨域资源共享（CORS）

  普通跨域请求：只服务端设置Access-Control-Allow-Origin即可，前端无须设置，若要带cookie请求。前后端都需要设置。

  需注意的是：由于同源策略的限制，所读取的cookie为跨域请求接口所在域的cookie，而非当前页。

  目前，所有浏览器都支持该功能(IE8+：IE8/9需要使用XDomainRequest对象来支持CORS）)，CORS也已经成为主流的跨域解决方案。

  前端设置

  1、原生ajax

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

  示例代码：

  var xhr = new XMLHttpRequest(); // IE8/9需用window.XDomainRequest兼容
  
  // 前端设置是否带cookie
  xhr.withCredentials = true;
  
  xhr.open('post', 'http://localhost: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);
      }
  };
  

  2、 jQuery ajax

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

  3、vue

  // axios设置：
  axios.defaults.withCredentials = true
  
  vue-resource设置：
  Vue.http.options.credentials = true
  

  服务端设置

  若后端设置成功，前端浏览器控制台则不会出现跨域报错信息，反之，说明没设成功。

  1、Java后台

  /*
   * 导入包：import javax.servlet.http.HttpServletResponse;
   * 接口参数中定义：HttpServletResponse response
   */
  
  // 允许跨域访问的域名：若有端口需写全（协议+域名+端口），若没有端口末尾不用加'/'
  response.setHeader("Access-Control-Allow-Origin", "http://www.domain1.com"); 
  
  // 允许前端带认证cookie：启用此项后，上面的域名不能为'*'，必须指定具体的域名，否则浏览器会提示
  response.setHeader("Access-Control-Allow-Credentials", "true"); 
  
  // 提示OPTIONS预检时，后端需要设置的两个常用自定义头
  response.setHeader("Access-Control-Allow-Headers", "Content-Type,X-Requested-With");
  

  2、Nodejs后台示例

  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代理跨域

  1、nginx配置解决iconfont跨域

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

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

  2、nginx反向代理接口跨域

  跨域原理

  同源策略是浏览器的安全策略，不是HTTP协议的一部分。服务器端调用HTTP接口只是使用HTTP协议，不会执行JS脚本，不需要同源策略，也就不存在跨越问题。

  实现思路

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

  nginx具体配置

  #proxy服务器
  server {
      listen       81;
      server_name  www.domain1.com;
  
      location / {
          proxy_pass   http://localhost: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;
      }
  }
  

  前端代码示例

  var xhr = new XMLHttpRequest();
  
  // 前端开关：浏览器是否读写cookie
  xhr.withCredentials = true;
  
  // 访问nginx中的代理服务器
  xhr.open('get', 'http://www.domain1.com:81/?user=admin', true);
  xhr.send();
  

  Nodejs后台示例

  var http = require('http');
  var server = http.createServer();
  var qs = require('querystring');
  
  server.on('request', function(req, res) {
      var params = qs.parse(req.url.substring(2));
  
      // 向前台写cookie
      res.writeHead(200, {
          'Set-Cookie': 'l=a123456;Path=/;Domain=www.domain2.com;HttpOnly'   // HttpOnly:脚本无法读取
      });
  
      res.write(JSON.stringify(params));
      res.end();
  });
  
  server.listen('8080');
  console.log('Server is running at port 8080...');
  

  八、 Nodejs中间件代理跨域

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

  8.1 非vue框架的跨域（2次跨域）

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

  8.1.1 前端代码示例：

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

  8.1.2 中间件服务器：

  var express = require('express');
  var proxy = require('http-proxy-middleware');
  var app = express();
  
  app.use('/', proxy({
      // 代理跨域目标接口
      target: 'http://localhost: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...');
  

  8.1.3 Nodejs后台同（六：nginx）

  8.2 vue框架的跨域（1次跨域）

  利用node + webpack + webpack-dev-server代理接口跨域。在开发环境下，由于vue渲染服务和接口代理服务都是webpack-dev-server同一个，所以页面与代理接口之间不再跨域，无须设置headers跨域信息了。

  webpack.config.js部分配置：

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

  九、 WebSocket协议跨域

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

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

  前端代码：

  user input：
  
  
  

  Nodejs socket后台：

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

  最后

  欢迎关注我的公众号【前端技术驿站】，多多交流，共同进步！
  回复react:
  1、React.js大众点评案例完整版
  2、React+TypeScript高仿AntDesign开发企业级UI组件库
  3、React17+React Hook+TS4最佳实践 仿Jira企业级项目
  回复vue
  1、[全栈开发 ]Vue+Django REST framework 打造生鲜电商项目
  2、核心源码内参
  3、Vue3+ElementPlus+Koa2 全栈开发后台系统
  4、ES6零基础教学解析彩票
  5、Node.js+Koa2框架生态实战 - 从零模拟新浪微博（完整版）
  6、vue无人点餐收银系统
  回复node
  1、Nodejs视频教程
  2、全栈最后一公里 - Nodejs 项目的线上服务器部署与发布
  3、深入浅出Node.js