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

  • 经营范围没广告怎么办
  • 增值税报税后多久缴纳期限
  • 所得税年报工资薪金支出怎么填
  • 个人部分社保怎么计算
  • 机票行程单能报销几次
  • 小规模纳税人超过500万可以不转一般纳税人吗
  • 增值税发票选择确认平台勾选注意事项
  • 长期挂账的应付账款怎么处理
  • 企业所得税季报时间
  • 股权转让评估费可以有公司承担吗
  • 折扣折让 红字发票账务处理
  • 代扣个税手续费返还怎么申请
  • 计提房屋租赁费
  • 生产型企业增值税率是多少
  • 专票和普票的税率哪个高
  • 只转让地上的建筑怎么办
  • 临时业务开票
  • sd标准差是什么意思
  • 计提法定盈余公积转入利润分配
  • 公司委托公司收款合法吗
  • 成品油电子普通发票开错了
  • 技术转让减免所得额
  • 收到带息商业票据贴现会计处理
  • 来料加工的账务处理
  • 年初未分配利润是什么科目
  • 新政府会计制度科目表
  • 代开的发票没有人名行不行?
  • php字符串变量
  • php string
  • php字符串型数据的定义方式
  • 开发票时,一张发票上不同税率要符合哪些要求?
  • 土地增值税安置房收入的确认原则
  • .sfx.exe是什么文件
  • 纳税人解除劳动合同证明
  • 研发机构采购国产设备退税管理办法
  • 存货跌价后销售会计分录
  • 双色球python算法
  • 生产成本结转后有余额吗
  • cityscape dataset
  • swift 协议扩展
  • 外贸企业申报出口退税资料
  • 应收账款账龄如何填写
  • 劳务公司可以
  • 购买茶叶怎么入账
  • mongodb聚合函数详解
  • 农业用肥尽量不选择
  • 承兑汇票可以当现金用吗
  • 信用减值损失在贷方表示什么
  • 工程结转成本分录
  • 发行股票时支付的手续费
  • 税控盘开具增值税专用发票步骤
  • 主播工资不发应该到哪里投诉
  • 计提印花税会计分录怎么写
  • 资产负债表税务局能看到吗
  • 税控服务费怎么记账
  • 每月摊销的金额怎么算
  • SQLServer 通用的分区增加和删除的算法
  • solaris ssh offline
  • xp系统浏览器收藏夹文件位置
  • windowsserver2008r2忘记开机密码怎么办
  • solaris 修改用户 主目录
  • Win10自带输入法打不出中文
  • centos6.6网卡配置
  • winxp远程桌面
  • oracle数据库网络配置工具
  • Win10 TH2正式版偷偷恢复/篡改成对应的预装应用
  • window10 系统安装
  • linux ls命令什么意思
  • 常见错误类型
  • excel 工具栏
  • setcontentview报错
  • 使用文字输入
  • 发送邮件python
  • javascript运用
  • unity3d2019教程
  • 狗刨好学吗
  • 个人所得税完税证明
  • 个体逾期未申报一天会怎么样
  • 9月份公积金什么时候扣
  • 杭州国税电话
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设