How to Use Axios Interceptors to Handle API Error Responses

how to use axios interceptors to handle api error responses

构建现代 web 应用程序时,处理 api 调用及其响应是开发的关键部分。 axios 是一个流行的 javascript 库,它简化了 http 请求的过程,但它还具有诸如拦截器之类的内置功能,允许开发人员以更简化、更高效的方式管理响应和错误。

在本文中,我们将重点介绍如何使用 axios 拦截器有效地处理 api 错误响应,从而使您能够在整个应用程序中标准化错误处理。

什么是 axios?

axios 是一个基于 promise 的 javascript http 客户端,支持使用 async/await 语法向 api 发出请求。它很受欢迎,因为它使用简单,并且可以通过拦截器轻松扩展其功能。

axios 基础示例:

import axios from 'axios';axios.get('/api/data')  .then(response => {    console.log(response.data);  })  .catch(error => {    console.error('error fetching data:', error);  });

虽然此示例演示了如何使用 .then 和 .catch 处理请求和错误,但当您需要管理多个 api 请求时,使用拦截器可以使您的代码更加高效。

什么是 axios 拦截器?

axios 拦截器 是允许您在 .then 或 .catch 处理请求和响应之前拦截和处理请求和响应的函数。当您需要将通用配置应用于所有请求或以统一的方式处理错误响应时,这特别有用。

拦截器主要有两种类型:

请求拦截器:用于在发送请求之前修改或添加请求头、令牌或其他配置。响应拦截器:用于全局处理响应或错误,包括在必要时记录或重试请求。

为什么使用响应拦截器?

处理多个 api 端点时,每个端点可能返回不同类型的错误消息或状态代码。如果没有拦截器,您将需要处理每个单独的 api 调用的错误,这可能会导致重复且难以维护的代码。

使用响应拦截器,您可以在一个位置管理所有错误响应,确保在整个应用程序中采用一致的方法处理错误。

设置 axios 响应拦截器

1.安装axios

首先,确保您的项目中安装了 axios:

npm install axios

2.创建axios实例

要设置拦截器,最好创建一个可以在整个应用程序中重用的 axios 实例。这有助于标准化您的请求和响应处理。

