快捷導(dǎo)航

一文詳解如何在Vue3中封裝API請求

更新時間：2025年05月08日 15:10:00 作者：來自星星的坤

在現(xiàn)代前端開發(fā)中,API請求是不可避免的一部分,尤其是與后端交互時,下面我們來看看如何在Vue 3項目中封裝API請求,讓你在實現(xiàn)功能時更加高效吧

在現(xiàn)代前端開發(fā)中，API請求是不可避免的一部分，尤其是與后端交互時。隨著Vue 3的廣泛應(yīng)用，如何高效地封裝API請求，既能提升代碼的可維護性，又能確保代碼的高復(fù)用性，成為了很多開發(fā)者關(guān)注的話題。

在本文中，我將詳細講解如何在Vue 3項目中封裝API請求，讓你在實現(xiàn)功能時更加高效，代碼更清晰，也能提升項目的可維護性和擴展性。

為什么要封裝API請求

代碼復(fù)用性：封裝后的API請求可以在整個項目中復(fù)用，避免了多次寫相同的請求代碼。

易于維護：API接口可能會發(fā)生變動，封裝API請求后，只需要修改一個地方，避免了每個請求都修改。

統(tǒng)一處理錯誤和響應(yīng)：可以集中處理所有請求的錯誤，統(tǒng)一格式化API的響應(yīng)數(shù)據(jù)。

便于調(diào)試和擴展：當(dāng)項目需要集成新的API或進行調(diào)試時，封裝后的代碼更容易進行修改和調(diào)試。

1. Vue 3項目結(jié)構(gòu)

首先，我們需要了解一下Vue 3的項目結(jié)構(gòu)，以便合理地封裝API。假設(shè)我們的項目目錄如下：

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

2. 安裝axios

為了向API發(fā)送請求，我們通常會使用axios這個庫，它是一個基于Promise的HTTP客戶端，支持瀏覽器和Node.js。我們可以通過npm或yarn來安裝axios。

npm install axios

3. 創(chuàng)建API封裝模塊

在src/api目錄下，創(chuàng)建一個api.js文件，并在其中進行API封裝。

// src/api/api.js
 
import axios from 'axios';
 
const apiClient = axios.create({
  baseURL: 'https://api.example.com/', // API的基礎(chǔ)URL
  timeout: 10000, // 設(shè)置請求超時時間
  headers: {
    'Content-Type': 'application/json',
  },
});
 
// 請求攔截器：在發(fā)送請求之前做一些處理
apiClient.interceptors.request.use(
  (config) => {
    // 可以在這里設(shè)置token或其他請求頭
    const token = localStorage.getItem('token');
    if (token) {
      config.headers['Authorization'] = `Bearer ${token}`;
    }
    return config;
  },
  (error) => {
    return Promise.reject(error);
  }
);
 
// 響應(yīng)攔截器：處理響應(yīng)數(shù)據(jù)，統(tǒng)一格式化響應(yīng)
apiClient.interceptors.response.use(
  (response) => {
    return response.data; // 返回響應(yīng)的data部分
  },
  (error) => {
    // 處理請求錯誤
    console.error('API請求錯誤', error);
    return Promise.reject(error);
  }
);
 
export default apiClient;

4. 封裝API請求

我們可以將不同的API接口封裝成函數(shù)，便于調(diào)用。例如，假設(shè)我們有一個獲取用戶信息和更新用戶信息的接口：

// 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組件中調(diào)用API

接下來，我們可以在Vue組件中調(diào)用這些封裝好的API函數(shù)。比如在一個用戶信息的組件中：

<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攔截器中，針對不同的錯誤碼顯示相應(yīng)的提示信息。

例如：

// 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('未授權(quán)，請登錄');
          break;
        case 500:
          ElMessage.error('服務(wù)器錯誤，請稍后再試');
          break;
        default:
          ElMessage.error('請求失敗，請稍后再試');
      }
    } else {
      ElMessage.error('網(wǎng)絡(luò)連接錯誤');
    }
    return Promise.reject(error);
  }
);

7. 總結(jié)

通過上述的封裝，我們可以大大提高項目的可維護性和擴展性。API封裝不僅讓我們的代碼更簡潔，而且通過集中管理請求和響應(yīng)，我們可以更輕松地處理跨多個組件的API調(diào)用，并且能夠統(tǒng)一管理錯誤和響應(yīng)格式。進一步優(yōu)化你的代碼結(jié)構(gòu)和處理邏輯，你將能夠更加專注于業(yè)務(wù)邏輯的實現(xiàn)，而不是每次都在重復(fù)寫請求代碼。

封裝API請求只是現(xiàn)代前端開發(fā)的一小步，但它將帶來更好的代碼結(jié)構(gòu)和開發(fā)效率。如果你習(xí)慣了這種封裝方式，未來遇到更多的API請求時，你將能夠更加游刃有余地進行開發(fā)。