当前位置: 首页 > news >正文

axios 的 withCredentials 到底做了什么?

一、核心结论
withCredentials是 axios 中控制跨域请求是否携带凭证(Cookie、HTTP 认证信息、TLS 客户端证书等)的布尔值配置项,本质是对浏览器XMLHttpRequest.withCredentials原生属性的封装,默认值为false
简单说:

  • withCredentials: false(默认):跨域请求时,浏览器不会携带目标域名下的 Cookie/认证信息;
  • withCredentials: true:跨域请求时,浏览器主动携带目标域名下的 Cookie/认证信息,且服务端响应的 Set-Cookie 也会生效。

注意:该配置仅对跨域请求有效,同域请求不受影响(默认携带凭证)。

二、底层原理:浏览器的同源策略 & CORS 规范
要理解withCredentials,必须先明确浏览器的核心规则:
1. 同源策略的限制
浏览器默认禁止跨域请求携带凭证(比如 A 域名请求 B 域名接口时,不会带 B 域名的 Cookie),这是为了防止第三方网站盗用用户的认证信息。
2. CORS 规范对凭证的要求
当前端设置withCredentials: true时,必须满足服务端+客户端双向配置,否则请求会被浏览器拦截:

必要配置
前端(axios)withCredentials: true
服务端响应头必须包含:
1. Access-Control-Allow-Credentials: true
2. Access-Control-Allow-Origin 不能为 *(必须是具体域名,如 https://xxx.com)

三、withCredentials具体行为拆解
1. 当withCredentials: false(默认)

  • 请求阶段:浏览器发送跨域请求时,不会携带目标域名的 Cookie、Authorization 头等凭证;
  • 响应阶段:即使服务端返回Set-Cookie响应头,浏览器也不会保存该 Cookie(相当于忽略);
  • 场景:无需用户认证的跨域请求(如公开接口、静态资源)。

2. 当withCredentials: true

  • 请求阶段:浏览器主动携带目标域名下的 Cookie(仅该域名的 Cookie,非当前域名)、HTTP 认证信息(如 Basic Auth);
  • 响应阶段: ✅ 若服务端返回Access-Control-Allow-Credentials: true+ 具体的Access-Control-Allow-Origin:浏览器会保存服务端的Set-Cookie,且后续请求会自动携带; ❌ 若服务端未满足上述条件:浏览器会触发 CORS 错误,拦截响应(控制台报错:Access to XMLHttpRequest at 'xxx' from origin 'xxx' has been blocked by CORS policy: The value of the 'Access-Control-Allow-Credentials' header in the response is '' which must be 'true' when the request's credentials mode is 'include');
  • 场景:需要用户登录态的跨域请求(如登录后获取用户信息、提交订单)。

四、典型使用场景 & 示例
场景:前端(http://localhost:3000)请求后端(http://api.example.com)的登录接口

// axios 配置(前端) axios({ url: 'http://api.example.com/user/info', method: 'GET', withCredentials: true, // 跨域携带 Cookie(后端域名下的登录 Cookie) }) .then(res => console.log(res)) .catch(err => console.log(err));

服务端配置(以 Node.js/Express 为例)

const express = require('express'); const app = express(); // 跨域中间件配置 app.use((req, res, next) => { // 允许指定前端域名跨域(不能用 *) res.setHeader('Access-Control-Allow-Origin', 'http://localhost:3000'); // 允许携带凭证 res.setHeader('Access-Control-Allow-Credentials', 'true'); // 允许的请求头 res.setHeader('Access-Control-Allow-Headers', 'Content-Type'); next(); }); // 接口返回用户信息(依赖 Cookie 中的登录态) app.get('/user/info', (req, res) => { res.json({ name: '张三', id: 123 }); }); app.listen(8080);

五、常见坑点

  1. Access-Control-Allow-Origin不能为*: 若服务端设置*,同时前端开了withCredentials: true,浏览器会直接拦截请求(因为*无法和具体域名的凭证绑定)。
  2. 跨域 Cookie 的 SameSite 限制: 若服务端设置的 Cookie 的SameSiteStrict/Lax,跨域请求时即使开了withCredentials,Cookie 也可能无法携带(需设置SameSite=None; Secure,且请求必须是 HTTPS)。
  3. 凭证仅对目标域名生效: 比如前端a.com请求b.comwithCredentials: true只会携带b.com的 Cookie,而非a.com的 Cookie。
  4. 预检请求(OPTIONS)也需配置: 复杂请求(如 POST 带 JSON、自定义头)会先发送 OPTIONS 预检请求,服务端必须对 OPTIONS 请求返回相同的 CORS 配置(尤其是Access-Control-Allow-Credentials)。

六、总结
withCredentials的核心作用是突破浏览器同源策略对跨域凭证的限制,让跨域请求能携带 Cookie/认证信息,但必须配合服务端的 CORS 配置才能生效。它是实现跨域登录态保持的关键配置,也是处理跨域认证请求的必备项。

原文: https://juejin.cn/post/75864798
http://www.rkmt.cn/news/143249.html

相关文章:

  • Windows系统文件msrclr40.dll丢失找不到问题 下载修复方法
  • 黑白盒测试
  • 1 STM32学习板入门视频教程 STM32基础知识
  • Alphabet以47.5亿美元收购可再生能源公司Intersect
  • 3 STM32学习板入门视频教程 为什么选择STM32
  • 西门子S7 - 200PLC与组态王构建自动灌溉系统的奇妙之旅
  • 眼红的Medusa
  • 2025年必备:7款免费AI论文神器,5分钟搞定全文告别熬夜赶稿
  • HarmonyOS 5开发从入门到精通(十):多媒体开发
  • 从c到exe的编译过程
  • 基于matlab的bp网络车牌识别系统
  • 软银竭力筹措225亿美元资金支持OpenAI
  • 隧道超声波风速风向检测器:优化通风能耗管理
  • 百度自动驾驶出租车将于2026年进入伦敦市场
  • 国产CAD实现跨部门设计变更同步
  • 请编写一个 Bash 脚本检查系统中的所有服务状态(中等)
  • Python Threading.Lock() threading.thread(target=lambda:[()])
  • 如何安全地清洁 Windows 10/11 PC 上的 SS
  • 如何彻底擦除电脑(4种有效方法)
  • 2023A卷,天然蓄水池
  • 光储交直流微电网离并网变换仿真探秘
  • Alibaba Cloud Linux 4.0安装mongodump
  • Kafka 与 Spark 在大数据实时分析中的集成
  • SGMICRO圣邦微 SGM2034-5.0YN3G/TR SOT23 线性稳压器(LDO)
  • SMT贴片加工生产车间主要设备有哪些
  • JavaScript 性能优化:7 个 V8 引擎偏爱的编码模式让你提速 40%
  • mongodb备份的脚本
  • 基于Springboot的社区共享充电宝租赁管理系统
  • 基于51单片机的智能遥控晾衣架
  • SGMICRO圣邦微 SGM2036-1.1YN5G/TR SOT23-5 线性稳压器(LDO)