Vue.config.js中配置Proxy代理HTTPS

Vue.config.js中配置Proxy代理HTTPS

• • 基本概念与作用
  • • 为什么要使用HTTPS代理？
  • 示例一：基础HTTPS代理配置
  • 示例二：多环境代理配置
  • 示例三：忽略某些路径
  • 示例四：支持WebSocket代理
  • 示例五：高级配置
  • 实际开发中的使用技巧

在开发基于Vue.js的应用时，经常会遇到前后端分离的情况，即前端应用与后端API服务器部署在不同的域名下。由于浏览器的同源策略限制，直接请求其他域名的数据会导致CORS（跨域资源共享）错误。为了解决这个问题，Vue CLI提供了vue.config.js文件，允许开发者配置代理服务器来绕过跨域限制。本文将详细介绍如何在vue.config.js中配置HTTPS代理，帮助你在开发环境中无缝对接后端API。

基本概念与作用

Vue CLI内置了基于Webpack的开发服务器，它提供了热重载、实时编译等功能，极大地提高了开发效率。但在开发过程中，直接向后端API发起请求可能会因为同源策略而失败。通过在vue.config.js中配置代理，可以让开发服务器充当代理服务器的角色，将请求转发到正确的API地址。

为什么要使用HTTPS代理？

• 安全性：HTTPS协议加密传输数据，保护敏感信息不被窃取。
• 认证：确保客户端与服务器之间的通信是可信的。
• 行业标准：越来越多的网站和服务要求使用HTTPS连接。

示例一：基础HTTPS代理配置

首先，我们需要创建一个vue.config.js文件（如果尚未存在），并在其中配置代理规则。以下是一个简单的配置示例：

module.exports = {
  devServer: {
    proxy: {
      '/api': {
        target: 'https://api.example.com',
        changeOrigin: true, // 修改目标的origin为代理服务器origin
        pathRewrite: { '^/api': '' }, // 重写路径，去除'/api'前缀
      },
    },
  },
};

在这个示例中，所有以/api开头的请求都会被转发到https://api.example.com，并且路径中的/api会被移除。

示例二：多环境代理配置

在实际开发中，我们可能需要针对不同的环境（如开发、测试、生产）配置不同的API服务器地址。这时可以利用环境变量来动态设置代理目标。

module.exports = {
  devServer: {
    proxy: {
      '/api': {
        target: process.env.VUE_APP_API_URL,
        changeOrigin: true,
        pathRewrite: { '^/api': '' },
      },
    },
  },
};

在.env文件中设置：

VUE_APP_API_URL=https://api.dev.example.com

这样，我们可以通过更改.env文件中的VUE_APP_API_URL来切换API服务器。

示例三：忽略某些路径

有时候，我们可能不希望所有的请求都被代理，而是只有特定的路径。可以通过exclude选项来排除不需要代理的路径。

module.exports = {
  devServer: {
    proxy: {
      '/api': {
        target: 'https://api.example.com',
        changeOrigin: true,
        pathRewrite: { '^/api': '' },
        exclude: ['/api/auth'],
      },
    },
  },
};

在这个示例中，所有以/api开头但不包含/auth的请求将会被代理。

示例四：支持WebSocket代理

在一些场景下，我们需要使用WebSocket与后端建立连接。为了保证WebSocket请求同样可以正确代理，需要在配置中显式支持WebSocket。

module.exports = {
  devServer: {
    proxy: {
      '/ws': {
        target: 'wss://api.example.com',
        ws: true,
        changeOrigin: true,
        pathRewrite: { '^/ws': '' },
      },
    },
  },
};

这里我们为WebSocket请求指定了不同的target，并通过ws: true启用WebSocket支持。

示例五：高级配置

Vue CLI的代理配置还支持更高级的功能，比如基于正则表达式的匹配、自定义中间件等。

module.exports = {
  devServer: {
    proxy: {
      '/api': {
        target: 'https://api.example.com',
        changeOrigin: true,
        pathRewrite: { '^/api': '' },
        // 自定义中间件
        ws: true,
        logLevel: 'debug',
        onProxyRes(proxyRes, req, res) {
          // 在代理响应之前执行的操作
          console.log(proxyRes.headers);
        },
        onProxyReq(proxyReq, req, res) {
          // 在发送代理请求之前执行的操作
          proxyReq.setHeader('X-Requested-With', 'XMLHttpRequest');
        },
      },
    },
  },
};

在这个示例中，我们添加了两个自定义中间件函数onProxyRes和onProxyReq，分别在代理响应和请求时执行额外的操作。

实际开发中的使用技巧

