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

  • 小米蓝牙音箱怎么连接(小米蓝牙音箱怎么用)

    小米蓝牙音箱怎么连接(小米蓝牙音箱怎么用)

  • 钉钉加入会议在哪里(钉钉加入会议在哪里打开)

    钉钉加入会议在哪里(钉钉加入会议在哪里打开)

  • iphone13防丢失怎么设置(苹果13防盗功能设置)

    iphone13防丢失怎么设置(苹果13防盗功能设置)

  • 拼多多极速退款要等卖家同意吗(拼多多极速退款在哪里设置的)

    拼多多极速退款要等卖家同意吗(拼多多极速退款在哪里设置的)

  • 淘宝可以同时登录几个手机

    淘宝可以同时登录几个手机

  • 华为对折屏手机(华为折垫屏手机)

    华为对折屏手机(华为折垫屏手机)

  • 淘宝延长收货时间可以选择吗(淘宝延长收货时间后可申请退款吗?)

    淘宝延长收货时间可以选择吗(淘宝延长收货时间后可申请退款吗?)

  • 小米8恢复出厂设置在哪里(小米8恢复出厂设置会怎么样)

    小米8恢复出厂设置在哪里(小米8恢复出厂设置会怎么样)

  • 抖音头像设置一个绿点啥意思(抖音头像设置一直闪退)

    抖音头像设置一个绿点啥意思(抖音头像设置一直闪退)

  • 3000mbps是多少兆(3000mbps是多少兆宽带)

    3000mbps是多少兆(3000mbps是多少兆宽带)

  • 光影精灵4续航几小时(光影精灵续航怎么样)

    光影精灵4续航几小时(光影精灵续航怎么样)

  • iphone的gps开关在哪里(苹果 gps开关)

    iphone的gps开关在哪里(苹果 gps开关)

  • it行业是什么(it行业指什么)

    it行业是什么(it行业指什么)

  • 华为备忘录如何设置时间(华为备忘录如何导出)

    华为备忘录如何设置时间(华为备忘录如何导出)

  • 手机wps表格怎么画表(手机wps表格怎么调整表格大小)

    手机wps表格怎么画表(手机wps表格怎么调整表格大小)

  • 辅存储器有哪些(辅助存储器有)

    辅存储器有哪些(辅助存储器有)

  • morris蠕虫病毒是利用什么(morris蠕虫病毒是利用缓冲区溢出漏洞)

    morris蠕虫病毒是利用什么(morris蠕虫病毒是利用缓冲区溢出漏洞)

  • 手机桌面天气怎么恢复(手机桌面天气怎样添加城市)

    手机桌面天气怎么恢复(手机桌面天气怎样添加城市)

  • 小米9发热严重吗(小米9发热严重怎么回事)

    小米9发热严重吗(小米9发热严重怎么回事)

  • 删了的照片怎么找回来(删了的照片怎么回来)

    删了的照片怎么找回来(删了的照片怎么回来)

  • 华为nova5和nova5pro那个更值得入手(华为nova5和nova5pro手机膜一样吗)

    华为nova5和nova5pro那个更值得入手(华为nova5和nova5pro手机膜一样吗)

  • 如何清除c盘无用文件(怎么清除c盘无用文件)

    如何清除c盘无用文件(怎么清除c盘无用文件)

  • mac怎么卸载软件 mac系统卸载程序方法图解(mac怎么卸载软件core sync)

    mac怎么卸载软件 mac系统卸载程序方法图解(mac怎么卸载软件core sync)

  • 路由器无线设置(路由器无线设置模式哪个更快)

    路由器无线设置(路由器无线设置模式哪个更快)

  • 个人所得税的纳税方式有哪几种
  • 没有购销合同的销售额交印花税吗
  • 物流辅助服务属于什么费用
  • 无票收入是否要交税
  • 残保金减免需要每月发放不低于本市最低工资标准是应发
  • 医院财政资金免企业所得税吗
  • 网络文化传媒公司名字
  • 印花税是不是必须要交
  • 在建投资性物业管理办法
  • 政府补助计入资本公积是老准则吗
  • 压覆矿产赔偿标准法律依据
  • 如何计算企业当年利润
  • 工资薪金税前扣除比例
  • 纳税调整额怎么算出来的
  • 吸收合并税费
  • 既加工又有安装费的公司
  • 基建项目税率
  • 生产企业先出库后入库
  • mac big sur 新功能
  • 网络限速数值
  • linux和windows关系
  • 缴纳的权利许可有哪些
  • window11如何打开任务管理器
  • 网速变慢的原因有哪些
  • 公司的贷款过桥怎么办
  • php5.4+mysql
  • 支付公司保洁费未开发票
  • 苹果多屏协同win10
  • html怎么做
  • imagestring php
  • 社保缴费基数如何调整
  • 增值税检查的内容
  • ai生成图形
  • php面向对象优点,缺点
  • php安装oci8
  • 认缴制情况下 公司一定要出资到位再注销吗
  • 小规模纳税人当月应交增值税怎么算
  • 以前年度损益调整是什么意思
  • 帝国cms教程官方完整版
  • 政府补助增值税即征即退
  • 短期借款会计分录例题及答案
  • 增值税专用发票和普通发票的区别
  • 五种差异化收费方式
  • 单位销售收入不包括哪些
  • 应交税费年末需要结转吗
  • 母子公司往来款属于借款吗
  • 计提个人经营所得税怎么算
  • 百旺开发票清单
  • 考核员工的罚款计入什么
  • 无形资产及其他资产包括哪些科目
  • 税控盘被锁死
  • 出口退税的会计处理
  • 如何给初建单位发邮件
  • 探讨探讨
  • sqlserver全文索引
  • ubuntu 16.04
  • centos 管理员
  • ibm笔记本开机进不去系统
  • xp系统怎么把ie浏览器放到桌面
  • centos7权限
  • Linux系统下的Samba客户端配置
  • 笔记本win7电源已接通未充电怎么办
  • nodejs使用场景
  • angularjs4
  • python爬虫框架 path
  • jquery$符号
  • w10cmd命令高级命令
  • javascript开发app教程
  • 创业要看的书
  • python数据清洗的方法有哪些
  • 注释讲解
  • centos6.9查看网卡状态
  • js动态执行代码
  • JavaScript为事件句柄绑定监听函数实例详解
  • 那些so 叼的android studio 插件
  • 云南省地方税务局关于城镇土地使用税
  • 山西税务12366
  • 税务非正常户要提交什么资料
  • 怎么注册山东省采购网
  • 煤炭限产是利好还是利空
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设