Vue合理配置axios并在项目中进行实际应用

本文涉及的产品
.cn 域名,1个 12个月
简介: Vue合理配置axios并在项目中进行实际应用

送人玫瑰,手有余香,你是什么,你的世界就是什么💡


前言


网络上与axios相关的教程、以及源码解析有很多,还有健全的官方文档,本篇文章面向于初学axios库的开发者,目标是快速上手,如果觉得本篇文章帮助到了你,也就达到了这篇文章的目的😊


安装依赖


本文中使用的是Vue CLI3.0,安装依赖使用vue add命令进行


  • axios安装


vue add axios
   # yarn | npm安装
  yarn add axios | npm install axios


  • 引用插件执行add命令后,CLI会自动帮我们在main.js中引用它,并做一些默认配置。接下来,带大家看一下,add命令都做了哪些事情


  • src下新建了一个plugins文件夹,这个文件夹用于存放Vue引入插件的相关配置文件


  • 在plugins文件夹中,新建了axios.js文件


  • 在package.json文件中添加了axios的依赖信息以及版本号(yarn | npm安装时会自动做这一步)


  • main.js中导入了axios的配置文件,方便全局使用axios


  • 使用插件


this.axios.${方法名}.then().catch()
// 例子
this.axios.get(url,requestData).then((res)=>{
   // 成功的回调
}).catch((err)=>{
   // 失败的回调
});
/*
  支持所有http请求以及请求取消、并发请求等功能,更多细节以及使用方法移步官方文档
  文档: [axios文档](http://www.axios-js.com/zh-cn/docs/)
*/


配置axios

接下来回到本文的重点,如何去合理的配置它以提高开发效率。本篇配置基于脚手架创建的axios.js进行修改

  • 创建配置文件如果使用脚手架进行安装axios,将会在在src目录下查找plugins文件夹,并在plugins文件夹下创建axios.js文件。如果使用yarn方式安装,请手动创建plugins文件夹以及对应的js文件。
  • 配置文件代码


"use strict";
import Vue from 'vue';
import axios from "axios";
import store from '../store/index';
let config = {
// baseURL在此处省略配置,考虑到项目可能由多人协作完成开发,域名也各不相同,此处通过对api的抽离,域名单独配置在base.js中
 // 请求超时时间
 timeout: 60 * 1000,
 // 跨域请求时是否需要凭证
 // withCredentials: true, // Check cross-site Access-Control
 heards:{
   get:{
     'Content-Type': 'application/x-www-form-urlencoded;charset=utf-8'
     // 将普适性的请求头作为基础配置。当需要特殊请求头时,将特殊请求头作为参数传入,覆盖基础配置
  },
   post:{
     'Content-Type': 'application/json;charset=utf-8'
     // 将普适性的请求头作为基础配置。当需要特殊请求头时,将特殊请求头作为参数传入,覆盖基础配置
  }
},
 // 在向服务器发送请求前,对数据进行处理,axios默认会序列化数据
 // transformRequest:[function(data){
 //
 // }],
 // 在传递给 then/catch 前,修改响应数据
 // transformResponse:[function(data){
 //
 // }]
};
/**
* 请求失败后的错误统一处理,当然还有更多状态码判断,根据自己业务需求去扩展即可
* @param {Number} status 请求失败的状态码
*/
const errorHandle = (status, other) => {
 // 状态码判断
 switch (status) {
     // 401: 未登录状态,跳转登录页
   case 401:
     // 跳转登录页
     break;
     // 403 token过期
   case 403:
     // 如果不需要自动刷新token,可以在这里移除本地存储中的token,跳转登录页
     break;
     // 404请求不存在
   case 404:
     // 提示资源不存在
     break;
   default:
     console.log(other);
}};
// 创建实例
const _axios = axios.create(config);
// 请求拦截器
_axios.interceptors.request.use(
 function(config) {
   // 从vuex里获取token
   const token = store.state.token;
   // 如果token存在就在请求头里添加
   token && (config.headers.token = token);
   return config;
},
 function(error) {
   // Do something with request error
   error.data = {};
   error.data.msg = "服务器异常";
   return Promise.reject(error);
}
);
// 响应拦截器
_axios.interceptors.response.use(
 function(response) {
  // 清除本地存储中的token,如果需要刷新token,在这里通过旧的token跟服务器换新token,将新的token设置的vuex中
   if(response.data.code===401){
     localStorage.removeItem("token");
  }
   // 只返回response中的data数据
   return response.data;
},
 function(error) {
   if(error){
     // 请求已发出,但不在2xx范围内
     errorHandle(error.status,error.data.msg);
     return Promise.reject(error);
  }else{
     // 断网
     return Promise.reject(error);
  }
}
);
// eslint-disable-next-line no-unused-vars
Plugin.install = function(Vue, options) {
 Vue.axios = _axios;
 window.axios = _axios;
 Object.defineProperties(Vue.prototype, {
   axios: {
     get() {
       return _axios;
    }
  },
   $axios: {
     get() {
       return _axios;
    }
  },
});
};
Vue.use(Plugin);
// 导出插件和_axios
export default {Plugin,_axios};


  • 在入口文件中进行引用