• 缓存策略：对于频繁请求的数据，可以考虑在代理服务器上设置适当的缓存策略。
• 错误处理：当后端API不可用时，应该有相应的错误处理机制，比如显示友好的错误提示。
• 安全加固：确保HTTPS证书的有效性，防止中间人攻击。
• 监控与日志：记录代理请求的日志，有助于调试和性能分析。

通过以上示例和技巧，我们可以在Vue CLI项目中灵活地配置HTTPS代理，从而在开发阶段无缝对接后端API，提高开发效率和安全性。

欢迎来到我的博客，很高兴能够在这里和您见面！希望您在这里可以感受到一份轻松愉快的氛围，不仅可以获得有趣的内容和知识，也可以畅所欲言、分享您的想法和见解。

---

推荐：DTcode7的博客首页。
一个做过前端开发的产品经理，经历过睿智产品的折磨导致脱发之后，励志要翻身农奴把歌唱，一边打入敌人内部一边持续提升自己，为我们广大开发同胞谋福祉，坚决抵制睿智产品折磨我们码农兄弟！

---

专栏系列（点击解锁）	学习路线(点击解锁）	知识定位
《微信小程序相关博客》	持续更新中~	结合微信官方原生框架、uniapp等小程序框架，记录请求、封装、tabbar、UI组件的学习记录和使用技巧等
《AIGC相关博客》	持续更新中~	AIGC、AI生产力工具的介绍，例如stable diffusion这种的AI绘画工具安装、使用、技巧等总结
《HTML网站开发相关》	《前端基础入门三大核心之html相关博客》	前端基础入门三大核心之html板块的内容，入坑前端或者辅助学习的必看知识
	《前端基础入门三大核心之JS相关博客》	前端JS是JavaScript语言在网页开发中的应用，负责实现交互效果和动态内容。它与HTML和CSS并称前端三剑客，共同构建用户界面。 通过操作DOM元素、响应事件、发起网络请求等，JS使页面能够响应用户行为，实现数据动态展示和页面流畅跳转，是现代Web开发的核心
	《前端基础入门三大核心之CSS相关博客》	介绍前端开发中遇到的CSS疑问和各种奇妙的CSS语法，同时收集精美的CSS效果代码，用来丰富你的web网页
	《canvas绘图相关博客》	Canvas是HTML5中用于绘制图形的元素，通过JavaScript及其提供的绘图API，开发者可以在网页上绘制出各种复杂的图形、动画和图像效果。Canvas提供了高度的灵活性和控制力，使得前端绘图技术更加丰富和多样化
《Vue实战相关博客》	持续更新中~	详细总结了常用UI库elementUI的使用技巧以及Vue的学习之旅
《python相关博客》	持续更新中~	Python，简洁易学的编程语言，强大到足以应对各种应用场景，是编程新手的理想选择，也是专业人士的得力工具
《sql数据库相关博客》	持续更新中~	SQL数据库：高效管理数据的利器，学会SQL，轻松驾驭结构化数据，解锁数据分析与挖掘的无限可能
《算法系列相关博客》	持续更新中~	算法与数据结构学习总结，通过JS来编写处理复杂有趣的算法问题，提升你的技术思维
《IT信息技术相关博客》	持续更新中~	作为信息化人员所需要掌握的底层技术，涉及软件开发、网络建设、系统维护等领域的知识
	《信息化人员基础技能知识相关博客》	无论你是开发、产品、实施、经理，只要是从事信息化相关行业的人员，都应该掌握这些信息化的基础知识，可以不精通但是一定要了解，避免日常工作中贻笑大方
	《信息化技能面试宝典相关博客》	涉及信息化相关工作基础知识和面试技巧，提升自我能力与面试通过率，扩展知识面
《前端开发习惯与小技巧相关博客》	持续更新中~	罗列常用的开发工具使用技巧,如 Vscode快捷键操作、Git、CMD、游览器控制台等
《photoshop相关博客》	持续更新中~	基础的PS学习记录，含括PPI与DPI、物理像素dp、逻辑像素dip、矢量图和位图以及帧动画等的学习总结
日常开发&办公&生产【实用工具】分享相关博客》	持续更新中~	分享介绍各种开发中、工作中、个人生产以及学习上的工具，丰富阅历，给大家提供处理事情的更多角度，学习了解更多的便利工具，如Fiddler抓包、办公快捷键、虚拟机VMware等工具

吾辈才疏学浅，摹写之作，恐有瑕疵。望诸君海涵赐教。望轻喷，嘤嘤嘤
非常期待和您一起在这个小小的网络世界里共同探索、学习和成长。愿斯文对汝有所裨益，纵其简陋未及渊博，亦足以略尽绵薄之力。倘若尚存阙漏，敬请不吝斧正，俾便精进！