首页 > 其他分享 >在vite中配置proxy跨域

在vite中配置proxy跨域

时间:2023-05-11 12:34:45浏览次数:48  
标签:http 跨域 api 配置 API proxy vite

我们在编写前端项目的时候,经常会遇到跨域的问题,当我们访问后端 API 的 URL 路径时,只要域名、端口或访问协议(如 HTTP 和 HTTPS)有一项不同,就会被浏览器认定为跨域。另外我们也会经常重复编写后端的域名,例如 https://example.com/api/some_end_pointhttps://example.com/api/other_end_point,针对这两种情况,可以直接用同一个配置来解决,即代理配置。​

不管是 Vite 还是 Webpack,这些打包工具都支持设置前端代理,它们能够把对某一段 URL 的访问直接转换成另一个真实的后端 API 地址,这样前后端就视为使用了相同的域名、协议和端口,就避免了跨域的问题,还能避免繁琐的反复编写域名。

  vite和webpack配置相同

我们这里以 Vite 的配置为例,来看一下如何给 API 请求设置代理。在 Vite 编写的项目里边,有一个 vite.config.js配置文件,里边是关于 Vite 的配置项,可以在里边配置代理。假如我们前端项目路径为 http://localhost:3000,需要代理所有以 /api 开头的 API 请求,把它转发到 http://localhost:3001,并且后端的 API 路径中不带 /api前缀,需要自动去掉 /api前缀,如下图所示:

 
// vite.config.js

import { defineConfig } from "vite";

export default defineConfig({
server: {
proxy: {
"/api": {
target: "http://localhost:3001",
changeOrigin: true,
rewrite: (path) => path.replace(/^\/api/, ""),
},
},
},
});
 

在 vite 导出的配置里边:

  • 添加server 配置项。
  • 在 server配置项下边添加 proxy配置项,值为一个对象,属性名为要代理的 URL 路径段,值为相关的配置。
  • 这里属性名设置为 /api,来配置转发前端 http://localhost:3000/api 开头的所有请求路径

 

在 proxy 配置对象中:

  • target,为实际的后端 URL,它会追加到属性名配置的 /api 这个片段的前面,例如访问 /api/some_end_point会转换为 http://localhost:3001/api/some_end_point
  • changeOrigin,是否改写 origin,设置为 true 之后,就会把请求 API header 中的 origin,改成跟 target 里边的域名一样了。
  • rewrite 可以把请求的 URL 进行重写,这里因为假设后端的 API 路径不带 /api 段,所以我们使用 rewrite去掉 /api。给 rewrite传递一个函数,函数的参数 path是前端请求的 API 路径,后面直接使用了 replace() 方法,在里面写一个正则表达式,把 /api开头的这一段替换为空。

这样 vite 的代理就配置好了。在实际前端请求的过程中,就可以直接使用 /api/some_endpoint这样的形式了:

fetch("/api/posts");
 

前面的 http 协议、域名和端口就都可以省略掉了,并且也没有了跨域的问题。

小结

前端跨域问题其实是一个安全问题,就是为了防止不同域名的服务之间进行互相访问,以避免恶意程序对后端资源进行非法获取。在开发的时候,我们就可以利用代理来把请求进行代理,把域名等改成一样的,这样就避免了跨越的问题。在 Vite 中设置代理,是在 vite.config.js配置文件里,配置 server属性,并在里边配置 proxy配置项。代理可以配置多个,根据不同的 API 路径去请求不同的后端路径,本文里只配置了一个 /api作为演示。

    关于配置项rewrite rewrite: (path) => path.replace(/^\/api/, "")   因为有的后端给的接口中含有/api/路径,所以这一行可以省去每个接口都写api的重复劳动;     例如一个请求域名是  http://www.google.com 请求地址是/api/user/info 我可以这么请求   axios({       method: 'post',       url: 'user/info',       data: {         user: 'xxx',               },     })   如果想要接口中不写api可以这么配置,proxy配置可以这么配置   server: {     proxy: {       '/api': {         target: 'http://www.google.com/api',         changeOrigin: true,         rewrite: (path) => path.replace(/^\/api/, "")       }     }   }     如果不要这一行  需要这么写 axios({       method: 'post',       url: 'api/user/info',       data: {         user: 'xxx',               },     }) server: {     proxy: {       '/api': {         target: 'http://www.google.com/',         changeOrigin: true,       }     }   }  