// main.js
 import './plugins/axios'


这里进行全局引用的原因:Vue脚手架推荐的使用方法,方便全局使用this.axios来访问。通过配置项创建 axios 实例的方式进行配置封装。最后将其导出并挂载到 Vue 的原型上即可,此时,每次修改 axios 配置,只需要修改对应的文件即可,不会影响到不相关的功能


  • 小结


现在给大家梳理下,我们对配置文件做了那些封装


  • 设置超时时间
  • 请求头的集中配置
  • 响应失败后对状态码进行统一处理
  • 在请求拦截中添加token
  • 在响应拦截中对token过期进行相应处理
  • api抽离
  • 接口域名抽离


抽离API和域名接口


为什么要进行API抽离?假设我们所有的请求都在业务代码中写this.$axios.get(),后期接口变更、有新的需求要多传参数过去,我们就要去业务代码里一个个去找然后进行修改,那将是一件很头疼的事。接下来带大家来实现API分离😃


  • 在src下创建api文件夹,创建index.js和base.js


640.png


  • api统一出口:index.js


将api接口根据功能划分为多个模块,利于多人开发,一个人负责一个模块的开发,方便日后接口的变更,将所有模块在此处引入,将引用暴露出去,然后挂载到Vue原型既可通过this.$api.模块名.方法名进行引用

/**
    * api统一出口
    * */
   // 网站管理接口
   import websiteManageAPI from './websiteManageAPI';
   // 其他模块接口
   // 导出接口
   export default {
       websiteManageAPI,
       // ...
  }


  • 模块文件:websiteManageAPI.js


推荐命名格式为:模块名+APi,此文件用于将当前模块下的所有请求封装成对象,在使用时直接调用即可


/*
  * 网站管理接口
  * */
   import services from '../plugins/axios'
   import base from './base'; // 导入接口域名列表
   const websiteManageAPI = {
       // 登录
       login(params){
           return services._axios.post(`${base.lk}/login`,params);
      },
       // 测试post接口
       postJSON(params){
           return services._axios.post(`${base.lk}/getter/postJSON`,params);
      },
       // 测试get接口
       getJSON(pageNo,pageSize){
           return services._axios.get(`${base.lk}/getter/getJSON`,{params:{pageNo:pageNo,pageSize:pageSize}});
      }
  };
  export default websiteManageAPI;


  • 接口域名文件:base.js


将每个开发者的接口地址封装成对象,在模块中进行引用时域名遇到变更,可直接修改此处的配置文件,快速修改为变更后的域名。


/*
  * 接口域名管理
  *
  * */
   const base = {
       lk:"https://www.kaisir.cn/user",
       other:"https://kf.kaisir.cn/api"
  };
   export default base;


  • 原型挂载


将暴露出来的接口挂载到原型上,可方便接口的调用,当然你也可以按需加载,用到哪个模块的接口在在哪个模块下进行引用。


// 挂载到原型(main.js)
   Vue.prototype.$api = api;


实际应用


例如这样一个场景:后端的所有接口都需要登录后,根据成功登录返回的token进行访问。后端接口使用shiro+jwt实现接口鉴权和token发放


  • 页面加载时,从本地存储中获取token


 

// App.vue,created生命周期
   const token = localStorage.getItem("token");


  • 判断token是否存在,如果不存在则获取


//
   if(lodash.isEmpty(token)){
       // 跳转登录页:此处仅用于演示,用户名和密码为固定数据,实际需求为跳转登录页面进行授权
       const userInfo = {
         "username":"测试",
         "password":"0x89oikklsa"
      };
       // 调用登录api
       this.$api.websiteManageAPI.login(userInfo).then((res)=>{
         // 将token进行存储并更新到vuex中
         localStorage.setItem("token",res.token);
         this.$store.state.token = res.token;
      });
  }else{
       // 更新vuex中的token
       this.$store.state.token = token;
  }


  • 执行结果


