前端跨域知识汇总

概述

作为 web 开发，跨域是一个绕不开的话题，最早我们从使用 jQuery 的jsonp开始，到后来原生实现 jsonp，再到后来各种其他实现方式，如document.domain+iframe、CORS等，再到后来了解了可以通过 nginx 等代理跨域，现在随着 HTML5 的流行，又有了 postMessage 跨域与 WebSocket 协议跨域。对于相关概念、各种实现的区别本文做个汇总整理。

详述

跨域

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

广义的跨域：

1. 资源跳转： A 链接、重定向、表单提交；
2. 资源嵌入： <link>、<script>、<img>、<frame>等 dom 标签，还有样式中 background:url()、@font-face()等文件外链；
3. 脚本请求： js 发起的 ajax 请求、dom 和 js 对象的跨域操作等；

狭义的跨域：
是由浏览器同源策略限制的一类请求场景。

同源策略

同源策略是一个重要的安全策略，它用于限制一个 origin 的文档或者它加载的脚本如何能与另一个源的资源进行交互。它能帮助阻隔恶意文档，减少可能被攻击的媒介。

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

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

1. Cookie、LocalStorage 和 IndexDB 无法读取
2. DOM 和 Js 对象无法获得
3. AJAX 请求不能发送

下表给出了与 URL http://store.company.com/dir/page.html 的源进行对比的示例：

URL	结果	原因
http://store.company.com/dir2/other.html	同源	只有路径不同
http://store.company.com/dir/inner/another.html	同源	只有路径不同
https://store.company.com/secure.html	失败	协议不同
http://store.company.com:81/dir/etc.html	失败	端口不同 ( http:// 默认端口是 80)
http://news.company.com/dir/other.html	失败	主机不同

源的继承

在页面中通过 about:blank 或 javascript: URL 执行的脚本会继承打开该 URL 的文档的源，因为这些类型的 URLs 没有包含源服务器的相关信息。
例如，about:blank 通常作为父脚本写入内容的新的空白弹出窗口的 URL（例如，通过 Window.open() ）。 如果此弹出窗口也包含 JavaScript，则该脚本将从创建它的脚本那里继承对应的源。

IE 中的特例

Internet Explorer 的同源策略有两个主要的差异点：

• 授信范围（Trust Zones）：两个相互之间高度互信的域名，如公司域名（corporate domains），则不受同源策略限制。
• 端口：IE 未将端口号纳入到同源策略的检查中，因此 https://company.com:81/index.html 和 https://company.com/index.html 属于同源并且不受任何限制。

这些差异点是不规范的，其它浏览器也未做出支持。

跨域解决方案

jsonp 跨域

Jsonp(JSON with Padding) 是 json 的一种”使用模式”，可以让网页从别的域名（网站）那获取资料，即跨域读取数据。

实现原理：基于两个条件：网页允许资源嵌入，且资源路径不受限制；网页使用 js 有三种方式，HTML 标签上javascript:xxx、<script>标签内和<script>标签外链。JSONP 就是利用这种标签外链，通过请求其他域下的服务，返回一个携带结果数据的 JS 执行函数。

jsonp 缺点：只能实现 get 一种请求。

客户端定义一个函数：

function handleCallback(res) {
  alert(JSON.stringify(res));
}

服务端返回一段 js：

handleCallback({ status: true, user: "admin" });

具体实现

客户端(原生)：

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

客户端(jquery):

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

服务端（nodejs）：

var querystring = require("querystring");
var http = require("http");
var server = http.createServer();