标签:http,跨域,api,配置,API,proxy,vite
From: https://www.cnblogs.com/qqfontofweb/p/17390702.html

相关文章

  • springboot跨域问题解决方案
    以下内容仅供自己学习使用,侵权私聊必删。在进行前后端交互的时候,往往会遇到以下的跨域问题。那么解决这种跨域的话,可以使用以下这种方法:(引自于程序员青戈)创建config配置目录新建CorsConfig类然后把下面的内容复制进去根据自己需要修改以下就可以解决跨域问题啦importo......
  • haproxy开启日志
    haproxy开启日志vi/etc/haproxy/haproxy.cfg#添加配置globallog127.0.0.1local2infodefaultsmodehttplogglobal#开启日志功能systemctlrestarthaproxy.service#修改日志vi/etc/rsyslog.c......
  • 使用 nodejs 从 0 实现简单易用的代理功能之 config.proxy
    从0实现config.proxyconfig.proxy类似于webpack的devServe中的代理,但更直观易用.本文为mockm的实现过程,编写此系列文章1是为了抛砖引玉,让想实现类似工具的朋友可以一起学习.2是也给自己做一个简单梳理.类型:string|object默认:http://www.httpbin.or......
  • 网络基础 登录对接CAS-跨域导致的一个意想不到的Bug
    登录对接CAS-跨域导致的一个意想不到的Bug背景描述业务需求是平台登录,接入Cas验证问题描述平台登录页,点击登录方式,跳转Cas登录页,提交登录请求,结果发现,又返回平台登录页;再次点击登录方式,登录成功,跳转到目标页面。问题排查排查方向-浏览器兼容性问题这个问题,开发人员在其......
  • Windows系列---【浏览器突然连不上网,报"ERR_PROXY_CONNECTION_FAILED"的解决方案】
    浏览器突然连不上网,报"ERR_PROXY_CONNECTION_FAILED"的解决方案1.问题电脑的浏览器里装的有梯子,突然有一天浏览器访问不了外网了,打开哪个网站都报"ERR_PROXY_CONNECTION_FAILED",但是微信可以正常使用。2.分析微信可以使用,显然是浏览器的问题,再看错误,明显是代理有问题。3.解......
  • 跨域问题和解决方式
    一、同源策略和跨域同源策略是一种约定,它是浏览器最核心也最基本的安全功能。同源是指"协议+域名+端口"三者都要相同,当一个请求url的协议、域名、端口三者之间任意一个与当前页面url不同即为跨域。二、跨域产生的问题同源策略会阻止一个域的javascript脚本和另外一个域进行交......
  • Vite-WeGPT聊天AI实例|vue3+pinia仿ChatGPT聊天界面
    基于vue3.x+vite4+pinia2仿chatgpt聊天模拟实例Vue3-WeGPT。基于Vite4.x+Vue3+Pinia2+VEPlus+Vue3-Markdown等技术实现仿ChatGPT聊天AI界面实例。整体界面简洁清新、支持2种界面布局、暗黑+亮色模式、全屏+半屏展示、Markdown语法解析、侧边栏收缩等功能。使用技术编辑器:cur......
  • vite.config.ts配置文件
    import{defineConfig}from'vite'importvuefrom'@vitejs/plugin-vue'import{resolve}from'path'importvueSetupExtendfrom'vite-plugin-vue-setup-extend'importAutoImporttfrom'unplugin-auto-import/v......
  • vite vue3 EsLint配置
    1、安装ESLintnpmi-Deslint2、初始化配置EsLintnpxeslint--init2-1、选择模式 2-2、选择语言模块 2-3、选择语言框架 2-4、是否使用ts 2-5、代码在哪里运行2-6、选择一个风格2-7、你想遵循哪一种风格指南2-8、希望配置文件是什么格式2-9、依赖......
  • AJAX POST&跨域 解决方案 - CORS
    跨域是我在日常面试中经常会问到的问题,这词在前端界出现的频率不低,主要原因还是由于安全限制(同源策略,即JavaScript或Cookie只能访问同域下的内容),因为我们在日常的项目开发时会不可避免的需要进行跨域操作,所以跨域能力也算是前端工程师的基本功之一。和大多数跨域的解......