优化你的 JavaScript 项目:Axios request 封装指南

liam
• 阅读 308

在开发中,为了提高效率,通常对 Axios 进行封装,简化了请求的发送和对响应的处理。同时,统一错误处理机制有助于维护代码的清晰和一致性。本文介绍了一些高效封装 Axios 请求的方法。

优化你的 JavaScript 项目:Axios request 封装指南

封装理念

通过创建一个请求函数,我们可以隐藏 Axios 的直接调用,将请求的配置作为参数传入。成功的请求会解析(resolve)返回数据,失败的请求则拒绝(reject)并返回错误信息。promise 的使用使得处理这些行为变得异常便利。

封装基础请求如下所示:

function request(options) {
  return new Promise((resolve, reject) => {
    axios(options)
      .then(response => {
        resolve(response.data);
      })
      .catch(error => {
        reject(error);
      });
  });
}

进一步,封装常用的 get 和 post 请求方法:

function get(endpoint, query) {
  return request({
    method: 'get',
    url: endpoint,
    params: query
  });
}

function post(endpoint, payload) {
  return request({
    method: 'post',
    url: endpoint,
    data: payload
  });
}

现在,在代码中直接利用 getpost 函数即可发起请求。

精简重复代码

通用设置,如 baseURL,应当被提取,避免每次请求重复声明。

function request(options) {
  let axiosInstance = axios.create({
    baseURL: 'https://your-api-domain.com/api/',
    timeout: 10000
  });

  // 应用实例配置
  options = Object.assign({}, options, { axiosInstance });

  return new Promise((resolve, reject) => {
    axiosInstance(options)
      .then(response => {
        resolve(response.data);
      })
      .catch(error => {
        reject(error);
      });
  });
}

如此一来,简化了通用配置的过程。

拦截器的应用

拦截器是 Axios 的重要特性,使得对请求和响应的修改变得简洁。

// 添加请求拦截器
axiosInstance.interceptors.request.use(
  config => {
    // 修改请求之前的配置
    return config;
  },
  error => {
    // 请求错误的处理逻辑
    return Promise.reject(error);
  }
);

// 添加响应拦截器
axiosInstance.interceptors.response.use(
  response => {
    // 统一处理响应数据
    return response;
  },
  error => {
    // 统一处理响应错误
    return Promise.reject(error);
  }
);

错误的统一管理

利用 .catch 捕捉整个请求流程中可能出现的异常,简化了错误处理逻辑。

function request(options) {
  // ...
}

request(options)
  .then(data => {
    // 处理请求成功的数据
  })
  .catch(error => {
    // 统一处理请求异常
  });

请求的取消

在需要中断请求时, Axios 的取消令牌(cancel token)提供了便利。

const CancelToken = axios.CancelToken;
const source = CancelToken.source();

request({
  // 其他配置...
  cancelToken: source.token
});

// 如需取消请求
source.cancel('Operation canceled by the user.');

使用示例

以下是一个调用实例,演示了封装函数的使用方法:

import { get, post } from './request';

get('/user', { id: '12345' })
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.error(error);
  });

post('/user', { name: 'Jane' })
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.error(error);
  });

通过这些方法,你可以轻松实现请求的发起和结果的处理。

实用提示

  • 把 Axios 封装进一个可配置的 request 方法
  • 将基础配置如 baseURL 提取出来
  • 利用拦截器优化请求与响应的处理
  • 通过 .catch 异常处理简化错误处理
  • 支持请求的取消

结束语

Axios 进行恰当的封装能够大幅提升开发效率,减少重复代码,并且集中处理错误,以上提到的封装策略都是常见的实践,依据具体情况灵活调整。

知识扩展:

参考:

点赞
收藏
评论区
推荐文章
Chase620 Chase620
3年前
记录Vue项目实现axios请求头带上token
在vue项目中首先npm命令安装axios:npminstallaxiosSaxios的封装使用请求带上token,token通过登录获取存在vuex,为防止刷新丢失token使用持久化vuexpersistedstate插件保存数据npmiSvuexpersistedstateimportpersistedStat
good123 good123
3年前
前端的路由封装
在一个项目当中,我们常常需要调用很多接口,我们不可能每次调用接口都完整地写一遍调用,因此我们需要对其进行封装/axios.js///封装axiosimportaxiosfrom"axios";importqsfrom"qs";//初始化axios,设置默认的baseURLconsthttpaxios.create(baseUR
Stella981 Stella981
3年前
React中利用axios来实现数据请求
axios是基于Promise来封装的,通常我们会用axios在数据请求这块作如下配置:一、拦截器!(https://oscimg.oschina.net/oscnet/211e5ccb358ad510f5399d98163fe5be900.png)有注释,不难理解,通常请求头参数不是写死的,应该是去浏览器中读的,例如,login之后
Stella981 Stella981
3年前
ActionContext和ServletActionContext区别以及action访问servlet API的三种方法
1\.ActionContext在Struts2开发中,除了将请求参数自动设置到Action的字段中,我们往往也需要在Action里直接获取请求(Request)或会话(Session)的一些信息,甚至需要直接对JavaServletHttp的请求(HttpServletRequest),响应(HttpServletResponse)操作.我们需要
Stella981 Stella981
3年前
Request学习笔记
Request请求对象:平时通过浏览器浏览网页的时候,浏览器会向服务器发送一些请求,而服务器则会把这些请求封装在HttpServletRequest中,我们可以通过这个对象获得一些用户的请求信息。Request.getParameter()是获取请求信息的重要API,或者Request.getParameterNames()。更多用法学习,具体可以查
Wesley13 Wesley13
3年前
Java设计模式之命令模式
介绍命令模式是一种行为型设计模式。在命令模式中,所有的请求都会被包装成为一个对象。参考了一下其他关于命令模式的文章,其中有谈到说是可以用不同的请求对客户进行参数化。对这句话的理解是,因为将请求封装成为对象,所以客户的所有操作,其实就是多个命令类的对象而已,即参数化了。命令模式的最大的特点就是将请求的调用者与请求的最终执行者进行了解
liam liam
1年前
使用 Axios 请求库:简单易学的基础指南
Axios是一个流行的基于Promise的HTTP请求库,用于在浏览器和Node.js中进行HTTP请求。它提供了简单易用的API,可以发送各种类型的请求(如GET、POST、PUT、DELETE等),并处理响应数据,Axios在前端工程化项目中有99%的
liam liam
1年前
全面解读 Axios 的 GET 请求:最佳实践
在进行网络请求时,是一个非常常用的请求库。本文将介绍如何使用axios发起GET请求,并详细列出传参的几种写法。同时会提供一个实践案例,其中包含基本路由与请求处理的过程,并确保在IDE编辑器中可以顺利运行。什么是axios的GET请求?在开始之前,让我们简
liam liam
11个月前
深入解析:Axios 请求如何取消?
在前端开发中,网络请求是非常常见的操作。而有时候,我们可能需要在发送请求后取消它,比如用户在请求还未完成时离开了当前页面或者执行了其他操作,本文将介绍如何在使用发送请求时取消这些请求。基本概念在Axios中,取消请求的基本思路是创建一个用于取消的标记(ca
liam liam
7个月前
Postman 请求参数传递技巧:详解 Query、Path 和 Body 的用法
作为一个功能强大的工具,极大地简化了API测试和调试的过程,提供了发送请求和检查响应的直接方法。本文将着重介绍如何在Postman中高效地处理请求参数,以提高API测试和开发的便利性。解析请求参数首先,我们需要明白什么是请求参数。简单来说,请求参数是传递给