Skip to main content

Welcome to a Grasp lesson

Create a free account to keep studying and create your own study path.

Lesson 3

Pinia Store:状态、Getters 和 Actions

Recommended resources

好的,我们开始今天的课程。

简介

你好!在上一节课中,我们为 Vue 应用构建了导航系统,学会了如何使用 Vue Router 在不同页面间切换,并利用路由守卫来保护需要认证的页面。我们当时留下了一个问题:如何系统、安全地管理用户的登录状态?localStorage 只是一个临时的解决方案。

今天的学习目标是 创建 Pinia store 并定义 state、getters 和 actions。Pinia 是 Vue 官方推荐的状态管理库,它能为我们提供一个集中的“数据仓库”(Store),专门用来存放像用户信息、认证 Token 这样需要在整个应用中共享的数据。

通过这节课,你将学会为我们的全栈项目构建前端的“心脏”——一个可靠的、可预测的状态管理中心。



1. 什么是 Pinia?

在构建大型应用时,多个组件可能都需要访问或修改同一份数据(例如,顶部的导航栏需要显示用户名,个人中心页也需要显示用户名)。如果让这些组件各自维护这份数据,或者通过复杂的 props 和 events 传递,代码会很快变得混乱且难以维护。

状态管理库(如 Pinia)就是为了解决这个问题而生的。它提供了一个全局单例,任何组件都可以从中读取或向其中写入数据,确保了数据源的唯一性和一致性。

首先,我们来快速了解 Pinia 是什么,以及为什么它成为了 Vue 3 的首选方案。

Pinia Simplified

这个视频来自 LearnVue 频道,它简明扼要地介绍了 Pinia 的核心优势,特别是与其前身 Vuex 相比。

请观看视频的前 1分13秒 (00:00 - 01:13),重点关注 Pinia 的几个关键特性: 模块化设计:天然支持创建多个独立的 Store。 简化的 API:核心概念只有 state, getters, 和 actions,相比 Vuex 移除了 mutations。 与 Vue Devtools 的无缝集成。



2. 定义你的第一个 Store

一个 Pinia Store 就是一个包含 state、getters 和 actions 的实体。这三个核心概念可以和你已经熟悉的组件概念做个类比:

  • state: 就像组件中的 data,是 Store 存储的核心数据。
  • getters: 就像组件中的 computed,是基于 state 派生出的计算属性,带有缓存。
  • actions: 就像组件中的 methods,是用来修改 state 的函数,可以包含异步操作。

创建 Store 的两种语法

Pinia 提供了两种定义 Store 的语法:Option Store 和 Setup Store。

  1. Option Store:语法结构类似 Vue 2 的选项式 API,非常直观。
  2. Setup Store:语法结构类似 Vue 3 的组合式 API (<script setup>),使用 ref()、computed() 和普通函数来定义 state、getters 和 actions。这种方式更灵活,也更贴合我们课程中 Vue 3 的开发风格。

接下来,请通过阅读这篇博客文章,系统地学习创建 Store 的完整流程,包括安装、注册,以及用两种不同语法定义 Store。

Pinia 全局状态管理,深入State、Getter、Action

这篇文章用非常清晰的中文步骤和代码示例讲解了 Pinia 的基本使用,并对 State, Getter, Action 做了直观的类比,非常适合快速上手。

请阅读文章的“一、Pinia 的基本使用”部分。重点关注以下几点: “3.1、Store 是什么 ?” 中对 state, getter, action 的类比。 “3.2、Option Store” 的代码结构,它如何定义 state, getters, actions。 “5、Setup Store” 的代码结构,它如何使用 ref, computed 和 function 达到同样的效果。

阅读完后,你应该明白了 defineStore 是创建 Store 的入口。它接受两个参数:

  1. 一个唯一的 ID(字符串),Pinia 用它来标识和连接各个 Store。
  2. 一个选项对象(用于 Option Store)或一个 setup 函数(用于 Setup Store)。

考虑到你熟悉 Vue 3 的组合式 API,我们后续的课程将主要使用 Setup Store 的语法。它能让你更自由地组织代码和使用组合式函数。

作为补充,你可以快速浏览 Pinia 官方文档,看看官方是如何对比这两种语法的。

定义Store - Pinia

Pinia 官方文档也对这两种定义 Store 的方式有非常精炼的解释。

请阅读“定义 Store”章节,特别关注 “Option Store” 和 “Setup Store” 的代码示例。留意“你应该选用哪种语法?”部分的建议,它强调了选择你觉得最舒服的一种即可。



3. Actions:修改 State 的核心

State 和 getters 相对被动,它们定义了“有什么数据”和“派生出什么数据”。而 actions 则是主动的,它们封装了“如何改变数据”的业务逻辑。

