你好!欢迎来到我们 Vue.js 模块的最后一课。
简介
在上一节课中,我们掌握了如何在 Vue 组件中与 Pinia store 进行交互,实现了 UI 与全局状态的联动。不过,我们当时操作的都还是“模拟”数据。这就像是搭建好了一个功能完备的仓库,但货物还只能手动搬入搬出。
今天的学习目标是 使用 Axios 发送 HTTP 请求并处理响应数据。我们将学习如何使用 Axios 这个强大的工具,让我们的前端应用能够与外部世界(也就是后端 API)通信。学完本课,你将能够:
- 使用
async/await发送 GET 和 POST 请求。 - 封装一个可复用的、生产级的 Axios 实例,包含拦截器和统一错误处理。
- 将 API 调用逻辑与 Pinia action 结合,用从服务器获取的真实数据来更新应用状态。
这节课是打通前后端任督二脉的关键一步。完成它,我们的前端应用就真正具备了与后端服务协作的能力,为接下来我们亲手构建后端服务打下坚实的基础。
1. Axios 基础:发送你的第一个 API 请求
Axios 是一个基于 Promise 的 HTTP 客户端,可用于浏览器和 Node.js。它之所以成为前端开发的事实标准,是因为其简洁的 API、强大的功能(如拦截器、取消请求)和出色的浏览器兼容性。
首先,将 Axios 添加到你的项目中:
# 对于 TypeScript 项目,建议同时安装类型定义
npm install axios
npm install @types/axios --save-dev
安装完成后,我们就可以在组件中发起请求了。async/await 是目前处理异步操作最优雅的方式,也是我们接下来在后端开发中会频繁使用的模式,因此我们将直接采用这种方式。
Vue and Axios (feat. Kanye REST API)
这个视频将快速向你展示如何在 Vue 3 组件中安装 Axios,并分别使用 Promise 的 .then() 语法和更现代的 async/await 语法来发起一个 GET 请求。它还会演示如何发送一个 POST 请求。
请观看视频的 00:28 - 04:08 部分。重点关注: GET 请求 (00:28 - 02:07):观察如何发送请求,并注意 response.data 才是我们通常需要的数据。 Async/Await (02:07 - 02:53):理解如何用 async/await 和 try/catch 来重构代码,这会让异步逻辑看起来像同步代码一样清晰。 POST 请求 (02:53 - 04:08):注意 axios.post 的第二个参数是如何传递数据的。
看完视频后,你应该掌握了在组件中发起基本请求的方法。例如,在一个组件的 onMounted 生命周期钩子中获取数据:
<script setup lang="ts">
import { ref, onMounted } from 'vue';
import axios from 'axios';
const quote = ref('');
onMounted(async () => {
try {
// 使用 async/await 发起 GET 请求
const response = await axios.get('https://api.kanye.rest/');
// Axios 的响应体中,服务器返回的数据通常在 data 属性里
quote.value = response.data.quote;
} catch (error) {
console.error('获取数据失败:', error);
}
});
</script>
直接在组件里这样写虽然能工作,但随着项目变大,很快就会变得难以维护。每个组件都自己管理 API 地址、请求头和错误处理,会导致大量重复代码。
2. 生产级实践:封装 Axios
作为一名开发者,你一定知道代码复用和分层的重要性。对于网络请求,最佳实践是将其封装成一个独立的“服务层”。这能为我们带来诸多好处:
- 统一配置:在一个地方管理
baseURL、timeout、headers等。 - 拦截器:在请求发送前(例如,附加认证 Token)或响应返回后(例如,统一处理错误、转换数据格式)执行通用逻辑。
- 代码整洁:组件只需调用一个简单的函数,而无需关心 Axios 的具体实现细节。
这张流程图直观地展示了 Axios 请求的生命周期,其中“拦截器”(Interceptor)扮演了关键的“关卡”角色。
接下来,我们将创建一个生产级的 Axios 封装。
Vue3 封装Axios 实战:从基础到生产级,新手也能秒上手
这篇来自稀土掘金的文章非常详尽地介绍了如何从零开始封装一个生产级的 Axios 实例。它涵盖了从基础配置到高级优化的所有步骤,并且提供了 TypeScript 版本,非常适合我们的项目。
请仔细阅读文章的“二、基础版封装”部分,重点关注以下内容: 2.1 创建 Axios 实例:理解 axios.create 的作用。 2.2 TS 版本:这是我们的重点。通读 utils/request.ts 的完整代码,理解请求拦截器 (request.use) 和响应拦截器 (response.use) 的作用。注意它们是如何处理 Token 和不同类型的错误的。 2.3 环境变量配置:了解如何使用 .env 文件来区分开发和生产环境的 API 地址,这是一个非常重要的工程化实践。 你可以将这部分代码作为模板,在你的项目中创建 src/utils/request.ts 文件。
通过上述封装,我们现在有了一个强大的 request.ts 模块,它导出了 get、post 等便捷方法,并且自动处理了大部分通用逻辑。
3. 组织 API 与错误处理
有了统一的请求实例后,我们还需要更好地组织具体的 API 调用。将所有 API 请求函数按照业务模块(如用户、商品)进行拆分,是一种非常清晰且可扩展的做法。
同时,我们需要策略性地处理错误。错误可以分为两种:
- 业务错误 (例如,密码错误,状态码
200但code: 4001):通常在响应拦截器中根据后端返回的特定code统一提示。 - HTTP 错误 (例如,
401未授权,404未找到,500服务器错误):这些错误也应该在响应拦截器中进行全局处理,比如401时自动跳转到登录页。
Handling Axios Errors in Vue.js with Laravel Sanctum
这个视频演示了如何处理不同类型的 HTTP 错误。它区分了在组件内通过 try/catch 进行局部处理和通过 Vue 的全局错误处理器进行全局处理两种策略。
请观看以下片段: 01:27 - 02:05:了解在组件内部使用 try/catch 块来捕获特定错误的模式。 02:34 - 03:51:这是重点。观察如何在全局错误处理器(在我们的例子中,就是 Axios 响应拦截器的 error 回调)中,使用 switch 语句根据 error.response.status 来处理不同的 HTTP 状态码,例如 401, 403, 404, 500。我们的 request.ts 封装已经包含了类似逻辑,这个视频可以帮你更直观地理解其工作原理。
结合文章和视频的知识,我们可以建立起清晰的 API 组织结构。
1. 创建 API 模块 (src/api/user.ts)
将所有与用户相关的接口都定义在这里。
// src/api/user.ts
import { get, post } from '@/utils/request'; // 导入我们封装好的方法
// 定义登录接口的请求和响应类型
interface LoginParams {
username: string;
password: string;
}
interface LoginResponse {
token: string;
user: {
id: number;
name: string;
};
}
// 导出一个包含所有用户相关 API 的对象
export const userApi = {
// 登录接口
login: (data: LoginParams) => post<LoginResponse>('/auth/login', data),
// 获取用户信息接口 (示例)
getUserProfile: () => get('/user/profile'),
};
2. 在组件中使用
<script setup lang="ts">
import { userApi } from '@/api/user';
const handleLogin = async () => {
try {
const res = await userApi.login({ username: 'test', password: '123' });
// `res` 已经是后端返回的 data 部分了
console.log(res.token);
// 接下来,我们会把这个 token 和 user 信息存到 Pinia store
} catch (error) {
// 全局拦截器已经弹出了错误消息,这里可以不处理
// 或者只处理一些组件内部的逻辑,比如停止 loading 状态
console.error('登录失败,组件层面捕获', error);
}
}
</script>
4. 融会贯通:在 Pinia Action 中调用 API
现在,我们来完成最后一步,也是最重要的一步:将 API 调用与状态管理连接起来。
最佳实践是:组件不直接调用 API 来修改全局状态,而是调用一个 Pinia Action,由这个 Action 负责发起 API 请求并根据结果更新 State。
这遵循了“单向数据流”的原则,让数据变更的来源清晰可追溯。
Axios + Vue.js 3 + Pinia, a “comfy” configuration
这篇文章虽然标题是关于配置的,但其核心价值在于清晰地演示了如何将封装好的 Axios 服务与 Pinia action 结合。它展示了从 API 服务定义到 Pinia store 中创建异步 action 的完整流程。
请重点阅读文章的 “4. Integrate the services with the Pinia stores” 这一节。关注 dispatchGetSchools 这个异步 action 函数: 它被定义为一个 async 函数。 内部使用 try/catch 包裹了 API.school.getSchools() 的调用。 请求成功后,它调用 initSchools(data.content) 来更新 store 的 state。 请求失败后,它在 catch 块中处理错误。 这个模式正是我们接下来要应用的。
让我们来改造上一节课创建的 userStore。
文件: src/stores/user.ts
import { defineStore } from 'pinia';
import { ref, computed } from 'vue';
import { userApi } from '@/api/user'; // 1. 导入 API 模块
export const useUserStore = defineStore('user', () => {
// State
const token = ref<string | null>(localStorage.getItem('token'));
const currentUser = ref<any | null>(JSON.parse(localStorage.getItem('user') || 'null'));
// Getters
const isLoggedIn = computed(() => !!token.value);
const userName = computed(() => currentUser.value?.name || '游客');
// Actions
// 2. 改造 login action
async function login(username: string, password: string) {
try {
// 调用 API 进行登录
const response = await userApi.login({ username, password });
// 3. 使用 API 返回的数据更新 state
token.value = response.token;
currentUser.value = response.user;
// 4. 将 token 和用户信息存入 localStorage,用于持久化登录
localStorage.setItem('token', response.token);
localStorage.setItem('user', JSON.stringify(response.user));
} catch (error) {
// 登录失败,清空状态
// 错误提示已在 Axios 响应拦截器中处理,这里可以只记录日志或不处理
console.error('Action: 登录失败', error);
// 抛出错误,以便组件层可以捕获
throw error;
}
}
function logout() {
token.value = null;
currentUser.value = null;
localStorage.removeItem('token');
localStorage.removeItem('user');
// 在真实应用中,可能还需要通知后端销毁 session
}
return { token, currentUser, isLoggedIn, userName, login, logout };
});
现在,TheHeader.vue 组件中的登录按钮将调用这个真正能与后端通信的 login action,整个数据流就完全打通了!
总结
恭喜你完成了 Vue 模块的全部内容!今天,我们成功地为前端应用安装了“引擎”和“通信系统”。
- 发送请求: 你学会了使用 Axios 和
async/await来发送 GET 和 POST 请求。 - 代码封装: 你掌握了通过创建实例和设置拦截器来封装一个生产级的
request.ts模块,实现了配置的统一管理和全局错误处理。 - 代码组织: 你学会了将 API 调用按业务模块组织在
src/api文件夹下,使项目结构更清晰。 - 状态整合: 最重要的是,你学会了在 Pinia Action 中调用 API,并用服务器返回的数据来更新全局状态,这是现代前端应用开发的核心模式。
展望未来
我们的前端应用现在已经“万事俱备,只欠东风”——这个“东风”就是一个稳定可靠的后端 API。在接下来的 “Node.js 与 TypeScript 后端基础” 模块中,我们将亲自去“借”这个东风。你将从零开始,初始化一个 Node.js 项目,并配置好 TypeScript 环境,为我们即将构建的强大后端服务打下第一块基石。准备好进入服务器端的世界吧!