import axios from 'axios';const apiclient = axios.create({  baseurl: 'https://api.example.com',  // replace with your api base url  headers: {    'content-type': 'application/json',    accept: 'application/json',  },});

3.添加响应拦截器

您可以添加响应拦截器,以在错误到达各个 api 调用中的 .then 或 .catch 块之前捕获并处理错误。

apiclient.interceptors.response.use(  (response) => {    // if the response is successful (status code 2xx), return the response data    return response;  },  (error) => {    // handle errors globally    if (error.response) {      // server responded with a status code out of 2xx range      const statuscode = error.response.status;      const errormessage = error.response.data.message || 'an error occurred';      // handle different status codes accordingly      if (statuscode === 401) {        // handle unauthorized error, for example by redirecting to login        console.error('unauthorized access - redirecting to login');      } else if (statuscode === 500) {        // handle server errors        console.error('server error - try again later');      } else {        // handle other types of errors        console.error(`error ${statuscode}: ${errormessage}`);      }    } else if (error.request) {      // no response received (network error, timeout, etc.)      console.error('network error - check your internet connection');    } else {      // something else happened during the request      console.error('request error:', error.message);    }    // optionally, return a rejected promise to ensure `.catch` is triggered in individual requests    return promise.reject(error);  });

4. 调用api

拦截器就位后,您现在可以使用 apiclient 进行 api 调用。如果发生错误,拦截器会自动捕获并处理。

// example api callapiclient.get('/users')  .then(response => {    console.log('user data:', response.data);  })  .catch(error => {    // this will be triggered if the error isn't handled by the interceptor    console.error('error fetching users:', error);  });

在此设置中,您无需为每个 api 调用编写错误处理代码。拦截器集中了这个逻辑,让你的 api 调用更干净、更容易维护。

axios 拦截器的实际用例

1. 自动令牌刷新

如果您的api使用身份验证令牌(例如jwt),您可能会遇到令牌过期的情况,需要刷新它。 axios 拦截器可用于在收到 401 unauthorized 响应时自动刷新令牌。

apiclient.interceptors.response.use(  (response) => {    return response;  },  async (error) => {    if (error.response.status === 401) {      try {        // call a function to refresh the token        const newtoken = await refreshauthtoken();        error.config.headers['authorization'] = `bearer ${newtoken}`;        // retry the original request with the new token        return axios(error.config);      } catch (refresherror) {        console.error('token refresh failed:', refresherror);        // optionally redirect to login        return promise.reject(refresherror);      }    }    return promise.reject(error);  });

2. 处理网络错误

如果您的应用依赖外部 api,网络问题可能是一个常见问题。 axios 拦截器可以在网络故障时帮助提供用户友好的错误消息。

apiClient.interceptors.response.use(  (response) => response,  (error) => {    if (!error.response) {      alert('Network error: Please check your internet connection');    }    return Promise.reject(error);  });

使用 axios 拦截器的好处

集中式错误处理:您无需为每个 api 调用编写错误处理代码,而是可以在单个位置处理错误。

更干净的代码:由于错误处理由拦截器负责,因此您的各个 api 调用将更加干净和简洁。

改进的可维护性:可以在一个地方完成错误处理的更改(例如添加新案例或细化错误消息),使代码库更易于维护。

一致性:拦截器确保采用一致的方法来处理错误,因此您不必担心丢失边缘情况或编写冗余代码。

结论

使用 axios 拦截器处理 api 错误响应可以极大地提高代码的结构、可维护性和一致性。通过集中错误处理逻辑,您可以提高 api 调用效率并减少应用程序中的重复代码。

拦截器是 axios 的一项强大功能,可用于广泛的用例,从管理令牌刷新到在网络故障期间显示用户友好的错误消息。立即开始利用 axios 拦截器来简化错误处理并提高应用程序的弹性!

以上就是How to Use Axios Interceptors to Handle API Error Responses的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1498379.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月19日 20:25:10
下一篇 2025年12月19日 20:25:17

相关推荐

  • CSS mask属性无法获取图片:为什么我的图片不见了?

    CSS mask属性无法获取图片 在使用CSS mask属性时,可能会遇到无法获取指定照片的情况。这个问题通常表现为: 网络面板中没有请求图片:尽管CSS代码中指定了图片地址,但网络面板中却找不到图片的请求记录。 问题原因: 此问题的可能原因是浏览器的兼容性问题。某些较旧版本的浏览器可能不支持CSS…

    2025年12月24日
    900
  • Uniapp 中如何不拉伸不裁剪地展示图片?

    灵活展示图片:如何不拉伸不裁剪 在界面设计中,常常需要以原尺寸展示用户上传的图片。本文将介绍一种在 uniapp 框架中实现该功能的简单方法。 对于不同尺寸的图片,可以采用以下处理方式: 极端宽高比:撑满屏幕宽度或高度,再等比缩放居中。非极端宽高比:居中显示,若能撑满则撑满。 然而,如果需要不拉伸不…

    2025年12月24日
    400
  • 如何让小说网站控制台显示乱码,同时网页内容正常显示?

    如何在不影响用户界面的情况下实现控制台乱码? 当在小说网站上下载小说时,大家可能会遇到一个问题:网站上的文本在网页内正常显示,但是在控制台中却是乱码。如何实现此类操作,从而在不影响用户界面(UI)的情况下保持控制台乱码呢? 答案在于使用自定义字体。网站可以通过在服务器端配置自定义字体,并通过在客户端…

    2025年12月24日
    800
  • 如何在地图上轻松创建气泡信息框?

    地图上气泡信息框的巧妙生成 地图上气泡信息框是一种常用的交互功能,它简便易用,能够为用户提供额外信息。本文将探讨如何借助地图库的功能轻松创建这一功能。 利用地图库的原生功能 大多数地图库,如高德地图,都提供了现成的信息窗体和右键菜单功能。这些功能可以通过以下途径实现: 高德地图 JS API 参考文…

    2025年12月24日
    400
  • 如何使用 scroll-behavior 属性实现元素scrollLeft变化时的平滑动画?

    如何实现元素scrollleft变化时的平滑动画效果? 在许多网页应用中,滚动容器的水平滚动条(scrollleft)需要频繁使用。为了让滚动动作更加自然,你希望给scrollleft的变化添加动画效果。 解决方案:scroll-behavior 属性 要实现scrollleft变化时的平滑动画效果…

    2025年12月24日
    000
  • 如何为滚动元素添加平滑过渡,使滚动条滑动时更自然流畅?

    给滚动元素平滑过渡 如何在滚动条属性(scrollleft)发生改变时为元素添加平滑的过渡效果? 解决方案:scroll-behavior 属性 为滚动容器设置 scroll-behavior 属性可以实现平滑滚动。 html 代码: click the button to slide right!…

    2025年12月24日
    500
  • 为什么设置 `overflow: hidden` 会导致 `inline-block` 元素错位?

    overflow 导致 inline-block 元素错位解析 当多个 inline-block 元素并列排列时,可能会出现错位显示的问题。这通常是由于其中一个元素设置了 overflow 属性引起的。 问题现象 在不设置 overflow 属性时,元素按预期显示在同一水平线上: 不设置 overf…

    2025年12月24日 好文分享
    400
  • 网页使用本地字体:为什么 CSS 代码中明明指定了“荆南麦圆体”,页面却仍然显示“微软雅黑”?

    网页中使用本地字体 本文将解答如何将本地安装字体应用到网页中,避免使用 src 属性直接引入字体文件。 问题: 想要在网页上使用已安装的“荆南麦圆体”字体,但 css 代码中将其置于第一位的“font-family”属性,页面仍显示“微软雅黑”字体。 立即学习“前端免费学习笔记(深入)”; 答案: …

    2025年12月24日
    000
  • 如何选择元素个数不固定的指定类名子元素?

    灵活选择元素个数不固定的指定类名子元素 在网页布局中,有时需要选择特定类名的子元素,但这些元素的数量并不固定。例如,下面这段 html 代码中,activebar 和 item 元素的数量均不固定: *n *n 如果需要选择第一个 item元素,可以使用 css 选择器 :nth-child()。该…

    2025年12月24日
    200
  • 使用 SVG 如何实现自定义宽度、间距和半径的虚线边框?

    使用 svg 实现自定义虚线边框 如何实现一个具有自定义宽度、间距和半径的虚线边框是一个常见的前端开发问题。传统的解决方案通常涉及使用 border-image 引入切片图片,但是这种方法存在引入外部资源、性能低下的缺点。 为了避免上述问题,可以使用 svg(可缩放矢量图形)来创建纯代码实现。一种方…

    2025年12月24日
    100
  • 如何让“元素跟随文本高度,而不是撑高父容器?

    如何让 元素跟随文本高度,而不是撑高父容器 在页面布局中,经常遇到父容器高度被子元素撑开的问题。在图例所示的案例中,父容器被较高的图片撑开,而文本的高度没有被考虑。本问答将提供纯css解决方案,让图片跟随文本高度,确保父容器的高度不会被图片影响。 解决方法 为了解决这个问题,需要将图片从文档流中脱离…

    2025年12月24日
    000
  • 为什么我的特定 DIV 在 Edge 浏览器中无法显示?

    特定 DIV 无法显示:用户代理样式表的困扰 当你在 Edge 浏览器中打开项目中的某个 div 时,却发现它无法正常显示,仔细检查样式后,发现是由用户代理样式表中的 display none 引起的。但你疑问的是,为什么会出现这样的样式表,而且只针对特定的 div? 背后的原因 用户代理样式表是由…

    2025年12月24日
    200
  • inline-block元素错位了,是为什么?

    inline-block元素错位背后的原因 inline-block元素是一种特殊类型的块级元素,它可以与其他元素行内排列。但是,在某些情况下,inline-block元素可能会出现错位显示的问题。 错位的原因 当inline-block元素设置了overflow:hidden属性时,它会影响元素的…

    2025年12月24日
    000
  • 为什么 CSS mask 属性未请求指定图片?

    解决 css mask 属性未请求图片的问题 在使用 css mask 属性时,指定了图片地址,但网络面板显示未请求获取该图片,这可能是由于浏览器兼容性问题造成的。 问题 如下代码所示: 立即学习“前端免费学习笔记(深入)”; icon [data-icon=”cloud”] { –icon-cl…

    2025年12月24日
    200
  • 为什么使用 inline-block 元素时会错位?

    inline-block 元素错位成因剖析 在使用 inline-block 元素时,可能会遇到它们错位显示的问题。如代码 demo 所示,当设置了 overflow 属性时,a 标签就会错位下沉,而未设置时却不会。 问题根源: overflow:hidden 属性影响了 inline-block …

    2025年12月24日
    000
  • 如何利用 CSS 选中激活标签并影响相邻元素的样式?

    如何利用 css 选中激活标签并影响相邻元素? 为了实现激活标签影响相邻元素的样式需求,可以通过 :has 选择器来实现。以下是如何具体操作: 对于激活标签相邻后的元素,可以在 css 中使用以下代码进行设置: li:has(+li.active) { border-radius: 0 0 10px…

    2025年12月24日
    100
  • 为什么我的 CSS 元素放大效果无法正常生效?

    css 设置元素放大效果的疑问解答 原提问者在尝试给元素添加 10em 字体大小和过渡效果后,未能在进入页面时看到放大效果。探究发现,原提问者将 CSS 代码直接写在页面中,导致放大效果无法触发。 解决办法如下: 将 CSS 样式写在一个单独的文件中,并使用 标签引入该样式文件。这个操作与原提问者观…

    2025年12月24日
    000
  • 如何模拟Windows 10 设置界面中的鼠标悬浮放大效果?

    win10设置界面的鼠标移动显示周边的样式(探照灯效果)的实现方式 在windows设置界面的鼠标悬浮效果中,光标周围会显示一个放大区域。在前端开发中,可以通过多种方式实现类似的效果。 使用css 使用css的transform和box-shadow属性。通过将transform: scale(1.…

    2025年12月24日
    200
  • 为什么我的 em 和 transition 设置后元素没有放大?

    元素设置 em 和 transition 后不放大 一个 youtube 视频中展示了设置 em 和 transition 的元素在页面加载后会放大,但同样的代码在提问者电脑上没有达到预期效果。 可能原因: 问题在于 css 代码的位置。在视频中,css 被放置在单独的文件中并通过 link 标签引…

    2025年12月24日
    100
  • 为什么我的 Safari 自定义样式表在百度页面上失效了?

    为什么在 Safari 中自定义样式表未能正常工作? 在 Safari 的偏好设置中设置自定义样式表后,您对其进行测试却发现效果不同。在您自己的网页中,样式有效,而在百度页面中却失效。 造成这种情况的原因是,第一个访问的项目使用了文件协议,可以访问本地目录中的图片文件。而第二个访问的百度使用了 ht…

    2025年12月24日
    000

发表回复

登录后才能评论
关注微信