Actions 可以是同步的,也可以是异步的。这是处理用户交互、调用 API 等操作的理想场所。

下面的视频通过一个任务列表的例子,生动地展示了如何编写实用的 actions 来处理更复杂的逻辑。

Pinia Crash Course #6 - Actions

Net Ninja 的这个视频演示了如何定义 action 来添加、删除和修改列表中的项,这是非常常见的开发场景。

请观看以下片段: 创建 Action (01:20 - 02:00):学习如何定义一个 addTask action,它接收一个参数并用 this.tasks.push() 来修改 state。 更复杂的 Actions (09:46 - 12:28):观察如何实现 deleteTask 和 toggleFave。重点关注它们如何接收 id 作为参数,并分别使用数组的 .filter() 和 .find() 方法来操作 state。



4. 实战:创建 userStore

理论结合实践是最好的学习方式。现在,我们将运用所学知识,为我们的项目创建一个 userStore。这个 Store 将专门负责管理用户的认证状态和信息。

按照约定,我们通常在 src/stores 目录下创建 store 文件。

文件: src/stores/user.js

import { ref, computed } from 'vue'
import { defineStore } from 'pinia'

// 使用 defineStore 定义一个名为 'user' 的 store
// 'user' 是这个 store 的唯一 ID
export const useUserStore = defineStore('user', () => {
  // 1. State: 使用 ref() 定义响应式状态
  const token = ref(null)
  const currentUser = ref(null) // 用于存储用户信息,例如 { id: 1, name: '张三' }

  // 2. Getters: 使用 computed() 定义计算属性
  const isLoggedIn = computed(() => !!token.value)
  const userName = computed(() => currentUser.value?.name || '游客')

  // 3. Actions: 使用 function 定义方法
  
  /**
   * 设置认证 token
   * @param {string} newToken - 从服务器获取的新 token
   */
  function setToken(newToken) {
    token.value = newToken
    // 在真实应用中,你通常会在这里将 token 持久化到 localStorage
    // localStorage.setItem('token', newToken)
  }

  /**
   * 设置当前登录的用户信息
   * @param {object} newUser - 从服务器获取的用户对象
   */
  function setUser(newUser) {
    currentUser.value = newUser
  }
  
  /**
   * 模拟用户登录,一次性设置 token 和用户信息
   * @param {object} userData - 用户信息
   * @param {string} userToken - 认证 token
   */
  function login(userData, userToken) {
    setUser(userData);
    setToken(userToken);
  }

  /**
   * 用户登出,清空所有认证信息
   */
  function logout() {
    token.value = null
    currentUser.value = null
    // 同样,在真实应用中,需要从 localStorage 清除 token
    // localStorage.removeItem('token')
  }

  // 必须返回所有需要暴露给外部使用的 state, getters, 和 actions
  return {
    token,
    currentUser,
    isLoggedIn,
    userName,
    setToken,
    setUser,
    login,
    logout,
  }
})

代码解析:

  • State (token, currentUser): 我们用 ref(null) 初始化了两个核心状态,代表初始时用户未登录。
  • Getters (isLoggedIn, userName): isLoggedIn 是一个非常实用的计算属性,它根据 token 是否存在来动态判断登录状态。我们在上一节课的路由守卫中就可以用它来代替 !!localStorage.getItem('token')。userName 则安全地获取用户名,并在用户不存在时提供一个默认值。
  • Actions (setToken, setUser, login, logout): 我们定义了清晰、单一职责的 actions。login 和 logout 封装了完整的登录/登出业务流程,这使得组件中的逻辑会变得非常简单。

这个 userStore 结构清晰,职责明确,为我们接下来的前后端交互和状态同步打下了坚实的基础。



总结

非常棒!今天你已经掌握了 Pinia 的核心用法。

  • 核心概念: 我们理解了 Pinia 的三大支柱:state(数据)、getters(计算数据)和 actions(方法)。
  • Store 定义: 你学会了使用 defineStore 函数创建 Store,并了解了 Option 和 Setup 两种语法风格。
  • 实践应用: 我们创建了一个实用的 userStore,它包含了管理用户认证所需要的所有状态和逻辑。

展望未来

我们已经创建好了“数据仓库”,但它现在还只是一个蓝图。在下一节课 “在 Vue 组件中访问和修改 Pinia store 中的状态” 中,我们将学习如何将这个 Store 与我们的 Vue 组件连接起来。你将学会如何在组件中读取 isLoggedIn 状态来显示或隐藏元素,如何显示 userName,以及如何通过点击按钮来调用 login 或 logout 这些 actions。届时,Pinia 的威力才会真正显现出来。