位置: 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照片墙去掉)

  • 苹果11在保修期充电器坏了(苹果11在保修期内换电池多少钱)

    苹果11在保修期充电器坏了(苹果11在保修期内换电池多少钱)

  • 小米8关机键过于灵敏(小米手机关机键坏了怎么办)

    小米8关机键过于灵敏(小米手机关机键坏了怎么办)

  • 用了淘金币如果退款会退回来吗(用了淘金币退款怎么办)

    用了淘金币如果退款会退回来吗(用了淘金币退款怎么办)

  • 微信公众号设了星标有什么用(微信公众号设了私密号别人看得见吗)

    微信公众号设了星标有什么用(微信公众号设了私密号别人看得见吗)

  • 微信文档过期了如何免费恢复(微信文档过期了怎么恢复正常)

    微信文档过期了如何免费恢复(微信文档过期了怎么恢复正常)

  • 小棉袄直播app怎么下载不了

    小棉袄直播app怎么下载不了

  • matlab终止运行命令(matlab终止运算)

    matlab终止运行命令(matlab终止运算)

  • word怎么设置艺术字的环绕方式(word怎么设置艺术字字体格式)

    word怎么设置艺术字的环绕方式(word怎么设置艺术字字体格式)

  • 微信号加好友频繁被限制登录怎么办(微信号加好友频繁怎么解除)

    微信号加好友频繁被限制登录怎么办(微信号加好友频繁怎么解除)

  • 被拉黑还能收到短信吗(被拉黑还能收到验证消息吗)

    被拉黑还能收到短信吗(被拉黑还能收到验证消息吗)

  • iphone6splus屏幕材质(iphone6splus屏幕材质lcd吗)

    iphone6splus屏幕材质(iphone6splus屏幕材质lcd吗)

  • 苹果8支持反向充电吗(苹果支持反向充电的手机有哪些)

    苹果8支持反向充电吗(苹果支持反向充电的手机有哪些)

  • 金山文档小程序怎么保存(金山文档小程序怎么多人在线编辑一个表格)

    金山文档小程序怎么保存(金山文档小程序怎么多人在线编辑一个表格)

  • 快手直播必须是本人么(快手直播必须是认证本人吗)

    快手直播必须是本人么(快手直播必须是认证本人吗)

  • oppo桌面翻页设置方法(oppo手机桌面翻页方式怎么弄)

    oppo桌面翻页设置方法(oppo手机桌面翻页方式怎么弄)

  • 苹果电脑怎么切换系统(苹果电脑怎么切换中英文)

    苹果电脑怎么切换系统(苹果电脑怎么切换中英文)

  • 视频hdr什么意思(hdr视频开启还是关闭好)

    视频hdr什么意思(hdr视频开启还是关闭好)

  • 前端练手3D爱心(太原市插画工作室)

    前端练手3D爱心(太原市插画工作室)

  • phpcms v9是什么(phpcms rce)

    phpcms v9是什么(phpcms rce)

  • 进项税额转出怎么操作
  • 新购车辆车船税多少钱
  • 天猫国际的店铺是正品吗 感觉很便宜
  • 一般纳税人购买并销售免税货物所发生的运输费用
  • 政策性搬迁损失赔偿标准
  • 购入材料用于安装工程
  • 结转税金需要附件吗
  • 2020年个体工商户税收政策超出额度怎么征收
  • 汇算清缴前取得暂估发票
  • 零报税企业怎么做汇算清缴
  • 一般纳税人可以开3%的发票吗
  • 公司员工租金取得专用发票能否抵扣?
  • 专票的有效期是什么意思
  • 月初开票能抵扣上月的税吗
  • 行政单位库存物资管理办法
  • 单位缴纳的社保算不算工资
  • 企业收到留抵退税宣传报道
  • win11 老机器
  • 车船税收费标准2023年多少钱
  • 会计主要做些啥
  • 如何把文件夹加密码锁手机
  • 新成立的公司没有社保如何投标
  • 住房补贴缴纳比例是多少
  • 惠普2600打印机故障排除
  • 企业在弥补亏损和提取法定盈余公积前一般不得分配利润
  • 进项税一定是专票吗
  • kernel32在哪个文件夹
  • php注释的主要作用是什么?
  • 修建污水处理厂施工方案包括哪些内容
  • 寓意幸福和团圆的网名
  • cnpm安装成功为什么用不了
  • 论文implications
  • 哪些服务可以开具经纪代理服务发票
  • 个体工商户生产经营所得税税率表2023
  • 本年利润在借方代表亏损吗
  • 借款利息收入发票
  • 普通发票网络服务系统
  • 教育咨询公司能开培训费发票吗
  • php数据库网址
  • java 类型推导
  • 以权益结算的股份
  • 销售旧货的增值税是销项税吗
  • 长期股权投资投资损益的确认
  • 差旅费包括内容
  • 购进无偿赠送
  • 宣传费税前扣除什么意思
  • 预缴所得税弥补以前年度亏损
  • 房地产企业城建税和教育费附加怎么算
  • 外购商品用于促销能抵扣吗
  • 开出发票上有折扣的怎么入账?
  • 暂估成本估多了怎么办
  • 补计提上一年度工资
  • 营业成本包括哪些会计科目
  • MySQL-tpch 测试工具简要手册
  • linux系统配置命令
  • ghost安装器怎么用
  • windows10cortana搜索框
  • linux find命令查找文件名
  • window10虚拟系统
  • win8系统如何查看电脑内存
  • winxp家庭版和专业版的区别
  • win8 侧边栏
  • centos7 本地yum
  • 如何在windows制作表格
  • win7调整视觉效果
  • linux中病毒了怎么处理
  • javascript教程
  • javascript中的document.write
  • easyui下拉列表
  • 如何在eclipse
  • 复制文件到c盘需要管理员权限
  • linux启动过程流程图
  • unity2d序列帧
  • python读写文件wr
  • python写脚本教程
  • 电子税务局内蒙古自治区
  • 运满满订单取消技术服务费退还吗
  • 税务 涉税中介
  • 国家税务总局电话人工客服
  • 什么是重点群体
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设