位置: 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)

  • 魅蓝note 3支持otg功能吗(魅蓝note 3)(魅蓝note3能插内存卡吗)

    魅蓝note 3支持otg功能吗(魅蓝note 3)(魅蓝note3能插内存卡吗)

  • 960显卡2g和4g的区别(960显卡2g和4g的区分)

    960显卡2g和4g的区别(960显卡2g和4g的区分)

  • 视频怎么命名(视频怎么命名发给别人)

    视频怎么命名(视频怎么命名发给别人)

  • 抖音转发那里怎么有好友头像(抖音里面的转发在哪里)

    抖音转发那里怎么有好友头像(抖音里面的转发在哪里)

  • 华为自创的系统叫什么(华为自创的系统有哪些)

    华为自创的系统叫什么(华为自创的系统有哪些)

  • 荣耀30pro支持无线充电吗(荣耀30pro支持无线反充吗)

    荣耀30pro支持无线充电吗(荣耀30pro支持无线反充吗)

  • k20pro什么时候更新miui12(k20pro2021)

    k20pro什么时候更新miui12(k20pro2021)

  • 苹果手机一些软件安装不了怎么办(苹果手机一些软件打开界面是灰色的)

    苹果手机一些软件安装不了怎么办(苹果手机一些软件打开界面是灰色的)

  • 华为p30pro前置摄像头像素(华为p30pro前置摄像头)

    华为p30pro前置摄像头像素(华为p30pro前置摄像头)

  • 快手点的小红心有什么用多少会上热门(快手点的小红心如何快速取消)

    快手点的小红心有什么用多少会上热门(快手点的小红心如何快速取消)

  • 来电语音提示在哪设置(来电语音提示在哪里)

    来电语音提示在哪设置(来电语音提示在哪里)

  • word图片被锁定(word图片锁定纵横比在哪里)

    word图片被锁定(word图片锁定纵横比在哪里)

  • 华为mate30pro支不支持5g(华为mate30pro支不支持内存卡)

    华为mate30pro支不支持5g(华为mate30pro支不支持内存卡)

  • 华为安全模式怎么解除(华为安全模式怎么解除限制)

    华为安全模式怎么解除(华为安全模式怎么解除限制)

  • 苹果7怎么关闭诊断用量(苹果7怎么关闭旁白模式)

    苹果7怎么关闭诊断用量(苹果7怎么关闭旁白模式)

  • word高级选项在哪里(word2007高级选项)

    word高级选项在哪里(word2007高级选项)

  • 华为mate30pro支持5g网络吗(华为mate30pro支持66w快充吗)

    华为mate30pro支持5g网络吗(华为mate30pro支持66w快充吗)

  • word乘号怎么打(word乘号怎么打出来在电脑上)

    word乘号怎么打(word乘号怎么打出来在电脑上)

  • 苹果xr的喇叭为什么左边的不响(苹果xr喇叭有吱吱的声音)

    苹果xr的喇叭为什么左边的不响(苹果xr喇叭有吱吱的声音)

  • 图虫怎么设置只有自己可以看(图虫主页怎么设置)

    图虫怎么设置只有自己可以看(图虫主页怎么设置)

  • 华为畅享9s的返回键在哪里(华为畅享9返回键在哪)

    华为畅享9s的返回键在哪里(华为畅享9返回键在哪)

  • 硬盘黑盘和蓝盘的区别(硬盘黑盘蓝盘绿盘的区别)

    硬盘黑盘和蓝盘的区别(硬盘黑盘蓝盘绿盘的区别)

  • 为什么微信定位不了位置(为什么微信定位找不到自己店铺位置)

    为什么微信定位不了位置(为什么微信定位找不到自己店铺位置)

  • SSDP Discovery Service 是什么可以禁用吗

    SSDP Discovery Service 是什么可以禁用吗

  • 系统之家u盘重装系统教程(系统之家u盘重装系统流程)

    系统之家u盘重装系统教程(系统之家u盘重装系统流程)

  • 个税应纳税所得额是要上交的钱吗
  • 建筑业收到预收款预缴增值税
  • 公司出租房营业税税率是多少
  • 企业经营的范围怎么写
  • 本年利润是净利润还是利润总额
  • 住宿费进项税分录
  • 小规模企业多交增值税
  • 政府扶持资金要还吗如村委借给企业对吗
  • 固定资产分配分录
  • 微信支付工资怎么做账
  • 个体生产经营所得税税率2023
  • 桂林军工企业单位有哪些
  • 小规模增值税纳税申报表
  • 一般纳税人差额征税怎么做账
  • 纳税人必须关注的10个涉税风险点
  • 销售退回冲减主营业务收入吗
  • 股东撤资退出
  • wind10激活密钥
  • 其他所得是什么意思
  • 借条复印件可以起诉吗还有转账记录
  • 临时工工资的会计处理
  • php封装composer包
  • 在win7系统中将打开窗口拖到屏幕顶端
  • windows11怎么显示我的电脑
  • 软件能否成为无线网
  • 买支票需要带什么章
  • 怎么核算购进商品
  • 管理费用怎么记凭证
  • 会计处理的正确顺序
  • php扫一扫识别代码
  • php -v
  • thinkPHP中_initialize方法实例分析
  • 开具负数发票的流程
  • opencv教程
  • 发票待开是什么意思?
  • css page-break-after
  • 企业印花税的申报
  • 帝国cms使用手册
  • mongodb bi
  • sqlserver创建临时表语句
  • 将织梦dedecms转换到wordpress
  • 分公司产生的费用怎么报销
  • 金蝶专业版如何打印凭证
  • 发票一式两联
  • 其他货币资金是什么科目
  • mysql 自动断开
  • 票种核定啥意思
  • 借款费用为什么可以企业所得税税前扣除
  • 预包装销售是什么意思
  • 金融企业里面的债务
  • 非公司人员差旅怎么报销
  • 合并报表非同控为什么调公允
  • 委托生产的会计分录
  • 库存商品对外销售会计分录
  • 垃圾清运费会计处理
  • 计提固定资产折旧怎么做会计科目
  • 应收票据的分录怎么做
  • 收到投资款如何做税务登记
  • 开出去的发票
  • 汇算清缴产生的企业所得税如何做账
  • 企业支付宝问题解决
  • mysql的函数
  • 配置是什么意思
  • windows中双击硬盘驱动器图标操作的作用
  • 如何删除windows media center
  • macos time machine
  • unity 读取xml文件
  • js创建类对象的方法
  • 用来检测程序小错误的测试方法
  • js中的常用方法
  • node中异步编程模式使用什么捕获异常
  • Python装饰器入门学习教程(九步学习)
  • javascript入门经典
  • js如何定义类
  • js继承的三种方法
  • 异地如何拨打12393
  • 江苏差旅费报销管理规定2021
  • 贸易公司税收政策
  • 山西税务官网登录
  • 电信电普
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设