位置: IT常识 - 正文

vue3项目中封装axios(vue3封装axios)

编辑:rootadmin
vue3项目中封装axios

推荐整理分享vue3项目中封装axios(vue3封装axios),希望有所帮助,仅作参考,欢迎阅读内容。

文章相关热门搜索词:vue3封装组件,vue项目axios封装,vue3封装axios,vue3封装axios,vue项目封装api,vue3项目中封装过哪些组件,vue3项目中封装过哪些组件,vue3项目中封装过哪些组件,内容如对您有帮助,希望把文章链接给更多的朋友!

目前前端最流行的网络请求库还是axios,所以对axios的封装很有必要,此次基于vue3+ts的环境下。

axios的基本使用import axios from 'axios'// console.log('adh')axios.get('http://XXX.xxx.xxx.xxx:8000/home').then((res) => { console.log(res.data)})

axios.get()会返回一个Promise对象,所以可以用.then获取返回的数据。

axios.all()方法axios.all([ axios.get('http://httpbin.org/get').then((res) => { console.log(res.data) }), axios.post('http://httpbin.org/post').then((res) => { console.log(res.data) })])axios一些基本配置

在axios中,有一些默认配置,它们是存在于axios.defaults中的,比如我们经常会用到的baseURL、timeout属性

axios.defaults.baseURL = 'http://httpbin.org'axios.defaults.timeout = 10000axios的拦截器

在平常的使用中,我们经常需要对axios请求进行拦截以处理一些特殊情况,如获取token、处理异常等,这时候我们就需要使用axios的拦截器()。

axios.interceptors.request.use( (config) => { return config }, (error) => { return error })axios.interceptors.response.use( (res) => { console.log(res.data) }, (error) => { return error })

如上,axios.interceptors.request是对请求的拦截,此时可以为请求添加headers,添加token等操作,二axios.interceptors.response则是对请求的返回进行拦截,在此处我们可以统一返回的数据结构以及对错误进行一些统一的处理

封装axios-封装基础属性vue3项目中封装axios(vue3封装axios)

首先,我们先确认一下基本思路,我们把主要的逻辑封装成一个类,然后编写一个出口文件,将该类导出,需要注意的是,往这个类中传入哪些参数,诚然,我们可以直接在类中定义诸如BASE_URL、timeout、interceptors等axios的属性或方法,但是为了今后的可适配性更高,我们应该尽量的把可配置的属性作为变量传入我们欲封装的类中,下面先进行一个基本的封装:

// 封装类import axios from 'axios'import { AxiosInstance, AxiosRequestConfig } from 'axios'class ZWRequest { instance: AxiosInstance constructor(config: AxiosRequestConfig) { this.instance = axios.create(config) } request(config: AxiosRequestConfig): void { this.instance.request(config).then((res) => { console.log(res) // 此处能成功打印出结果代表成功 }) }}export default ZWRequest// 出口文件index.tsimport ZWRequest from './request'import { BASE_URL, timeout } from './request/config'const zwRequest = new ZWRequest({ baseURL: BASE_URL, // 配置参数 timeout: timeout // 配置参数})export default zwRequest// 在main.ts中测试import ZWRequest from './service/index.ts'ZWRequest.request({ url: '/post', method: 'POST'})封装拦截器

上面的封装可以传入BASE_URL、timeout等一些基础属性,但是对于拦截器interceptors还是不能实现配置,所以下一步我们改造一下使其可以传入拦截器:

// 封装类import axios from 'axios'import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios'// 自建一个用于匹配interceptors的类型interface ZWRequestInterceptors { requestInterceptor?: (config: AxiosRequestConfig) => AxiosRequestConfig // 这是个函数类型 requestErrorInterceptor?: (error: any) => any responseInterceptor?: (config: AxiosResponse) => AxiosResponse responseErrorInterceptor?: (error: any) => any}/** 再新建一个一个类型继承AxiosRequestConfig类型,并在其中设立一个属性,该属性对应上一步建立的类型,如此,我们就可以用这个类型来代替封装类的constructor()函数传入的参数类型了,在此基础上,完成对拦截器参数的传入。*/interface ZWRequestConfig extends AxiosRequestConfig { interceptors?: ZWRequestInterceptors}class ZWRequest { instance: AxiosInstance interceptors?: ZWRequestInterceptors constructor(config: ZWRequestConfig) { this.instance = axios.create(config) this.interceptors = config.interceptors this.instance.interceptors.request.use( this.interceptors?.requestInterceptor, this.interceptors?.requestErrorInterceptor ) this.instance.interceptors.response.use( this.interceptors?.responseInterceptor, this.interceptors?.responseErrorInterceptor ) } request(config: ZWRequestConfig): void { this.instance.request(config).then((res) => { console.log(res) }) }}export default ZWRequest// 出口函数index.ts/** 我们可以在出口函数中同意规定拦截器的形式以及相应的处理,这样做的好处是如果我们想再生成一个可用的axios对象,如ZWRequest2,而且想实现与ZWRequest不一样的拦截方法,那么就只需要在该页面再新创建一个对象即可 */import ZWRequest from './request'import { BASE_URL, timeout } from './request/config'const zwRequest = new ZWRequest({ baseURL: BASE_URL, timeout: timeout, interceptors: { requestInterceptor: (config) => { console.log('发送请求成功11', config) return config }, responseInterceptor: (res) => { console.log('返回成功11', res) return res } }})const zwRequest2 = new ZWRequest({ baseURL: BASE_URL, timeout: timeout, interceptors: { requestInterceptor: (config) => { console.log('发送请求成功22', config) return config }, responseInterceptor: (res) => { console.log('返回成功22', res) return res } }})export default zwRequest// main.ts中实验ZWRequest.request({ url: '/post', method: 'POST'})ZWRequest2.request({ url: '/post', method: 'POST'})封装公用的拦截器

上面的封装中,拦截器是由每个实例传入的,但是有时候我们就是想所有的实例都拥有共同的拦截器,那么我们就需要在axios封装类里面添加共有的拦截器了(实例传入的拦截器也并不会被取消),只需要在axios封装类中添加以下代码即可实现全局的拦截:

this.instance.interceptors.request.use( (config) => { console.log('共有的请求时成功拦截') return config }, (error) => { console.log('共有的请求时失败拦截') return error } )this.instance.interceptors.response.use( (res) => { console.log('共有的返回时成功的拦截') return res }, (error) => { console.log('共有的返回时失败的拦截') return error })对单个请求传入拦截器

其实上面对拦截器的封装已经基本可以满足平时的开发需求了,但是如果你想更灵活些,比如每个请求都可以传入自己的拦截器,那么请往下看,如果我们需要再请求时传入拦截器,那么就需要看看我们是怎么调用的。目前,我们采用ZWRequest.request(config)的方式调用axios请求,很显然,在封装类中,config参数的类型是:AxiosRequestConfig,这个类型很显然不能传入拦截器参数。

request(config: AxiosRequestConfig): void { this.instance.request(config).then((res) => { console.log(res) }) }

所以为了能够往request方法中传入拦截器参数,我们需要将AxiosRequestConfig类型化成我们上面新建立的类型ZWRequestConfig,这样就可以从单个请求处传入各自的拦截器了。

// 改造axios封装类中的request方法request(config: ZWRequestConfig): void { // 对单独请求传来的拦截器进行处理 if (config.interceptors?.requestInterceptor) { config = config.interceptors?.requestInterceptor(config) } this.instance.request(config).then((res) => { if (config.interceptors?.responseInterceptor) { res = config.interceptors?.responseInterceptor(res) } console.log(res) })}// 在main.ts中进行测试ZWRequest.request({ url: '/post', method: 'POST', interceptors: { requestInterceptor: (config) => { console.log('单独请求的请求成功拦截') return config }, responseInterceptor: (res) => { console.log('单独请求的响应成功拦截') return res } }})

可以正常打印,成功!

对request请求方法封装

上面其实已经对request请求进行了大部分的封装了,但是此时的各种返回还局限在类里面,我们在main.ts中是无法拿到的,那么想要拿到返回值,我们就需要进一步操作,其实就是利用promise将结果返回出来:

// 对request方法的改造request<T>(config: ZWRequestConfig): Promise<T> { return new Promise((resolve, reject) => { // 对单独请求传来的拦截器进行处理 if (config.interceptors?.requestInterceptor) { config = config.interceptors?.requestInterceptor(config) } if (config.showLoading === false) { // 代表该请求不想显示加载动画 this.showLoading = config.showLoading } this.instance .request<any, T>(config) .then((res) => { // 每次请求返回后将showLoading的值改为默认值,以免被这次请求穿的配置影响下一次请求的加载动画显示 this.showLoading = DEFAULT_LOADING if (config.interceptors?.responseInterceptor) { res = config.interceptors?.responseInterceptor(res) } resolve(res) console.log(res) }) .catch((error) => { console.log(error) this.showLoading = DEFAULT_LOADING reject(error) }) })}// 在main.ts中实验interface dataType { data: any returnCode: string success: boolean}ZWRequest.request<dataType>({ url: '/home/multidata', method: 'GET' // showLoading: false}).then((res) => { console.log(res.data) console.log(res.returnCode) console.log(res.success)})

