logo

前端开发必备知识 — 跨域

2023-03-08 下午前端 59 次浏览暂无评论

前言

在前端开发过程中，不可避免的会遇到跨域的问题。这篇文章将详细介绍跨域以及解决方案。

网络请求需要符合同源策略，什么是同源策略？

源 = 协议 + 主机 + 端口，两个源相同，称之为同源，两个源不同，称之为 跨源 或 跨域。

解决跨域的方案有：代理、CORS、JSONP

代理

适用场景：生产环境不发生跨域，但开发环境发生跨域

对于前端开发而言，大部分的跨域问题，都是通过代理解决的

因此，只需要在开发环境使用代理解决跨域即可，这种代理又称之为开发代理

在实际开发中，只需要对开发服务器稍加配置即可完成

// vite.config.js
export default defineConfig({
  plugins: [react()],
  server: {
    proxy: {
      '/api': {
        target: 'http://81.70.9.51:8081',
        changeOrigin: true,
        rewrite: (path) => path.replace(/^\/api/, '')
      }
    }
  }
});


// vue 的开发服务器代理配置
// vue.config.js
module.exports = {
  devServer: { // 配置开发服务器
    proxy: { // 配置代理
      "/api": { // 若请求路径以 /api 开头
        target: "http://dev.taobao.com", // 将其转发到 http://dev.taobao.com
      },
    },
  },
};

CORS

CORS是基于http1.1的一种跨域解决方案，它的全称是Cross-Origin Resource Sharing，跨域资源共享。

它的总体思路是：如果浏览器要跨域访问服务器的资源，需要获得服务器的允许

<img src="https://djc-note-images.oss-cn-hangzhou.aliyuncs.com/picgo/image-20230105093402741.png" alt="image-20230105093402741" style="zoom:50%;" />

针对不同的请求，CORS 规定了三种不同的交互模式，分别是

  • 简单请求
  • 需要预检的请求
  • 附带身份凭证的请求

简单请求

同时满足以下条件时，浏览器会认为它是一个简单请求：

  1. 请求方式属于下面的一种：get、post、head
  2. 请求头仅包含安全的字段，常见的安全字段如下：
    • Accept
    • Accept-Language
    • Content-Language
    • Content-Type
    • DPR
    • Download
    • Save-Data
    • Viewport-Width
    • Width
  3. 请求头如果包含Content-Type，仅限下面的值之一：
    • text/plain
    • multipart/form-data
    • application/x-www-form-urlencoded

如果以上三个条件同时满足，浏览器判定为简单请求。

// 简单请求
fetch('http://crossdomain.com/api/news');

// 请求方法不满足要求，不是简单请求
fetch('http://crossdomain.com/api/news', {
  method: 'PUT',
});

// 加入了额外的请求头，不是简单请求
fetch('http://crossdomain.com/api/news', {
  headers: {
    a: 1,
  },
});

// 简单请求
fetch('http://crossdomain.com/api/news', {
  method: 'post',
});

// content-type不满足要求，不是简单请求
fetch('http://crossdomain.com/api/news', {
  method: 'post',
  headers: {
    'content-type': 'application/json',
  },
});

简单请求的交互

当浏览器判定某个ajax 跨域请求是简单请求时，会发生以下的事情

  1. 请求头中会自动添加Origin字段

比如，在页面http://my.com/index.html中有以下代码造成了跨域

// 简单请求
fetch('http://crossdomain.com/api/news');

请求发出后，请求头会是下面的格式：

GET /api/news/ HTTP/1.1
Host: crossdomain.com
Connection: keep-alive
...
Referer: http://my.com/index.html
Origin: http://my.com

看到最后一行没，Origin字段会告诉服务器，是哪个源地址在跨域请求

  1. 服务器响应头中应包含Access-Control-Allow-Origin

当服务器收到请求后，如果允许该请求跨域访问，需要在响应头中添加Access-Control-Allow-Origin字段

该字段的值可以是：

  • *：表示我很开放，什么人我都允许访问
  • 具体的源：比如http://my.com，表示我就允许你访问

实际上，这两个值对于客户端http://my.com而言，都一样，因为客户端才不会管其他源服务器允不允许，就关心自己是否被允许

当然，服务器也可以维护一个可被允许的源列表，如果请求的Origin命中该列表，才响应*或具体的源

为了避免后续的麻烦，强烈推荐响应具体的源

需要预检的请求

简单的请求对服务器的威胁不大，所以允许使用上述的简单交互即可完成。

但是，如果浏览器不认为这是一种简单请求，就会按照下面的流程进行：

  1. 浏览器发送预检请求，询问服务器是否允许
  2. 服务器允许
  3. 浏览器发送真实请求
  4. 服务器完成真实的响应

比如，在页面http://my.com/index.html中有以下代码造成了跨域

// 需要预检的请求
fetch('http://crossdomain.com/api/user', {
  method: 'POST', // post 请求
  headers: {
    // 设置请求头
    a: 1,
    b: 2,
    'content-type': 'application/json',
  },
  body: JSON.stringify({ name: 'alight', age: 18 }), // 设置请求体
});

浏览器发现它不是一个简单请求，则会按照下面的流程与服务器交互

  1. 浏览器发送预检请求，询问服务器是否允许
OPTIONS /api/user HTTP/1.1
Host: crossdomain.com
...
Origin: http://my.com
Access-Control-Request-Method: POST
Access-Control-Request-Headers: a, b, content-type

