Vue-cli3.x + axios 跨域方案踩坑指北


Posted in Javascript onJuly 04, 2019

缘起

最近实验课上需要重构以前写过的一个项目(垃圾堆),需要添加发生邮件提醒的功能,记得以前写过一个PHP版的实现,所以想把PHP写的功能整理成一个服务,然后在前端调用。但是这个项目是JavaWeb,也就是说我需要面对跨域的问题。不过本篇文章,讲的并不是如何解决这样的跨域问题,而是我在找如何解决这个问题的路上遇到的坑。

其实,在前端工程化大行其道的现在,前后端已经分离开来,前端为了提高工作流效率往往自己开一个小型的服务器,就比如webpack.devServer。这样在前端调用后端接口的时候必然会面临跨域的问题,如题,Vue-cli 3.x + axios 跨域方案 就是解决这里的跨域问题。这里的跨域是基于webpack的devServer的代理功能(proxy)来实现开发环境中的跨域,也就是说本篇所讨论的并不能解决生产环境下的跨域问题,因为webpack.devServer是DevDependencies,一旦打包上线,这个proxy代理就会失效。但是这并不妨碍我们开发中使用跨域来提高开发效率和体验。

开始填坑

其实这个问题解决起来很简单,网上也是很多教程,为了文章完整性,我这里也做一个尽量完备的展示,介绍如何配置Vue-cli 3.x来实现跨域 。

vue.config.js中devServer.proxy的配置解析

Vue-cli3.x比Vue-cli2.x构建的项目要简化很多,根目录下只有./src和./public文件夹,所以网上很多教程说config目录下的vue.config.js是说的vue-cli 2.x版本。那么对于Vue-cli 3.x版本,构建也很简单,直接在根目录里建一个vue.config.js配置文件就可以了,我们直接看devServer.proxy里的代码:

我这里devServer的地址是:localhost:8080/,需要代理的地址是:localhost/index/phpinfo.php (我自己写的一个测试跨域用的php,返回一个‘ok')

下面是根据上面的地址需要配置的proxy对象

devServer : {
    proxy : {
      '/index' : {
        target : 'http://localhost/index',
        // ws : true,
        changeOrigin : true,
        pathRewrite : {
          '^/index' : ''
        }
      }
    }
  }

大部分教程到这里就停止了,但是我在这里做一个扩展,为了让读者理解这里的配置是如何起作用的(以下内容整理自http-proxy-middleware的npm描述里,http-proxy-middleware是一个npm模块,是proxy的底层原理实现)。

foo://example.com:8042/over/there?name=ferret#nose
     \_/  \______________/\_________/ \_________/ \__/
     |      |      |      |    |
    scheme   authority    path    query  fragment

以我上面的配置为例,'/index'这个key在http-proxy-middleware中被称为context——用来决定哪些请求需要被target对应的主机地址(这里是http://localhost/index)代理,它可以是 字符串,含有通配符的字符串,或是一个数组,分别对应于path matching(路径匹配)wildcard path matching(通配符路径匹配)multiple path matching(多路径匹配),而这里的path指的就是上图所标识的path段。

简言之,这个key就是匹配path的,一旦匹配到符合的path,就会把请求转发的代理主机去,而代理主机的地址就是target字段对应的内容。

那pathRewrit是什么意思呢?意如其名,路径重写。就是把模式(这里是^/index)匹配到的path重写为对应的路径(这里是'',相当于删除了这个匹配到的路径)。除了删除,还有在原有路径上添加一个基础路径,或是改写一个路径的方式,这可以参考http-proxy-middleware的npm描述的option.pathRewrite章节 。

在Vue中使用axios

这个使用任意一个ajax封装的库都是可行的,axios,jquery.ajax或者是vue-resource都是可以的。

在Vue中使用axios,网上有两种方法,一种是将axios加入Vue的原型里,我更推荐第二种方法:

npm install axios vue-axios
import axios from 'axios';
import VueAxios from 'vue-axios';
Vue.use(VueAxios,axios);

以我上面的proxy配置为基础,想要让代理成功转发到localhost/index/phpinfo.php,在Vue实例中axios需要这样写访问地址:

this.axios.get('/index/phpinfo.php').then((res)=>{
    console.log(res);
   })

我们来分析这些代码整个发挥作用的原理是什么?首先,axios去访问/index/phpinfo.php,这是个相对地址,所以真实访问地址其实是localhost:8080/index/phpinfo.php,然而/index/phpinfo.php被我们配置的/index匹配到了 ,所以访问被proxy代理,那转发到哪个路径呢?在pathRewrite中,我们将模式^/index的路径清除了,所以最终的访问路径是 target+pathRewrite+ 剩余的部分 , 这样也就是 http://localhost/index++/phpinfo.php

坑点

可能出现即使配置了proxy,但是依然没有任何卵用。

  • 大部分情况是因为你的proxy配置和你的访问路径不匹配,或者即使匹配到了,但是转发出去的地址不对,没有命中后端给的API
  • 或者看看axios,有没有使用正确姿势?
  • 还有一点,或许你看到返回的response里的url依然显示的是本地主机,但是数据已经正常返回,这是正常的,因为我们访问的本来就是本地主机,只不过proxy转发了这个请求到一个新的地址。

后续

本篇只解决了开发环境下的跨域问题,实际线上还不能跨域,目前这里有一些方案:

  1. Nginx反向代理跨域
  2. JSONP
  3. CORS

下一次讨论这个跨域问题,尝试解决。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
ajax 文件上传应用简单实现
Mar 03 Javascript
关于javascript function对象那些迷惑分析
Oct 24 Javascript
点击进行复制的JS代码实例
Aug 23 Javascript
JS随机漂浮广告代码具体实例
Nov 19 Javascript
一个简单的jquery进度条示例
Apr 28 Javascript
jquery动态调整div大小使其宽度始终为浏览器宽度
Jun 06 Javascript
删除javascript所创建子节点的方法
May 21 Javascript
cocos2dx骨骼动画Armature源码剖析(一)
Sep 08 Javascript
jQuery Mobile页面返回不需要重新get
Apr 26 Javascript
微信小程序 chooseImage选择图片或者拍照
Apr 07 Javascript
vue.js声明式渲染和条件与循环基础知识
Jul 31 Javascript
vue前端和Django后端如何查询一定时间段内的数据
Feb 28 Vue.js
JS开发常用工具函数(小结)
Jul 04 #Javascript
Vue.js 中的实用工具方法【推荐】
Jul 04 #Javascript
vue引入微信sdk 实现分享朋友圈获取地理位置功能
Jul 04 #Javascript
JS前端知识点总结之页面加载事件,数组操作,DOM节点操作,循环和分支
Jul 04 #Javascript
微信小程序自定义弹窗实现详解(可通用)
Jul 04 #Javascript
Vue 3.x+axios跨域方案的踩坑指南
Jul 04 #Javascript
Vue.js递归组件实现组织架构树和选人功能
Jul 04 #Javascript
You might like
神族 Protoss 历史背景
2020/03/14 星际争霸
业余方法DIY电子管FM收音机
2021/03/02 无线电
ThinkPHP后台首页index使用frameset时的注意事项分析
2014/08/22 PHP
php使用ereg验证文件上传的方法
2014/12/16 PHP
一个PHP实现的轻量级简单爬虫
2015/07/08 PHP
PHP测试成功的邮件发送案例
2015/10/26 PHP
PHP实现bitmap位图排序与求交集的方法
2016/07/28 PHP
Yii 框架控制器创建使用及控制器响应操作示例
2019/10/14 PHP
javascript中callee与caller的用法和应用场景
2010/12/08 Javascript
某人初学javascript的时候写的学习笔记
2010/12/30 Javascript
JS阻止冒泡事件以及默认事件发生的简单方法
2014/01/17 Javascript
JavaScript中的依赖注入详解
2015/03/18 Javascript
零基础轻松学JavaScript闭包
2016/12/30 Javascript
微信小程序遇到修改数据后页面不渲染的问题解决
2017/03/09 Javascript
BootStrap表单宽度设置方法
2017/03/10 Javascript
解决vue2.x中数据渲染以及vuex缓存的问题
2017/07/13 Javascript
Kindeditor单独调用单图上传增加预览功能的实例
2017/07/31 Javascript
React Form组件的实现封装杂谈
2018/05/07 Javascript
js作用域和作用域链及预解析
2019/04/11 Javascript
[54:57]DOTA2-DPC中国联赛定级赛 Aster vs DLG BO3第二场 1月8日
2021/03/11 DOTA
基于Python对象引用、可变性和垃圾回收详解
2017/08/21 Python
python回调函数中使用多线程的方法
2017/12/25 Python
浅析python中numpy包中的argsort函数的使用
2018/08/30 Python
Python实现微信翻译机器人的方法
2019/08/13 Python
python批量将excel内容进行翻译写入功能
2019/10/10 Python
python实现简单的购物程序代码实例
2020/03/03 Python
Keras中 ImageDataGenerator函数的参数用法
2020/07/03 Python
打架检讨书500字
2014/01/29 职场文书
爱的奉献演讲稿
2014/09/10 职场文书
大学生万能检讨书范例
2014/10/04 职场文书
无房证明样本
2015/06/17 职场文书
运输公司工作总结
2015/08/11 职场文书
创业计划书之家教中心
2019/09/25 职场文书
Nginx下配置Https证书详细过程
2021/04/01 Servers
nginx.conf配置文件结构小结
2022/04/08 Servers
flex布局中使用flex-wrap实现换行的项目实践
2022/06/21 HTML / CSS