由上可见,其实操作很简单,那么接下来即使利用已经写好的request方法来些各种常用的请求调用方法了,就不多做赘述了,代码如下:

get<T>(config: ZWRequestConfig): Promise<T> {return this.request<T>({ ...config, method: 'GET' })}post<T>(config: ZWRequestConfig): Promise<T> { return this.request<T>({ ...config, method: 'POST' })}delete<T>(config: ZWRequestConfig): Promise<T> { return this.request<T>({ ...config, method: 'DELETE' })}

以上就是本人对axios的全部封装,完毕!

本文链接地址:https://www.jiuchutong.com/zhishi/295860.html 转载请保留说明!

上一篇:我把这一年学的 CSS 知识点精炼总结成了一篇文档(这一年我学会了)

下一篇:JavaScript:实现复制粘贴剪切功能(js实现dialog)

  • 哈啰出行单车怎么还车(哈啰出行单车怎么关闭车锁)

    哈啰出行单车怎么还车(哈啰出行单车怎么关闭车锁)

  • qq如何关闭王者荣耀战绩显示(qq如何关闭王者荣耀)

    qq如何关闭王者荣耀战绩显示(qq如何关闭王者荣耀)

  • 苹果手机空格键怎么打下一行(苹果手机空格键在哪里怎么样操作)

    苹果手机空格键怎么打下一行(苹果手机空格键在哪里怎么样操作)

  • 手机为什么老显示请检查网络设置(手机为什么老显示关机重启)

    手机为什么老显示请检查网络设置(手机为什么老显示关机重启)

  • 苹果13.3小圆点怎么设置(苹果13小圆点没反应)

    苹果13.3小圆点怎么设置(苹果13小圆点没反应)

  • 万能钥匙卸载了安全吗(万能钥匙卸载了怎么安装不了)

    万能钥匙卸载了安全吗(万能钥匙卸载了怎么安装不了)

  • 写字板是windows的一个什么程序(写字板是windows7的一个什么)

    写字板是windows的一个什么程序(写字板是windows7的一个什么)

  • 微信屏蔽了朋友圈还能看到吗(微信屏蔽了朋友圈点赞还能看到吗)

    微信屏蔽了朋友圈还能看到吗(微信屏蔽了朋友圈点赞还能看到吗)

  • 荣耀9x怎么开启语音助手(荣耀9x怎么开启yoyo)

    荣耀9x怎么开启语音助手(荣耀9x怎么开启yoyo)

  • 微信分身可以分3个吗(微信分身可以分几个)

    微信分身可以分3个吗(微信分身可以分几个)

  • coloros7什么时候出(oppocolors7什么时候更新)

    coloros7什么时候出(oppocolors7什么时候更新)

  • iphone11来电不显示通讯录名字(苹果11来电不显示号码怎么办)

    iphone11来电不显示通讯录名字(苹果11来电不显示号码怎么办)

  • doc与docx到底用哪一个(doc 和docx有何区别)

    doc与docx到底用哪一个(doc 和docx有何区别)

  • 为什么突然手机卡不显示了(为什么突然手机卡没信号了)

    为什么突然手机卡不显示了(为什么突然手机卡没信号了)

  • 苹果xs重启方法(苹果xs重启方法图解)

    苹果xs重启方法(苹果xs重启方法图解)

  • mp4文件服务器运行失败(mp4文件服务器运行失败播放器)

    mp4文件服务器运行失败(mp4文件服务器运行失败播放器)

  • oppoa11是闪充吗(oppoa11支不支持闪充)

    oppoa11是闪充吗(oppoa11支不支持闪充)

  • 查找与替换在哪里找(查找与替换在哪个菜单选项卡)

    查找与替换在哪里找(查找与替换在哪个菜单选项卡)

  • ps钢笔生成选区快捷键(ps钢笔工具如何建立选区)

    ps钢笔生成选区快捷键(ps钢笔工具如何建立选区)

  • 世界上第一台存储程序的通用电子数字计算机是(世界上第一台存储计算机叫什么)

    世界上第一台存储程序的通用电子数字计算机是(世界上第一台存储计算机叫什么)

  • 制作视频时创意有哪些技巧(制作视频的创意)

    制作视频时创意有哪些技巧(制作视频的创意)

  • 如何让动态评分恢复5(如何让动态评分变高)

    如何让动态评分恢复5(如何让动态评分变高)

  • 4500a是多少毫安(4500毫安是什么概念)

    4500a是多少毫安(4500毫安是什么概念)

  • 如何把文件夹加密码锁(如何把文件夹加密码锁手机)

    如何把文件夹加密码锁(如何把文件夹加密码锁手机)

  • Win10提示音响个不停怎么办?Win10提示音响个不停的解决方法(windows 10音响没有声音)

    Win10提示音响个不停怎么办?Win10提示音响个不停的解决方法(windows 10音响没有声音)

  • 残疾人个人所得税
  • 股权分配利润应该怎么做账
  • 电脑填制记账凭证实训心得
  • 预算收入包括增值税吗
  • 所有者权益股东权益
  • 进项税额转出忘记填在申报表里
  • 社保缴费基数什么意思
  • 预付账款借方怎么处理
  • 房产报废手续
  • 收到其他与筹资活动有关的现金计算公式
  • 建筑物加高违法么
  • 房地产收到客户房款如何做账
  • 城建税教育附加地方教育附加的税率
  • 发票是不是都一样
  • 民办幼儿园所得税优惠政策
  • 一般纳税人房租没有发票怎么办
  • 适用简易计税方法的企业提供适用零税率的应税服务
  • 股份转让的溢价是什么意思
  • 银行利息现金流量表什么科目
  • 进项票下个月才能到,怎么避免交税
  • 企业所得表怎么填写
  • 个税申报时个人怎么填
  • 公司钱被取走怎么处理
  • 新版edge浏览器兼容ie
  • 桌面级cpu天梯图快科技
  • PHP:mb_check_encoding()的用法_mbstring函数
  • 我告诉你win7旗舰版
  • hp是什么软件
  • 资产提前报废需要什么资料
  • 无形资产的会计处理
  • 借银行卡给别人过账有什么风险
  • 饭店的手撕发票可以报销吗
  • 用友自动生成凭证怎么操作
  • 劳务费怎么做会计分裤
  • torchaudio教程
  • 关于专利技术转让的说法
  • 应收账款坏账准备怎么计算
  • 营改增之后增值税怎么算
  • 轿车折旧年限为几年
  • 生产企业一般贸易出口退税流程解析
  • 管理费用主要包括
  • 软件服务费计入管理费用哪个明细
  • 车间设备折旧费计入产品成本吗
  • 多缴附加税退税怎么做账
  • 营业税改增值税时间
  • 其他权益工具账面价值和公允价值
  • 多交增值税退税抵欠怎么处理
  • 销售退回的会计分录全过程
  • 被列为经营异常的企业合法吗
  • 小规模购买税控盘分录怎么写
  • 代扣职工个人所得税的账务处理
  • 上期留抵税额怎么在账上提现
  • 怎么把应付账款冲平
  • 计提人工成本会计分录
  • 费用报销银行转账用途怎么写
  • mysql查询语句菜鸟教程
  • pages怎么标记
  • mac电脑连wifi总是断开
  • xp怎么删除电脑系统
  • ubuntu下mysql的常用命令
  • mac的dns怎么设置最快
  • ubuntu下的vivado2022怎么打开
  • centos启动卡在了启动界面
  • macbook qq截图存在哪
  • Linux磁盘配额步骤
  • vsftpd的配置文件
  • Unity3D游戏开发引擎
  • opengl mfc
  • bootstrap怎么引用
  • tensorflow.nn
  • shell脚本 教程
  • 使用Raygun对Node.js应用进行错误处理的方法
  • 注会证可以挂靠吗?挂靠合法吗?
  • 换发票需要交钱吗
  • 江苏国税申报怎么操作流程
  • 更改国名
  • 锐志2.5新车报价
  • 卷烟批发环节的税率
  • 山东发票认证勾选平台网址
  • 一般纳税人什么意思
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

    网站地图: 企业信息 工商信息 财税知识 网络常识 编程技术

    友情链接: 武汉网站建设