Vue @vue/cli 3配置代理Proxy

在Vue.js项目开发中，特别是在前后端分离的架构下，前端开发环境经常需要与后端API接口进行交互。然而，在开发阶段，前端运行在本地服务器（通常是http://localhost:8080），而后端API可能位于不同的服务器上（如http://api.example.com）。为了绕过CORS（Cross-Origin Resource Sharing，跨域资源共享）策略带来的限制，Vue CLI提供了内置的代理功能，允许我们将API请求转发到目标服务器，从而简化开发环境下的API测试。

本文将详细介绍如何使用@vue/cli 3来配置代理服务，并提供详细的代码示例和使用技巧，帮助你更好地理解和掌握这一重要特性。

基本概念与作用说明

代理服务

代理服务（Proxy Service）是一种网络服务，它充当客户端和目标服务器之间的中介。在这种模式下，客户端的请求首先发送给代理服务器，代理服务器再将请求转发给真正的服务器，并将响应返回给客户端。代理服务可以用于多种用途，包括负载均衡、安全性增强以及解决跨域问题等。

Vue CLI中的代理

Vue CLI内置了一个简单的HTTP代理服务器，允许你在开发环境中轻松配置代理规则。当你启动Vue CLI项目时，可以指定一个代理地址，所有的API请求都会被转发到该地址。

示例一：基本配置

假设你正在开发一个Vue应用，并且需要与后端API进行交互。首先，你需要在项目的根目录下创建一个vue.config.js文件（如果尚未存在的话）。然后，在此文件中配置代理规则：

module.exports = {
  devServer: {
    proxy: {
      '/api': { // 匹配所有以 /api 开头的请求
        target: 'http://api.example.com', // 后端API所在的服务器地址
        changeOrigin: true, // 如果接口跨域，需要进行此参数配置
        pathRewrite: { // 重写路径，移除/api前缀
          '^/api': ''
        }
      }
    }
  }
}

解析

• /api 表示所有以/api开头的请求都将被代理。
• target 设置了目标服务器的地址。
• changeOrigin 设置为true时，会改变请求的origin头，使其看起来像是从代理服务器发出的。
• pathRewrite 可以用来重写请求路径，这里我们移除了/api前缀。

示例二：配置多个代理

在实际开发中，可能需要配置多个不同的API接口。这时，可以为每个接口分别定义代理规则：

module.exports = {
  devServer: {
    proxy: {
      '/api1': {
        target: 'http://api1.example.com',
        changeOrigin: true,
        pathRewrite: {
          '^/api1': ''
        }
      },
      '/api2': {
        target: 'http://api2.example.com',
        changeOrigin: true,
        pathRewrite: {
          '^/api2': ''
        }
      }
    }
  }
}

示例三：动态代理配置

在某些情况下，你可能希望根据环境变量动态配置代理。例如，开发环境和生产环境可能有不同的API服务器：

module.exports = {
  devServer: {
    proxy: process.env.NODE_ENV === 'development' ?
      {
        '/api': {
          target: 'http://dev-api.example.com',
          changeOrigin: true,
          pathRewrite: {
            '^/api': ''
          }
        }
      } : {}
  }
}

在这个例子中，只有在开发环境下才会启用代理配置。

示例四：调试与测试

当你配置好代理后，可以通过启动开发服务器来验证配置是否正确：

npm run serve

启动后，你可以通过发送API请求来测试代理是否正常工作。可以使用浏览器的开发者工具检查请求的实际URL是否被正确转发到了目标服务器。

示例五：与Vue Router配合使用

如果你的应用使用了Vue Router，并且开启了history模式，那么在开发环境中也需要配置代理来处理路由请求：

module.exports = {
  devServer: {
    proxy: {
      '/api': {
        target: 'http://api.example.com',
        changeOrigin: true,
        pathRewrite: {
          '^/api': ''
        }
      },
      '/': {
        target: 'http://localhost:8080', // 或者你的前端服务器地址
        changeOrigin: true,
        ws: true, // 支持WebSocket
        secure: false // 如果服务器不支持https，可以关闭安全模式
      }
    }
  }
}

这里我们配置了一个通用的代理规则，用于处理Vue Router的所有请求。

实际工作中使用技巧

在实际开发中，正确配置代理服务不仅可以帮助我们绕过跨域问题，还可以提高开发效率。以下是一些实用技巧：

• 环境变量: 使用环境变量来区分不同环境下的代理配置，有助于保持代码的整洁和灵活性。
• 错误处理: 在开发过程中，注意监控代理请求的状态码，以便及时发现问题。
• 安全性: 在生产环境中禁用代理，防止敏感信息泄露。
• 性能: 适当使用缓存来提高代理请求的性能，尤其是对于静态资源的请求。

通过上述配置和技巧，相信你可以更好地利用Vue CLI的代理功能，提高前端开发效率，并在实际项目中避免常见的跨域问题。

---

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

---

推荐：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等工具

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