axios拦截器封装:await遇上reject时catch的优雅处理方式

简介: 前端项目中使用 axios 请求接口,基于 axios 二次封装了一些业务逻辑,一般我们会在请求和响应拦截器里添加自己项目相关的业务逻辑

前端项目中使用 axios 请求接口,基于 axios 二次封装了一些业务逻辑,一般我们会在请求和响应拦截器里添加自己项目相关的业务逻辑,一个简单的 demo 如下:

import axios from 'axios'
import config from '@/config'
import cookies from 'vue-cookies'

axios.defaults.baseURL = config.apiBaseURL

// 请求拦截
axios.interceptors.request.use(
  config => {
   
    config.timeout = 600000
    let token = cookies.get('token')
    if (token) {
   
      config.headers.token = token
    }
    config.headers = Object.assign(config.headers, {
   
      'Content-Type': 'application/json'
    })
    return config
  },
  error => {
   
    return Promise.reject(error)
  }
)

// 响应拦截
axios.interceptors.response.use(
  function(response) {
   
    // 2xx 范围内的状态码都会触发该函数
    return response.data || {
   }
  },
  function(error) {
   
    // 超出 2xx 范围的状态码都会触发该函数
    return Promise.reject(error)
  }
)

export default axios

正常我们项目中使用是没问题的,比如在 vue 项目中使用:

<script>
export default {
  created() {
    this.getData()
  },

  methods: {
    async getData() {
      const res = await this.$axios({
        method: 'get',
        url: 'user'
      })
      if (res.success) {
        console.log('success')
      } else {
        console.log('error')
      }
    }
  }
}
</script>

但是有一天后端告诉你,我们框架在外层直接做了参数校验、登录校验...就是如果各种乱七八糟的校验不通过时,http状态码就不是我们正常见到的 200 哟,可能登录态 token 失效直接扔给前端一个 401。然后问后端可不可以改下,这种情况应该也是 200 才对,因为请求已经成功,然后具体的你们的校验逻辑可以放在里层数据的 code 里,前端也比较好处理。

后端说实现不了,这是框架做的,压根还没请求到具体的服务里,好吧,那只能自己动手丰衣足食了。

像这种非 2xx 的状态码,axios 的相应拦截器会直接走第 2 个 error,封装的是直接返回 Promise.reject(error),这样前端如果不去做任何处理的话,控制台会报错:Uncaught (in promise),也就是有一个异常未去捕捉。

要解决这个报错就需要前端在具体的调用地方用 catch 或者 try catch 去捕捉,如果是直接在 await 的后面 catch 捕捉,报错确实消失了,但是 await 的返回值 res 此时就是 undefined,此时 await 接收到的值就是 catch 里的返回值,如果没有 return 就是 undefined 了。

然后悲催地跟着后面如果有用 res 做判断,又会报错:TypeError: Cannot read properties of undefined...如果还不明白,可以看下面的小 demo:

async test() {
   
  const res = await new Promise((resolve, reject) => {
   
    setTimeout(() => {
   
      reject('fail')
    }, 3000)
  })
  // 报错:Uncaught (in promise)
  // 下面的代码不会执行
  console.log('res:', res)
  if (res.success) {
   
    console.log('success')
  }
},

async testCatch() {
   
  const res = await new Promise((resolve, reject) => {
   
    setTimeout(() => {
   
      reject('fail')
    }, 3000)
  }).catch(error => console.log(error))

  console.log('res:', res) // undefined
  if (res.success) {
    // 报错:TypeError: Cannot read properties of undefined
    console.log('success')
  }
},

最终实现方式

页面里用 try catch 或者自己多加几个判断,确实能解决报错,但是好像也不太优雅,目前找到的比较好的方式,如果能够拿到 error 里的一些报错信息,自己模拟组装一份数据,直接 return 给前端,这样既不用额外 catch,也解决了后续的报错问题:

import axios from 'axios'
import config from '@/config'
import cookies from 'vue-cookies'

