Vue 3中如何封装API请求：提升开发效率的最佳实践

news2025/4/24 20:00:01

在现代前端开发中，API请求是不可避免的一部分，尤其是与后端交互时。随着Vue 3的广泛应用，如何高效地封装API请求，既能提升代码的可维护性，又能确保代码的高复用性，成为了很多开发者关注的话题。

在本文中，我将详细讲解如何在Vue 3项目中封装API请求，让你在实现功能时更加高效，代码更清晰，也能提升项目的可维护性和扩展性。

为什么要封装API请求？

代码复用性：封装后的API请求可以在整个项目中复用，避免了多次写相同的请求代码。
易于维护：API接口可能会发生变动，封装API请求后，只需要修改一个地方，避免了每个请求都修改。
统一处理错误和响应：可以集中处理所有请求的错误，统一格式化API的响应数据。
便于调试和扩展：当项目需要集成新的API或进行调试时，封装后的代码更容易进行修改和调试。

1. Vue 3项目结构

首先，我们需要了解一下Vue 3的项目结构，以便合理地封装API。假设我们的项目目录如下：

src/
│
├── assets/
├── components/
├── views/
├── api/            // 存放API封装代码的目录
├── store/
├── router/
├── App.vue
└── main.js

2. 安装axios

为了向API发送请求，我们通常会使用axios这个库，它是一个基于Promise的HTTP客户端，支持浏览器和Node.js。我们可以通过npm或yarn来安装axios。

npm install axios

3. 创建API封装模块

在src/api目录下，创建一个api.js文件，并在其中进行API封装。

// src/api/api.js

import axios from 'axios';

const apiClient = axios.create({
  baseURL: 'https://api.example.com/', // API的基础URL
  timeout: 10000, // 设置请求超时时间
  headers: {
    'Content-Type': 'application/json',
  },
});

// 请求拦截器：在发送请求之前做一些处理
apiClient.interceptors.request.use(
  (config) => {
    // 可以在这里设置token或其他请求头
    const token = localStorage.getItem('token');
    if (token) {
      config.headers['Authorization'] = `Bearer ${token}`;
    }
    return config;
  },
  (error) => {
    return Promise.reject(error);
  }
);

// 响应拦截器：处理响应数据，统一格式化响应
apiClient.interceptors.response.use(
  (response) => {
    return response.data; // 返回响应的data部分
  },
  (error) => {
    // 处理请求错误
    console.error('API请求错误', error);
    return Promise.reject(error);
  }
);

export default apiClient;

4. 封装API请求

我们可以将不同的API接口封装成函数，便于调用。例如，假设我们有一个获取用户信息和更新用户信息的接口：

// src/api/user.js
import apiClient from './api';

// 获取用户信息
export const getUserInfo = () => {
  return apiClient.get('user/info');
};

// 更新用户信息
export const updateUserInfo = (data) => {
  return apiClient.put('user/update', data);
};

5. 在Vue组件中调用API

接下来，我们可以在Vue组件中调用这些封装好的API函数。比如在一个用户信息的组件中：

<template>
  <div>
    <h1>用户信息</h1>
    <div v-if="userInfo">
      <p>姓名: {{ userInfo.name }}</p>
      <p>邮箱: {{ userInfo.email }}</p>
    </div>
    <div v-else>
      <p>加载中...</p>
    </div>
  </div>
</template>

<script>
import { getUserInfo } from '@/api/user';

export default {
  data() {
    return {
      userInfo: null,
    };
  },
  async created() {
    try {
      const data = await getUserInfo();
      this.userInfo = data;
    } catch (error) {
      console.error('获取用户信息失败', error);
    }
  },
};
</script>

6. 错误处理与全局错误提示

为了提升用户体验，我们通常需要在请求失败时进行友好的错误提示。你可以在API封装的response拦截器中，针对不同的错误码显示相应的提示信息。

例如：

// src/api/api.js

import { ElMessage } from 'element-plus'; // 使用Element Plus的消息提示

apiClient.interceptors.response.use(
  (response) => {
    return response.data;
  },
  (error) => {
    const response = error.response;
    if (response && response.status) {
      switch (response.status) {
        case 401:
          ElMessage.error('未授权，请登录');
          break;
        case 500:
          ElMessage.error('服务器错误，请稍后再试');
          break;
        default:
          ElMessage.error('请求失败，请稍后再试');
      }
    } else {
      ElMessage.error('网络连接错误');
    }
    return Promise.reject(error);
  }
);