Vue 2 中 axios 的常见封装方法

2025/3/9
介绍了在 Vue 2 中对 axios 进行封装的常见方面,包括创建实例、请求与响应拦截器、封装请求方法、全局错误处理、结合 Vue 实例、取消请求、请求缓存等内容,以让 axios 在项目中使用更简洁高效并便于管理请求响应。
Vue 2 中 axios 封装相关代码示例截图,展示创建实例、请求拦截器、响应拦截器等代码片段截图

在 Vue 2 中,axios 并没有被 Vue 官方直接封装,但开发者通常会根据项目需求对 axios 进行封装,以便更好地管理 HTTP 请求。以下是一些常见的封装方面:

1. 创建 axios 实例

通过 axios.create 创建一个自定义的 axios 实例,可以设置默认的配置,如 baseURLtimeout 等。

import axios from 'axios';

const instance = axios.create({
  baseURL: 'https://api.example.com',
  timeout: 10000,
  headers: {
    'Content-Type': 'application/json',
  },
});

export default instance;

2. 请求拦截器

请求拦截器可以在请求发送之前对请求进行处理,例如添加认证 token、设置请求头等。

instance.interceptors.request.use(
  (config) => {
    const token = localStorage.getItem('token');
    if (token) {
      config.headers.Authorization = `Bearer ${token}`;
    }
    return config;
  },
  (error) => {
    return Promise.reject(error);
  }
);

3. 响应拦截器

响应拦截器可以在接收到响应后对响应数据进行处理,例如统一处理错误码、格式化数据等。

instance.interceptors.response.use(
  (response) => {
    // 对响应数据进行处理
    return response.data;
  },
  (error) => {
    // 统一处理错误
    if (error.response) {
      switch (error.response.status) {
        case 401:
          // 处理未授权
          break;
        case 404:
          // 处理未找到
          break;
        default:
          // 处理其他错误
      }
    }
    return Promise.reject(error);
  }
);

4. 封装请求方法

将常用的请求方法(如 getpostputdelete 等)进行封装,简化调用。

export default {
  get(url, params) {
    return instance.get(url, { params });
  },
  post(url, data) {
    return instance.post(url, data);
  },
  put(url, data) {
    return instance.put(url, data);
  },
  delete(url) {
    return instance.delete(url);
  },
};

5. 全局错误处理

在封装中可以统一处理请求错误,避免在每个请求中都写错误处理逻辑。

instance.interceptors.response.use(
  (response) => response,
  (error) => {
    // 全局错误处理
    console.error('Request failed:', error);
    return Promise.reject(error);
  }
);

6. 结合 Vue 实例

可以将封装好的 axios 实例挂载到 Vue 原型上,方便在组件中直接使用。

import Vue from 'vue';
import axiosInstance from './axiosInstance';

Vue.prototype.$http = axiosInstance;

在组件中使用:

export default {
  methods: {
    fetchData() {
      this.$http.get('/data').then((response) => {
        console.log(response);
      });
    },
  },
};

7. 取消请求

在某些场景下,可能需要取消请求,可以使用 axios 提供的 CancelToken 来实现。

const CancelToken = axios.CancelToken;
let cancel;

instance.get('/data', {
  cancelToken: new CancelToken(function executor(c) {
    cancel = c;
  }),
});

// 取消请求
cancel();

8. 请求缓存

在某些场景下,可能需要缓存请求结果,可以使用 axios 结合 localStoragesessionStorage 来实现。

const cache = {};

export default {
  get(url, params) {
    const cacheKey = JSON.stringify({ url, params });
    if (cache[cacheKey]) {
      return Promise.resolve(cache[cacheKey]);
    }
    return instance.get(url, { params }).then((response) => {
      cache[cacheKey] = response;
      return response;
    });
  },
};

总结

通过以上封装,可以使 axios 在 Vue 项目中的使用更加简洁、高效,并且能够更好地管理请求和响应。封装的方式可以根据项目的具体需求进行调整和扩展。

标签:VueHTTP
上次更新:

相关文章

npx完全指南:前端开发必备工具详解 | 20年架构师深度解析

本文由20年前端架构师深入解析npx工具,涵盖其核心功能、优势、高级用法、最佳实践及与npm/yarn的区别比较,帮助开发者掌握这一现代前端开发利器。

·前端开发

Astro 静态站点生成器:构建高性能网站的最佳选择

Astro 是一个专注于构建快速、轻量级网站的静态站点生成器,支持多种前端框架,采用岛屿架构减少 JavaScript 加载,提升性能。

·前端开发

Weex 跨平台移动开发框架:核心特性与使用指南

Weex 是由阿里巴巴开源的跨平台移动开发框架,支持使用 Vue.js 或 Rax 构建高性能的 iOS、Android 和 Web 应用。本文详细解析了 Weex 的核心特性、架构、工作流程、组件和模块、开发工具、优缺点、应用场景及未来发展。

·前端开发

ECharts 与 DataV 数据可视化工具对比分析 | 选择指南

本文详细对比了 ECharts 和 DataV 两个常用的数据可视化工具,包括它们的设计目标、优缺点、使用场景和技术栈,帮助读者根据具体需求选择合适的工具。

·前端开发

前端部署后通知用户刷新页面的常见方案 | 单页应用更新提示

本文介绍了在前端部署后通知用户刷新页面的几种常见方案,包括WebSocket实时通知、轮询检查版本、Service Worker版本控制、版本号对比、自动刷新、使用框架内置功能以及第三方库。每种方案的优缺点和示例代码均有详细说明。

·前端开发

file-saver:前端文件下载的 JavaScript 库使用指南

file-saver 是一个用于在浏览器端保存文件的 JavaScript 库,支持生成和下载多种文件格式,如文本、JSON、CSV、图片、PDF 等。本文详细介绍其安装、基本用法、兼容性及与其他工具(如 jszip)的结合使用。

·前端开发

MSW(Mock Service Worker):API 模拟工具的核心优势与使用指南

MSW(Mock Service Worker)是一个用于浏览器和 Node.js 的 API 模拟工具,通过 Service Worker 拦截网络请求,支持 REST 和 GraphQL,适用于开发、测试和调试场景。本文详细介绍 MSW 的核心优势、快速上手步骤、高级用法、适用场景及与其他 Mock 工具的对比。

·前端开发

Preact:轻量级 JavaScript 库,React 的高性能替代方案

Preact 是一个轻量级的 JavaScript 库,提供与 React 相似的 API 和开发体验,但体积更小(约 3-4KB,gzip 后)。它专注于高性能和低资源消耗,特别适合对性能敏感或需要快速加载的 Web 应用。

·前端开发

WASI标准与WebAssembly跨平台生态的未来趋势分析 | 技术深度解析

本文深入探讨了WASI(WebAssembly System Interface)标准的背景、意义及其对WebAssembly跨平台生态的影响。文章分析了WASI在服务器端应用、边缘计算和IoT设备中的应用,以及技术栈和工具链的演进,最后展望了WASI对未来前端开发的影响和最佳实践建议。

·前端开发

WebAssembly沙箱逃逸风险解析及缓解方案 | 前端安全指南

本文深入探讨了WebAssembly(Wasm)在前端开发中的应用及其面临的安全风险,特别是沙箱逃逸问题。文章详细解析了沙箱逃逸的常见途径,并提供了包括内存安全、API安全、JIT安全和宿主环境安全在内的综合缓解方案,以及工程化实践建议,旨在帮助开发人员有效降低安全风险,确保应用的安全性和稳定性。

·前端开发