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

  • 手机连不上wifi是怎么回事(手机连不上wifi是怎么回事)(手机连不上wifi是怎么回事无ip分配)

    手机连不上wifi是怎么回事(手机连不上wifi是怎么回事)(手机连不上wifi是怎么回事无ip分配)

  • 微信与苹果4s不兼容怎么办(iphone4微信用不了)

    微信与苹果4s不兼容怎么办(iphone4微信用不了)

  • 拼多多物流订阅是什么意思(拼多多物流订阅提醒收费不)

    拼多多物流订阅是什么意思(拼多多物流订阅提醒收费不)

  • 傲腾是什么(傲腾是什么协议)

    傲腾是什么(傲腾是什么协议)

  • 电脑微信怎么静音(电脑微信静音怎么设置)

    电脑微信怎么静音(电脑微信静音怎么设置)

  • 苹果新电池掉电很快(苹果新电池掉电快怎么办)

    苹果新电池掉电很快(苹果新电池掉电快怎么办)

  • iphone7保修期一般多久(苹果7保修期)

    iphone7保修期一般多久(苹果7保修期)

  • 荣耀20要不要升级新版本

    荣耀20要不要升级新版本

  • 荣耀v30pro有指纹解锁吗(荣耀v30pro有指纹识别吗)

    荣耀v30pro有指纹解锁吗(荣耀v30pro有指纹识别吗)

  • qq音乐里q币怎么换乐比(qq音乐里q币怎么兑换)

    qq音乐里q币怎么换乐比(qq音乐里q币怎么兑换)

  • 高德地图手机怎么弄横屏(高德地图手机怎么看经纬度)

    高德地图手机怎么弄横屏(高德地图手机怎么看经纬度)

  • 华为mate10铃声设置(mate10手机铃声在哪个文件夹里面)

    华为mate10铃声设置(mate10手机铃声在哪个文件夹里面)

  • 华为mate30pro几个扬声器(华为mate30pro几个前置摄像头)

    华为mate30pro几个扬声器(华为mate30pro几个前置摄像头)

  • 企业微信怎么加入企业(企业微信怎么加入微信群聊)

    企业微信怎么加入企业(企业微信怎么加入微信群聊)

  • 苹果无线耳机快捷键(苹果无线耳机快捷手势)

    苹果无线耳机快捷键(苹果无线耳机快捷手势)

  • 微信验证消息回复几次(微信验证消息回复最多可以发几条)

    微信验证消息回复几次(微信验证消息回复最多可以发几条)

  • 连尚头条怎么屏蔽(手机屏幕连尚头条怎么关掉)

    连尚头条怎么屏蔽(手机屏幕连尚头条怎么关掉)

  • ipadair3上市时间中国(ipadair5)

    ipadair3上市时间中国(ipadair5)

  • airpods1和2盒子一样吗(airpods盒子一代和二代区别外观)

    airpods1和2盒子一样吗(airpods盒子一代和二代区别外观)

  • 照片怎么传到另一个手机(照片怎么传到另一个手机号里)

    照片怎么传到另一个手机(照片怎么传到另一个手机号里)

  • 小米闹钟怎么连接wifi(小米闹钟怎么连接手机热点)

    小米闹钟怎么连接wifi(小米闹钟怎么连接手机热点)

  • 十大常见的内存BIOS故障现象及解决方案(常见内存大小)

    十大常见的内存BIOS故障现象及解决方案(常见内存大小)

  • “精灵烟囟”和窑洞,土耳其卡帕多西亚 (© Ivan Kmit/Alamy)(精灵烟囱的形态判断)

    “精灵烟囟”和窑洞,土耳其卡帕多西亚 (© Ivan Kmit/Alamy)(精灵烟囱的形态判断)

  • python中series如何转为list?(python的series)

    python中series如何转为list?(python的series)

  • 小微企业所得税优惠政策最新2022
  • 缴纳个人所得税怎么算
  • 最新个人所得税扣除标准表
  • 子公司之间资产划拨会计处理
  • 一般纳税人月销售额多少免征增值税
  • 煤炭企业会计核算办法
  • 税收抵免与税收的区别
  • 库存商品采用定价法
  • 公交车收购
  • 购买商标权税率多少
  • 居民企业只就其境内全部所得纳税
  • 公司取出的备用金怎么打税
  • 个人独资所得税税率表最新
  • 营改增以后小规模纳税人如何纳税
  • 旅游业适用差额征税政策时如何开具发票?
  • 二手房产增值税率
  • 记账错误是什么意思
  • 个人向公司借贷需要交税吗
  • 如何按增值税计税
  • 资本公积弥补亏损规定
  • w11系统有哪些新功能
  • 建筑公司购买材料需要写备注
  • 怎么修改以前年度的账
  • 在境外缴纳的增值税税率
  • 华为手机悬浮导航是干什么用
  • linux dism
  • 销售不动产应交的增值税计入
  • pc direct
  • 公司社保钱可以套出来吗
  • phpforeach遍历二维数组
  • 企业发生的诉讼费用
  • 如果企业亏损要交企业所得税吗
  • 应纳税所得额准予扣除的有
  • 个人房屋出租税票怎么开
  • php特性包括
  • js读取本地excel
  • JavaScript DOM API的使用
  • 委托代销商品委托方和受托方会计分录
  • Editorial Calendar为你的WordPress添加编辑日历 让文章定时发布更简单
  • 汽车销售税额
  • 发票没有填写开户行,可以报销吗
  • 法人如何提取公积金余额
  • python如何访问私有方法
  • 劳务成本 科目
  • 美金账户余额截图
  • 担保公司的风险准备金在报表中如何反应
  • 增值税抵扣环节
  • 个人对企业的例子
  • 企业主营业务收入科目下的余额应转入的科目是
  • 当月没生产有生产费用怎么结转
  • 养老保险和工伤失业保险不在一个时间
  • 预提成本和冲回成本金额不一致情况说明
  • 预付工程款会计分录
  • 购进生产免税货物用材料可以抵扣进项税额吗
  • 小规模纳税人减按1%账务处理
  • 出口退税申报分录怎么写
  • 交增值税会计凭证怎么做
  • 劳务公司 成本
  • 预计销售收入增长率怎么算
  • 多计提的税款会计处理
  • 未分配利润太大了怎么处理
  • pe工具箱怎么用
  • ubuntu 编译软件
  • win7系统关闭开机启动项设置
  • centos7打开命令行
  • 常用的linux操作
  • win7系统屏幕保护设置禁用如何开启
  • unity画面效果润色
  • 批处理调用ftp
  • jquery处理json格式数据
  • shell忽略大小写
  • 地铁酷跑瞬间移动
  • python常用的内置逻辑判断函数
  • jquery图片轮播代码
  • 国家税务总局关于个人所得税有关政策问题的通知
  • 增值税纳税申报表附列资料(三)
  • 税务局营改增文件
  • 营改增后土地增值税
  • 广东为什么用粤做简称?
  • 智能财税代理实务实训过程
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设