可以看出，这并非我们想要发出的真实请求，请求中不包含我们的请求头，也没有消息体。

这是一个预检请求，它的目的是询问服务器，是否允许后续的真实请求。

预检请求没有请求体，它包含了后续真实请求要做的事情

预检请求有以下特征：

  • 请求方法为OPTIONS
  • 没有请求体
  • 请求头中包含
    • Origin：请求的源，和简单请求的含义一致
    • Access-Control-Request-Method：后续的真实请求将使用的请求方法
    • Access-Control-Request-Headers：后续的真实请求会改动的请求头
  1. 服务器允许

服务器收到预检请求后，可以检查预检请求中包含的信息，如果允许这样的请求，需要响应下面的消息格式

HTTP/1.1 200 OK
Date: Tue, 21 Apr 2020 08:03:35 GMT
...
Access-Control-Allow-Origin: http://my.com
Access-Control-Allow-Methods: POST
Access-Control-Allow-Headers: a, b, content-type
Access-Control-Max-Age: 86400
...

对于预检请求，不需要响应任何的消息体，只需要在响应头中添加：

  • Access-Control-Allow-Origin：和简单请求一样，表示允许的源
  • Access-Control-Allow-Methods：表示允许的后续真实的请求方法
  • Access-Control-Allow-Headers：表示允许改动的请求头
  • Access-Control-Max-Age：告诉浏览器，多少秒内，对于同样的请求源、方法、头，都不需要再发送预检请求了
  1. 浏览器发送真实请求

预检被服务器允许后，浏览器就会发送真实请求了，上面的代码会发生下面的请求数据

POST /api/user HTTP/1.1
Host: crossdomain.com
Connection: keep-alive
...
Referer: http://my.com/index.html
Origin: http://my.com

{"name": "alight", "age": 18 }
  1. 服务器响应真实请求
HTTP/1.1 200 OK
Date: Tue, 21 Apr 2020 08:03:35 GMT
...
Access-Control-Allow-Origin: http://my.com
...

添加用户成功

可以看出，当完成预检之后，后续的处理与简单请求相同

整个交互过程：

<img src="https://djc-note-images.oss-cn-hangzhou.aliyuncs.com/picgo/image-20230105104525509.png" alt="image-20230105104525509" style="zoom: 80%;" />

附带身份凭证的请求

默认情况下，ajax 的跨域请求并不会附带 cookie，这样一来，某些需要权限的操作就无法进行

不过可以通过简单的配置就可以实现附带 cookie

// xhr
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

// fetch api
fetch(url, {
  credentials: 'include',
});

// axios
const request = axios.create({
  baseURL: 'http://localhost:8080',
  timeout: 3000,
  withCredentials: true // 允许跨域携带cookie
});

这样一来，该跨域的 ajax 请求就是一个附带身份凭证的请求

当一个请求需要附带 cookie 时，无论它是简单请求，还是预检请求，都会在请求头中添加cookie字段

服务器响应时，需要明确告知客户端：服务器允许这样的凭据

响应头需要在预检请求的响应头的基础上添加以下字段：Access-Control-Allow-Credentials: true

例如：

Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: X-Requested-With,Content-Type
Access-Control-Allow-Methods: PUT,POST,GET,DELETE,OPTIONS
Access-Control-Allow-Origin: http://alight.work

对于一个附带身份凭证的请求，若服务器没有明确告知，浏览器仍然视为跨域被拒绝。

注意：对于附带身份凭证的请求，服务器设置 Access-Control-Allow-Origin: *无效。这就是为什么不推荐使用 * 的原因。

如果想要达到任何域都可以跨域携带cookie的效果，服务端可以将响应头的Access-Control-Allow-Origin，直接设置成请求头的Access-Control-Allow-Origin

类似这种效果：Access-Control-Allow-Origin: req.headers.origin || *

补充

在跨域访问时，JS 只能拿到一些最基本的响应头，如：Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma，如果要访问其他头，则需要服务器设置本响应头。

Access-Control-Expose-Headers头让服务器把允许浏览器访问的头放入白名单，例如：

Access-Control-Expose-Headers: authorization, a, b

这样 JS 就能够访问指定的响应头了。

JSONP

在CORS出现之前，人们想了一种奇妙的办法来实现跨域，这就是JSONP。

JSONP需要浏览器和服务器配合来实现。

JSONP的做法是：当需要跨域请求时，不使用AJAX，转而生成一个script元素去请求服务器，由于浏览器并不阻止script元素的请求，这样请求可以到达服务器。服务器拿到请求后，响应一段JS代码，这段代码实际上是一个函数调用，调用的是客户端预先生成好的函数，并把浏览器需要的数据作为参数传递到函数中，从而间接的把数据传递给客户端

JSONP有着明显的缺点，即其只能支持GET请求

流程：

  1. 准备好一个函数，相当于ajax的回调函数。
function callback(data){
// data是服务器传来的数据
}
  1. 生成一个script元素跨域访问服务器地址
<script src="http://domain.com/api/data"></script>
  1. 服务器响应一段 js 代码的函数调用，把数据作为参数传递
callback([
	{ name: 'alight', age: 18 }
])

总结

以上就是我对跨域方面知识的总结，希望对路过的朋友们有所帮助。

目录

代理
CORS
简单请求
需要预检的请求
附带身份凭证的请求
JSONP
总结
ICP备案号：鲁ICP备2020040322号