axios.defaults.baseURL = config.apiBaseURL

// 请求拦截
axios.interceptors.request.use(
  config => {
   
    config.timeout = 600000
    let token = cookies.get('token')
    if (token) {
   
      config.headers.token = token
    }
    config.headers = Object.assign(config.headers, {
   
      'Content-Type': 'application/json'
    })
    return config
  },
  error => {
   
    loadingInstance && loadingInstance.close()
    if (error.response && error.response.status == 401) {
   
      window.location.href = '/login'
    }
    return Promise.reject(error)
  }
)

// 响应拦截
axios.interceptors.response.use(
  function(response) {
   
    // 2xx 范围内的状态码都会触发该函数
    return response.data || {
   }
  },
  function(error) {
   
    // 超出 2xx 范围的状态码都会触发该函数
    let errMsg
    const response = error.response
    if (response) {
   
      onst data = response.data || {
   }
      const dataMsg = data.message || data.msg
      const statusText = response.statusText
      errMsg = dataMsg || statusText || '出错了'
    } else if (error.message) {
   
      errMsg = error.message
    }

    // 有错误信息时自己模拟一份错误数据返回,解决后端动不动就直接 http 状态码 500、401...
    // 直接 reject 的话外层需要自己 catch,还需要额外判断 await 的返回值
    if (errMsg) {
   
      return {
   
        message: errMsg,
        success: false,
      }
    }
    return Promise.reject(error)
  }
)

export default axios
目录
相关文章
|
2月前
|
资源调度 JavaScript 前端开发
vue-element-admin 综合开发四:axios安装和封装、mock安装/学习/使用
这篇文章是关于如何在Vue项目中使用axios进行网络请求、二次封装axios以及使用mockjs模拟响应数据的教程。
96 1
vue-element-admin 综合开发四:axios安装和封装、mock安装/学习/使用
|
3月前
封装axios的get、post方法
本文介绍了如何封装axios的get和post方法,并展示了具体的代码实现,包括使用axios创建实例、设置请求拦截器以及定义get和post函数。
136 2
|
2月前
|
缓存 JavaScript 搜索推荐
|
2月前
|
前端开发 JavaScript 安全
在vue前端开发中基于refreshToken和axios拦截器实现token的无感刷新
在vue前端开发中基于refreshToken和axios拦截器实现token的无感刷新
156 4
|
2月前
vue3 + Ts 中 使用 class 封装 axios
【10月更文挑战第8天】
159 1
|
2月前
vue3 + Ts 中 使用 class 封装 axios
【10月更文挑战第5天】
189 1
|
2月前
|
前端开发 JavaScript API
自己动手封装axios通用方法并上传至私有npm仓库:详细步骤与实现指南
自己动手封装axios通用方法并上传至私有npm仓库:详细步骤与实现指南
118 0
|
2月前
|
JavaScript API 开发工具
vue尚品汇商城项目-day02【11.对axios二次封装+12.接口统一管理】
vue尚品汇商城项目-day02【11.对axios二次封装+12.接口统一管理】
36 0
|
4月前
|
JSON JavaScript 前端开发
【Vue面试题二十四】、Vue项目中有封装过axios吗?主要是封装哪方面的?
这篇文章讨论了在Vue项目中封装axios的最佳实践,包括设置接口请求前缀、请求头、状态码、请求方法的封装,以及如何使用请求和响应拦截器来处理token和响应状态,从而简化HTTP请求的配置和错误处理,提高代码的可维护性。
【Vue面试题二十四】、Vue项目中有封装过axios吗?主要是封装哪方面的?
|
5月前
|
存储 开发框架 前端开发
基于SqlSugar的开发框架循序渐进介绍(10)-- 利用axios组件的封装,实现对后端API数据的访问和基类的统一封装处理
基于SqlSugar的开发框架循序渐进介绍(10)-- 利用axios组件的封装,实现对后端API数据的访问和基类的统一封装处理