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

  • 小米手机移入私密空间的文件怎么查看(小米手机移入私密空间)

    小米手机移入私密空间的文件怎么查看(小米手机移入私密空间)

  • Word字体加黑怎么设置(word字体怎么加黑)

    Word字体加黑怎么设置(word字体怎么加黑)

  • word分节符在哪里找(word分节符在哪里删除)

    word分节符在哪里找(word分节符在哪里删除)

  • 荣耀9i外屏和内屏是一体的吗(华为荣耀9屏幕是内外一体的吗?)

    荣耀9i外屏和内屏是一体的吗(华为荣耀9屏幕是内外一体的吗?)

  • 蓝牙耳机听歌能听多久(蓝牙耳机听歌能听见生音,为啥接电话听不见生音)

    蓝牙耳机听歌能听多久(蓝牙耳机听歌能听见生音,为啥接电话听不见生音)

  • 快手直播a类永久封播可以解决吗(快手直播a类b类c类什么意思)

    快手直播a类永久封播可以解决吗(快手直播a类b类c类什么意思)

  • 8p怎么截屏的(8p怎么样截图)

    8p怎么截屏的(8p怎么样截图)

  • 手机输入法字体怎么改(手机输入法字体怎么设置大小)

    手机输入法字体怎么改(手机输入法字体怎么设置大小)

  • oppor9s带不带nfc功能(oppor9s带不带红外线功能)

    oppor9s带不带nfc功能(oppor9s带不带红外线功能)

  • 电话被拉黑会听到什么(电话被拉黑了还能听到电话留言吗)

    电话被拉黑会听到什么(电话被拉黑了还能听到电话留言吗)

  • qq加不了好友只能关注(为什么qq加不了好友只能别人加我)

    qq加不了好友只能关注(为什么qq加不了好友只能别人加我)

  • 华为手机密码保存箱在哪里(华为手机密码保险箱在哪里)

    华为手机密码保存箱在哪里(华为手机密码保险箱在哪里)

  • 怎样上传qq群文件而没有提醒(怎样上传qq群文件夹)

    怎样上传qq群文件而没有提醒(怎样上传qq群文件夹)

  • 小米手机耗电快的原因(小米手机耗电快怎么恢复正常)

    小米手机耗电快的原因(小米手机耗电快怎么恢复正常)

  • ipadmini5能打电话吗(ipad mini6 可以打电话)

    ipadmini5能打电话吗(ipad mini6 可以打电话)

  • OPPO k5怎么打开高性能模式(oppok5怎么打开高清通话)

    OPPO k5怎么打开高性能模式(oppok5怎么打开高清通话)

  • 小米双4g是什么意思(小米双4g开关在哪里)

    小米双4g是什么意思(小米双4g开关在哪里)

  • 170怎么充话费(170的手机号怎么充话费)

    170怎么充话费(170的手机号怎么充话费)

  • iphonexr支持2a充电吗(iphonexr可以用5v2a的充电器吗)

    iphonexr支持2a充电吗(iphonexr可以用5v2a的充电器吗)

  • iphone电话拉黑了是什么反应(iPhone电话拉黑了还能打进来)

    iphone电话拉黑了是什么反应(iPhone电话拉黑了还能打进来)

  • ios 13正式版什么时候推送(ios13正式版什么时候发布的)

    ios 13正式版什么时候推送(ios13正式版什么时候发布的)

  • 沈阳5g开通时间(沈阳5g什么时候全城覆盖)

    沈阳5g开通时间(沈阳5g什么时候全城覆盖)

  • 华为nova 3可以人脸支付吗(华为nova3e支持人脸识别吗)

    华为nova 3可以人脸支付吗(华为nova3e支持人脸识别吗)

  • 前端直接生成GIF动态图实践(前端生成docx)

    前端直接生成GIF动态图实践(前端生成docx)

  • 开咨询费需要合同吗
  • 小规模差额申报怎么申报
  • 来料加工生产成本账务处理
  • 开发票产品名称
  • 一般纳税人工会经费返还政策
  • 一般纳税人必须先有进项才能开出来发票吗
  • 社保如何会计处理
  • 长期投资换入固定资产如何处理
  • 行政事业单位的会计核算可以采用权责发生制吗
  • 建筑挂靠企业账务处理
  • 稿酬收入怎么算
  • 复利现值系数完整版
  • 800多项进口关税减免
  • 冲销管理费用如何计算
  • 进项发票认证多了留抵
  • 事业单位预算外收入
  • 公司发的奖金可以直接公司账户转账给员工吗?
  • 广告服务印花税怎么交
  • 给员工的福利要缴税吗
  • 集团企业涉税需求网络
  • 企业牌照拍卖收入计入什么科目
  • 计提厂房租金怎么做账?
  • 委托加工物资的消费税
  • 金融企业同期同类贷款利率计算
  • 无法支付的其他账户
  • 买卖交什么税
  • 企业延期缴纳税款
  • 代购买东西流程
  • 预收账款科目
  • 监理多计量承担什么责任
  • 欠税,偷税后果严重吗
  • mac切换不了中文怎么回事
  • 腾讯电脑管家网址多少
  • 收到人才引进已受理的短信
  • 其他应收款贷方表示什么
  • win11系统怎么删除账户
  • win10点搜索
  • mac怎么删除应用程序中没有的软件
  • PHP:pg_field_type()的用法_PostgreSQL函数
  • PHP:imagettfbbox()的用法_GD库图像处理函数
  • 慕尼黑基姆湖
  • 增值税附加税必须交吗
  • 汽车维修费发票怎么开
  • 外购存货的成本包括哪些内容
  • 加工行业增值税负率一般控制在多少?
  • js回调函数如何返回值
  • 公司首次申报个人所得税
  • mysql的环境配置
  • 应付账款暂估款的账务处理
  • 小规模纳税人销售商品会计分录
  • 个人经营所得税怎么申报
  • 办理地税手续费
  • 车船税手续费返还时间
  • 预付款什么时候开发票
  • 个人取得全年一次性奖金征税规定
  • 暂估入库估多了,汇算清缴前调整
  • 民办非企业没有了吗
  • 个人独资企业交什么税
  • sql语句排除重复数据
  • mysql的json数据类型
  • xp系统鼠标设置在哪
  • linux 解析
  • windows的安装
  • kb5003169安装失败
  • SsAAD.exe - SsAAD是什么进程
  • win10应用商店更新软件更新不了
  • linux退出telnet服务
  • 2021年win10累积更新
  • xp升win10教程
  • jquery 插件写法
  • 阿里云云服务器ecs位于云端
  • Node.js中child_process实现多进程
  • shell自定义函数以及使用
  • python web网站
  • JavaScript Math.ceil 方法(对数值向上取整)
  • 电子发票查询系统手机查询
  • 山东省税务局在哪
  • 煤炭资源税税率表
  • 国税局和地税局分别征收什么税种
  • 税务转为非正常户的后果
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设