640.png


  • 调用其他接口,测试请求头token是否添加成功


// 测试其他接口能否调用成功
   this.$api.websiteManageAPI.getJSON(1,3).then((res)=>{
       console.log("接口调用成功");
       console.log(res)
  });
}


  • 执行结果


640.png


写在最后


  • 文中如有错误,点击下方阅读原文,在评论区留言,如果这篇文章帮到了你,欢迎点赞和关注😊
相关文章
|
2月前
|
JavaScript 容器
乾坤qiankun框架搭建 主应用为vue3的项目。
乾坤qiankun框架搭建 主应用为vue3的项目。
159 2
|
28天前
|
数据采集 监控 JavaScript
在 Vue 项目中使用预渲染技术
【10月更文挑战第23天】在 Vue 项目中使用预渲染技术是提升 SEO 效果的有效途径之一。通过选择合适的预渲染工具,正确配置和运行预渲染操作,结合其他 SEO 策略,可以实现更好的搜索引擎优化效果。同时,需要不断地监控和优化预渲染效果,以适应不断变化的搜索引擎环境和用户需求。
|
14天前
|
JavaScript 前端开发
如何在 Vue 项目中配置 Tree Shaking?
通过以上针对 Webpack 或 Rollup 的配置方法,就可以在 Vue 项目中有效地启用 Tree Shaking,从而优化项目的打包体积,提高项目的性能和加载速度。在实际配置过程中,需要根据项目的具体情况和需求,对配置进行适当的调整和优化。
|
15天前
|
存储 缓存 JavaScript
如何在大型 Vue 应用中有效地管理计算属性和侦听器
在大型 Vue 应用中,合理管理计算属性和侦听器是优化性能和维护性的关键。本文介绍了如何通过模块化、状态管理和避免冗余计算等方法,有效提升应用的响应性和可维护性。
|
27天前
|
JavaScript 前端开发 开发者
如何在 Visual Studio Code (VSCode) 中使用 ESLint 和 Prettier 检查代码规范并自动格式化 Vue.js 代码,包括安装插件、配置 ESLint 和 Prettier 以及 VSCode 设置的具体步骤
随着前端开发技术的快速发展,代码规范和格式化工具变得尤为重要。本文介绍了如何在 Visual Studio Code (VSCode) 中使用 ESLint 和 Prettier 检查代码规范并自动格式化 Vue.js 代码,包括安装插件、配置 ESLint 和 Prettier 以及 VSCode 设置的具体步骤。通过这些工具,可以显著提升编码效率和代码质量。
262 4
|
25天前
|
JavaScript 前端开发 Java
SpringBoot项目的html页面使用axios进行get post请求
SpringBoot项目的html页面使用axios进行get post请求
42 2
|
2月前
|
JavaScript
如何在 Vue 项目中选择合适的模块格式
【10月更文挑战第20天】选择合适的模块格式需要综合考虑多个因素,没有一种绝对正确的选择。需要根据项目的具体情况进行权衡和分析。在实际选择过程中,要保持灵活性,根据项目的发展和变化适时调整模块格式。
21 7
|
27天前
Vue3 项目的 setup 函数
【10月更文挑战第23天】setup` 函数是 Vue3 中非常重要的一个概念,掌握它的使用方法对于开发高效、灵活的 Vue3 组件至关重要。通过不断的实践和探索,你将能够更好地利用 `setup` 函数来构建优秀的 Vue3 项目。
|
2月前
|
JavaScript 前端开发 编译器
在 Vue 项目中使用 ES 模块格式的优点
【10月更文挑战第20天】在 Vue 项目中使用 ES 模块格式具有众多优点,这些优点共同作用,使得项目能够更高效、更可靠地开发和运行。当然,在实际应用中,还需要根据项目的具体情况和需求进行合理的选择和配置。
33 6
|
27天前
|
JavaScript 测试技术 UED
解决 Vue 项目中 Tree shaking 无法去除某些模块
【10月更文挑战第23天】解决 Vue 项目中 Tree shaking 无法去除某些模块的问题需要综合考虑多种因素,通过仔细分析、排查和优化,逐步提高 Tree shaking 的效果,为项目带来更好的性能和用户体验。同时,持续关注和学习相关技术的发展,不断探索新的解决方案,以适应不断变化的项目需求。
下一篇
无影云桌面