axios的响应拦截器 - 错误统一处理 / 获取数据繁琐

1. 问题

  • 登录时,填写错误的用户名密码,没有错误提示(没有进入catch分支)
  • 获取ajax的返回结果比较麻烦:res.data.data.xxxx

2.解决登录失败不报错的问题

2.1 分析原因

首先 axios 内部的报错机制:

  • 如果本次请求得到的响应的状态码 不是 2 开头的(如:400,500),就会主动抛出错误。
  • 如果本次请求出现网络错误,就会主动抛出错误

但当用户用户名和密码输入错误时,本次请求的状态码是正常的(虽然 success 字段是false),也没有网络错误,所以axios并不会报错

2.2 解决思路

在响应拦截器中,根据本次请求返回的数据中的 success 字段值,来决定是否主动抛出错误。

这个错误处理,是和后端进行了约定

// 响应拦截器
service.interceptors.response.use(response => {
  if (response.data.success) {
    // 数据正常,进行的逻辑功能
    return response
  } else {
    // 如果返回的 success 是 false,表明业务出错,直接触发 reject
    // 抛出的错误,被 catch 捕获
    return Promise.reject(new Error(response.data.message))
  }
}, error => {
  // 对响应错误做点什么
  return Promise.reject(error)
})

3. 解决获取有效数据代码冗余的问题

3.1 问题说明

观察api的返回结果,我们发现axios在处理接口返回值时,默认会自动给包裹一个data字段,这导致我们每次在业务模块获取数据都需要写res.data.data.xxxx,这样太麻烦了。

3.2 解决思路

在返回有效数据时,直接返回res.data

// 响应拦截器
service.interceptors.response.use(response => {
  if (response.data.success) {
    // 数据正常,进行的逻辑功能
+   return response.data
  } else {
    // 如果返回的 success 是 false,表明业务出错,直接触发 reject
    // 抛出的错误,被 catch 捕获
    return Promise.reject(new Error(response.data.message))
  }
}, error => {
  // 对响应错误做点什么
  return Promise.reject(error)
})

4. 错误统一处理

4.1 问题说明

如果每次发起请求后,都进行错误处理,会让代码也非常冗余

我们既然在响应拦截器中进行获取到了错误的状态码,这时候就可以进行错误的统一处理

import { Message } from 'element-ui'


// 响应拦截器
service.interceptors.response.use(response => {
  if (response.data.success) {
    // 数据正常,进行的逻辑功能
+    return response.data
  } else {
    // 如果返回的 success 是 false,表明业务出错,直接触发 reject
    // 抛出的错误,被 catch 捕获
    Message.error(response.data.message)
    return Promise.reject(new Error(response.data.message))
  }
}, error => {
  // 对响应错误做点什么
  Message.error(error.message)
  return Promise.reject(error)
})

5. 再次简化代码

service.interceptors.response.use(
  response => {
    if (response.data.success) {
      // response.data 是解决数据的获取繁琐问题
      return response.data
    } else {
+      Message({
+        message: response.data.message,
+        type: 'error'
      })
      // 如果返回的状态失败,需要抛出错误的信息
      return Promise.reject(new Error(response.data.message))
    }
  },
  error => {
    Message({
      message: error.message,
      type: 'error',
      duration: 5 * 1000
    })
    return Promise.reject(error)
  }
)