Axios TypeScript 二次封装教程：统一拦截器、错误处理与 API 封装

前言

Axios 是一个基于 Promise 的 HTTP 客户端，适用于浏览器和 Node.js 环境。对 Axios 进行二次封装的核心目的在于统一管理 HTTP 请求，包括设置统一的请求前缀、请求头、超时时间，统一处理请求和响应的数据格式，以及集中进行错误处理等。

以下展示一个使用 TypeScript 对 Axios 进行二次封装的详细场景案例。

1. 创建 Axios 实例

首先，需要创建一个 Axios 实例，并配置通用的基础参数。

import axios from 'axios';

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

export default instance;

2. 统一请求处理

封装通用的请求方法，包括处理统一的请求前缀和请求头等信息。

// http.ts
import axios from './path/to/axiosInstance';

// 添加一个通用的请求前缀
function request(url: string, config?: AxiosRequestConfig) {
  const fullPath = `/api/${url}`;

  // 可以在这里添加通用的 header 或其他配置
  const defaultConfig = {
    headers: {
      'Authorization': `Bearer ${localStorage.getItem('token')}`
    }
  };

  return axios({
    url: fullPath,
    ...config,
    ...defaultConfig
  });
}

export default request;

3. 响应拦截器

配置响应拦截器，用于统一处理响应数据的格式。

// http.ts (继续上面的代码)
import axios, { AxiosInstance } from 'axios';

// 响应拦截器
instance.interceptors.response.use(response => {
  // 对响应数据做点什么
  return response.data;
}, error => {
  // 对响应错误做点什么
  return Promise.reject(error);
});

export default instance;

4. 错误处理

统一处理 HTTP 请求过程中可能出现的各类错误。

// http.ts (继续上面的代码)
import { AxiosError } from 'axios';

// 使用封装的请求函数
function handleError(error: AxiosError) {
  if (error.response) {
    // 请求已发出，服务器响应了状态码 2xx 之外的其他状态
    console.error(error.response.data);
    console.error(error.response.status);
    console.error(error.response.headers);
  } else if (error.request) {
    // 请求已发出但没有收到响应
    console.error(error.request);
  } else {
    // 发生了触发请求错误的问题
    console.error('Error', error.message);
  }
  return Promise.reject(error);
}

export { handleError };

5. 使用封装的 HTTP 客户端

在组件或其他业务服务中，调用封装好的 HTTP 客户端发起请求。

// SomeComponent.vue
import http from './path/to/http';
import { handleError } from './path/to/http';

export default {
  async created() {
    try {
      const response = await http('/user', {
        method: 'get'
      });
      this.user = response.data;
    } catch (error) {
      handleError(error);
    }
  }
};

6. 封装特定的 API 请求

创建专门的 API 服务文件，例如用户服务模块。

// api/user.ts
import http from '../http';

export const getUser = (userId: string) => http(`/users/${userId}`);
export const updateUser = (userId: string, userData: object) => http(`/users/${userId}`, {
  method: 'put',
  data: userData
});

// 其他 API 调用 ...

7. 使用特定的 API 服务

在组件内部调用特定的 API 服务接口。

// SomeComponent.vue
import { getUser, updateUser } from './api/user';

export default {
  methods: {
    async fetchUser() {
      try {
        const user = await getUser('123');
        this.user = user;
      } catch (error) {
        handleError(error);
      }
    },
    async saveUser() {
      try {
        await updateUser('123', { name: 'New Name' });
      } catch (error) {
        handleError(error);
      }
    }
  }
};

通过上述步骤，可以构建一个高可维护性且易于使用的 HTTP 客户端。该客户端包含统一的配置、拦截器机制、错误处理逻辑以及 API 调用封装，使得项目中的 API 请求保持一致且便捷。

总结

至此，关于使用 Axios 结合 TypeScript 进行二次封装的完整详细场景案例介绍完毕。如需了解更多相关 Axios 与 TypeScript 二次封装的内容，建议搜索本站历史文章或继续浏览后续相关文章。感谢大家的支持！

基于 TypeScript 的 Axios 二次封装实战：从实例创建到 API 服务化

前言