server.on("request", function (req, res) {
  var params = qs.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...");

服务端（java）：

protected void packNoJsonStringCallBack(HttpServletRequest request, HttpServletResponse response, Object result) {
    String jsoncallback = EscapeTool.escapeSpecialCharacters(request.getParameter("jsoncallback"));
    try {
        response.setContentType("application/json; charset=utf-8");
        response.getWriter().write(jsoncallback + "(" + JSONObject.toJSON(result) + ")");
    }
    catch (Exception e) {
        log.error("SafetyMobileController::packJsonCallBack::", e);
    }
}

实际运用（JSONP+Promise）:

const jsonp = (url, params) => {
  return new Promise((resolve, reject) => {
    // 初始化url
    let dataString = url.indexOf("?") === -1 ? "?" : "&";
    let callback = `jsonpCB_${Math.random().toString().substr(2)}`;
    url += `${dataString}jsoncallback=${callback}`;
    if (params) {
      // 有请求参数，依次添加到url
      if (typeof params === "string") url += "&" + params;
      else if (typeof params === "object") {
        for (let key in params) {
          url += "&" + key + "=" + encodeURIComponent(params[key]);
        }
      }
    }

    const jsNode = document.createElement("script");
    jsNode.setAttribute("type", "text/javascript");
    jsNode.src = url;

    const headEle = document.getElementsByTagName("head")[0];

    window[callback] = (response) => {
      if (typeof response === "string") {
        try {
          response = JSON.parse(response);
        } catch (error) {
          reject(error);
        }
      }
      headEle.removeChild(jsNode);
      delete window[callback];

      if (response) {
        resolve(response);
      } else {
        reject("No Data");
      }
    };

    // js加载异常的情况
    jsNode.addEventListener(
      "error",
      () => {
        delete window[callback];
        headEle.removeChild(jsNode);

        reject("Load Error");
      },
      false
    );

    headEle.appendChild(jsNode);
  });
};

const _jsonp = (url, params) => {
  return new Promise((resolve, reject) => {
    jsonp(url, params).then((response) => {
      if (typeof response === "string") {
        response = JSON.parse(response);
      }
      let { code, msg, token, data } = response;

      if (code !== "10001") {
        message.error(data && data.message);
        reject(data && data.message);
      }

      resolve(data);
    });
  });
};

跨域资源共享（CORS）

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

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

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

前端设置：

1. 原生 ajax

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

2. jQuery ajax

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

3. axios

axios.defaults.withCredentials = 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...");

实际运用：

@RequestMapping(value = "/promotion/hotDeals", produces = "text/html;charset=UTF-8")
@ResponseBody
public String hotDeals(@RequestParam(value = "word", required = true) String word,
                        @RequestParam(value = "pid", required = true) String pid,
                        @RequestParam(value = "pageType", required = true) String pageType,
                        @RequestParam(value = "pageNo", required = true) String pageNo, HttpServletRequest request,
                        HttpServletResponse response) {
    // 支持跨域
    response.addHeader("Access-Control-Allow-Origin", "*");
    AjaxSubmitResult result = AjaxSubmitResult.instance(AjaxSubmitResult.ASYNC_ERROR, null);

    List<SpecialSkuDetailVo> skuList = getMatchedSpecialSku(word);
    if (CollectionUtils.isNotEmpty(skuList)) {
        result.setData(skuList);
        recordExposureLog(PfSepcialConstant.SPECIAL_TYPE_FIGHTING, pid, word, pageType, pageNo, skuList);
    }
    result.setCode(AjaxSubmitResult.ASYNC_SUCCESS);
    return EscapeTool.escapeSpecialCharacters(request.getParameter("callback")) + "("
            + JSONObject.toJSONString(result) + ")";
}

document.domain + iframe跨域

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

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

1. 父窗口：(http://www.domain.com/a.html)

<iframe id="iframe" src="http://child.domain.com/b.html"></iframe>
<script>
  document.domain = "domain.com";
  var user = "admin";
</script>

2. 子窗口：(http://child.domain.com/b.html)

<script>
  document.domain = "domain.com";
  // 获取父窗口中变量
  alert("get js data from parent ---> " + window.parent.user);
</script>

实际运用：
在主站（主站应用 www.abc.com）中打开弹框登录窗口（登录应用 login.abc.com），这时候两个子域之间沟通可以通过设置 domain 为父域值来实现数据交换。

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 页面所有对象。

1. a.html：(http://www.domain1.com/a.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>

2. b.html：(http://www.domain2.com/b.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>

3. c.html：(http://www.domain1.com/c.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）。

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

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

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

3. b.html：(http://www.domain2.com/b.html)

<script>
  window.name = "This is domain2 data!";
</script>

总结：通过 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： 协议+主机+端口号，也可以设置为”*“，表示可以传递给任意窗口，如果要指定和当前窗口同源的话设置为”/“。

1. a.html：(http://www.domain1.com/a.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>

2. b.html：(http://www.domain2.com/b.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>

实际运用：

域 1 下的 react 项目中：

componentDidMount() {
  this.getDetailUrl();
  window.addEventListener("message", this.receiveMessage, false);

}
...

// 向iframe发送数据
sendPostMessage(data, name) {
  //必须是iframe加载完成后才可以向子域发送数据
  const childFrameObj = document.getElementById('Model');
  childFrameObj.contentWindow.postMessage({data, name}, this.state.postMesUrl);
};

...

receiveMessage = (event) => {

  if (event !== undefined && event.data && event.data.name) {

    var eventData = event.data;

    ...

  }

};

域 2 下的 jquery 项目中：

var evt = window.event;
var postMessageUrl = "https://xxx.xxx.com";

//监听message事件 接收react传过来的参数
window.addEventListener("message", receiveMessageFromReact, false);

//向react发送数据
function transmitData(data) {
  parent.postMessage(data, postMessageUrl); //window.postMessage
}

/*search*/
var searchResult = function () {
  var initData = {
    name: "search",
    data: {
      keyword: $("input[name=keyword]").val(),
    },
  };
  transmitData(initData);
};
$(".J-search-btn").click(function (e) {
  e.preventDefault();
  searchResult();
});
$("input[name=keyword]").on("keyup", function (e) {
  if (e.keyCode === 13) {
    searchResult();
  }
});

WebSocket 协议跨域

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

1. 前端代码：

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

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

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://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;
    }
}

前端代码示例：

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 写入，方便接口登录认证。

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

前端代码示例：

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

中间件服务器：

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...");

Nodejs 后台（同 nginx）

参考

https://developer.mozilla.org/zh-CN/docs/Web/Security/Same-origin_policy

https://segmentfault.com/a/1190000011145364