十年匠心定制 · 商业建站与技术教学双线并行 咨询热线:400-886-1026 service@lmnt.cn
ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

Pinia Store的Options API与Composition API风格对比

Pinia Store的Options API与Composition API风格对比 1. Pinia Store 的两种定义方式概览Pinia 作为 Vue 官方推荐的状态管理库提供了两种定义 Store 的方式Options API 风格和 Composition API 风格。这两种方式在底层实现上是等效的但在代码组织和使用体验上存在显著差异。Options API 风格的 Store 定义采用对象字面量的形式将 state、getters 和 actions 分别声明为对象的属性。这种方式与 Vue 2 的 Options API 非常相似对于从 Vuex 迁移过来的开发者会感到非常熟悉。它的优势在于结构清晰、职责分明特别适合中小型项目或团队中 Vue 2 背景的成员。export const useCounterStore defineStore(counter, { state: () ({ count: 0 }), getters: { doubleCount: (state) state.count * 2, }, actions: { increment() { this.count }, } })Composition API 风格的 Store 则采用 setup 函数的形式使用 ref、computed 等响应式 API 来定义状态和计算属性。这种方式与 Vue 3 的 Composition API 一脉相承提供了更大的灵活性和组合能力。它特别适合复杂的状态逻辑和需要高度复用的场景。export const useCounterStore defineStore(counter, () { const count ref(0) const doubleCount computed(() count.value * 2) function increment() { count.value } return { count, doubleCount, increment } })2. Options API 风格 Store 深度解析2.1 基本结构与核心概念Options API 风格的 Store 由三个主要部分组成state、getters 和 actions。state 用于定义存储的数据状态getters 用于定义派生状态类似于计算属性actions 则用于定义修改状态的方法。state 必须是一个返回初始状态的函数这是为了确保在服务端渲染(SSR)场景下每个请求都能获得独立的状态实例。在实践中我遇到过直接使用对象字面量导致的状态共享问题特别是在测试环境中多次使用同一个 store 时。// 正确写法 - 使用工厂函数 state: () ({ user: null, tokens: [] }) // 错误写法 - 直接使用对象 state: { user: null, // 这会导致所有实例共享同一个状态 }2.2 Getters 的高级用法Getters 不仅可以接收 state 作为第一个参数还可以通过 this 访问整个 store 实例。这使得我们可以创建依赖于其他 getter 的复杂计算属性。getters: { // 基本 getter isLoggedIn: (state) !!state.user, // 使用 this 访问其他 getter greetingMessage(state) { return this.isLoggedIn ? Welcome back, ${state.user.name}! : Please log in } }一个常见的陷阱是尝试在 getter 中修改状态。虽然技术上可行但这违反了单向数据流的原则。正确的做法是将状态修改逻辑放在 actions 中。2.3 Actions 的最佳实践Actions 相当于组件中的 methods它们负责处理业务逻辑和状态更新。与 Vuex 不同Pinia 的 actions 可以是异步的不需要额外的配置。actions: { async login(credentials) { try { this.user await api.login(credentials) this.loadUserData() } catch (error) { this.logout() throw error } }, async loadUserData() { if (!this.user) return this.user.profile await api.getProfile(this.user.id) } }在实践中我建议将复杂的异步操作拆分为多个小型的、单一职责的 actions。这不仅提高了代码的可测试性也使得状态变化更加可预测。3. Composition API 风格 Store 完全指南3.1 响应式状态的定义与管理Composition API 风格的 Store 使用 ref 和 reactive 来定义响应式状态。与 Options API 不同这里的状态定义更加灵活你可以使用任何 Composition API 的特性。export const useProductStore defineStore(products, () { // 基本状态 const products ref([]) const loading ref(false) // 组合式函数复用 const { sortedBy, sortDirection } useSorting() // 计算属性 const sortedProducts computed(() { return [...products.value].sort((a, b) { return sortDirection.value asc ? a[sortedBy.value] - b[sortedBy.value] : b[sortedBy.value] - a[sortedBy.value] }) }) return { products, loading, sortedProducts } })需要注意的是所有需要在模板中访问的状态都必须从 setup 函数中返回。这与组件的 setup 函数规则一致。3.2 使用 Composables 增强 StoreComposition API 的最大优势在于能够轻松地组合和复用逻辑。我们可以将通用的逻辑提取为 composables然后在多个 store 中复用它们。// pagination.composable.js export function usePagination() { const currentPage ref(1) const pageSize ref(10) const paginate (items) { const start (currentPage.value - 1) * pageSize.value return items.slice(start, start pageSize.value) } return { currentPage, pageSize, paginate } } // product.store.js export const useProductStore defineStore(products, () { const products ref([]) const { currentPage, pageSize, paginate } usePagination() const paginatedProducts computed(() paginate(products.value) ) return { products, currentPage, pageSize, paginatedProducts } })这种模式特别适合处理分页、排序、过滤等通用功能可以显著减少代码重复。3.3 与组件生命周期的集成在 Composition API 风格的 Store 中我们可以直接使用生命周期钩子和 watch 等特性这使得 Store 能够更紧密地与组件生命周期集成。export const useAnalyticsStore defineStore(analytics, () { const route useRoute() const pageViews ref(0) // 监听路由变化 watch(() route.path, (newPath) { trackPageView(newPath) pageViews.value }) // 自动清理的副作用 onMounted(() { const timer setInterval(sendHeartbeat, 5000) onUnmounted(() clearInterval(timer)) }) return { pageViews } })需要注意的是在 SSR 环境中使用时要确保这些副作用只在客户端执行。可以通过 process.client 或类似的环境检查来实现。4. 两种方式的对比与选型建议4.1 语法与代码组织对比Options API 风格的 Store 采用分块组织代码的方式将状态、计算属性和方法分别放在不同的对象属性中。这种结构强制实施了关注点分离使得代码结构更加直观特别适合团队协作和快速上手。// Options API 风格 export const useCartStore defineStore(cart, { state: () ({ items: [], checkoutStatus: null }), getters: { totalItems: (state) state.items.reduce((sum, item) sum item.quantity, 0), totalPrice: (state) state.items.reduce((sum, item) sum item.price * item.quantity, 0) }, actions: { addItem(product) { const existing this.items.find(item item.id product.id) existing ? existing.quantity : this.items.push({ ...product, quantity: 1 }) } } })Composition API 风格的 Store 则采用逻辑关注点组织代码的方式相关的状态、计算属性和方法可以放在一起。这种方式在处理复杂逻辑时更加灵活减少了在不同代码块间跳转的需要。// Composition API 风格 export const useCartStore defineStore(cart, () { // 购物车商品 const items ref([]) const checkoutStatus ref(null) // 购物车统计 const totalItems computed(() items.value.reduce((sum, item) sum item.quantity, 0) ) const totalPrice computed(() items.value.reduce((sum, item) sum item.price * item.quantity, 0) ) // 操作方法 function addItem(product) { const existing items.value.find(item item.id product.id) existing ? existing.quantity : items.value.push({ ...product, quantity: 1 }) } return { items, checkoutStatus, totalItems, totalPrice, addItem } })4.2 性能与灵活性考量在性能方面两种方式没有显著差异因为 Pinia 在底层对它们进行了统一的处理。但在某些特定场景下Composition API 风格可能具有轻微优势更细粒度的响应式跟踪Composition API 使用 ref 和 computed 直接可以更精确地控制响应式依赖更高效的更新当只修改部分状态时Composition API 风格可能触发更少的重新计算更好的 Tree-shaking未使用的计算属性和方法更容易被构建工具排除灵活性方面Composition API 风格明显占优可以自由使用所有 Composition API 特性watch、生命周期钩子等更容易提取和复用逻辑片段更好的 TypeScript 支持更自然的异步操作处理4.3 团队协作与项目规模因素对于团队协作和项目规模我有以下建议小型项目或快速原型开发Options API 风格更合适因为它结构简单、学习曲线平缓能让团队快速上手。大型复杂应用Composition API 风格更适合因为它提供了更好的代码组织和复用能力能够有效管理复杂的状态逻辑。混合技术栈团队如果团队中既有 Vue 2 经验丰富的开发者也有熟悉 Vue 3 的成员可以考虑两种风格并存。Pinia 完全支持在同一个项目中混合使用两种风格的 Store。TypeScript 项目Composition API 风格通常能提供更好的类型推断和开发体验特别是在处理复杂类型时。5. 高级技巧与实战经验分享5.1 Store 的组合与复用模式在实际项目中我们经常需要在多个 Store 之间共享逻辑。Pinia 提供了几种方式来实现 Store 的组合与复用。基本组合模式通过函数封装可复用逻辑function createPaginationStore() { return { currentPage: 1, pageSize: 10, get totalPages() { return Math.ceil(this.totalItems / this.pageSize) }, nextPage() { if (this.currentPage this.totalPages) this.currentPage } } } export const useUserStore defineStore(users, { state: () ({ users: [], totalItems: 0, ...createPaginationStore() }) })高级组合模式使用可组合函数export function usePagination() { const currentPage ref(1) const pageSize ref(10) const totalItems ref(0) const totalPages computed(() Math.ceil(totalItems.value / pageSize.value) ) function nextPage() { if (currentPage.value totalPages.value) currentPage.value } return { currentPage, pageSize, totalItems, totalPages, nextPage } } export const useProductStore defineStore(products, () { const products ref([]) const { currentPage, pageSize, ...pagination } usePagination() return { products, currentPage, pageSize, ...pagination } })5.2 测试策略与技巧良好的测试策略对保证 Store 的可靠性至关重要。根据我的经验以下测试方法最为有效单元测试测试单个 action 或 getter 的行为import { setActivePinia, createPinia } from pinia import { useUserStore } from ./user describe(User Store, () { beforeEach(() { setActivePinia(createPinia()) }) test(login action sets user data, async () { const store useUserStore() await store.login({ username: test, password: test }) expect(store.user).toBeDefined() expect(store.isLoggedIn).toBe(true) }) })集成测试测试多个 Store 或与组件交互import { mount } from vue/test-utils import { createPinia } from pinia import App from ./App.vue test(app loads user data on mount, async () { const pinia createPinia() const wrapper mount(App, { global: { plugins: [pinia] } }) await wrapper.vm.$nextTick() const userStore useUserStore() expect(userStore.user).toBeDefined() })实用技巧使用工厂函数创建 Store 实例便于测试不同场景模拟 API 调用以确保测试的独立性和速度测试状态变化而不仅仅是最终结果对复杂异步操作测试中间状态5.3 调试与性能优化Pinia 提供了优秀的开发工具支持但掌握一些调试技巧仍然很有帮助DevTools 高级用法使用时间旅行调试功能回溯状态变化通过订阅功能监听特定 mutation导出和导入状态快照用于问题复现// 手动订阅状态变化 const unsubscribe someStore.$subscribe((mutation, state) { console.log(Store changed:, mutation.type, mutation.payload) }) // 在适当的时候取消订阅 onUnmounted(() unsubscribe())性能优化建议避免在 getter 中执行昂贵计算考虑使用缓存或 memoization对大状态对象使用 shallowRef 而非 ref合理拆分 Store避免单个 Store 过于庞大使用 storeToRefs 进行解构以保持响应性对频繁变化的状态考虑防抖处理// 使用 shallowRef 优化大对象性能 const largeData shallowRef({ /* 大数据对象 */ }) // 防抖处理频繁变化的状态 import { debounce } from lodash-es const searchQuery ref() const updateSearch debounce((query) { searchProducts(query) }, 300) watch(searchQuery, updateSearch)6. 常见问题与解决方案6.1 SSR 环境下的特殊处理在服务端渲染(SSR)环境中使用 Pinia 需要特别注意以下几点状态序列化与反序列化确保只在客户端执行特定逻辑export const useAuthStore defineStore(auth, () { const user ref(null) // 只在客户端执行 if (process.client) { const storedUser localStorage.getItem(user) if (storedUser) user.value JSON.parse(storedUser) } return { user } })跨请求状态污染避免在服务端共享 Store 实例// 在请求处理中为每个请求创建新的 Pinia 实例 export default defineEventHandler((event) { const pinia createPinia() event.context.pinia pinia // ... })SSR 兼容的异步操作正确处理异步数据的获取和传输export const useProductStore defineStore(products, () { const products ref([]) async function fetchProducts() { if (products.value.length) return products.value await $fetch(/api/products) } return { products, fetchProducts } }) // 在组件中 onServerPrefetch(async () { await useProductStore().fetchProducts() })6.2 类型安全的增强实践对于 TypeScript 项目可以通过以下方式增强类型安全基本类型定义interface User { id: string name: string email: string } export const useUserStore defineStore(user, { state: (): { user: User | null } ({ user: null }), actions: { updateUser(partialUser: PartialUser) { if (this.user) { this.user { ...this.user, ...partialUser } } } } })高级类型技巧// 提取 Store 类型 const useCounterStore defineStore(counter, () { const count ref(0) const double computed(() count.value * 2) function increment() { count.value } return { count, double, increment } }) type CounterStore ReturnTypetypeof useCounterStore // 在其他地方使用类型 function useCounterLogic(store: CounterStore) { // 具有完整类型提示 store.increment() }6.3 状态持久化策略虽然 Pinia 本身不提供持久化功能但可以通过插件或组合式函数实现基本持久化方案import { watch } from vue import { defineStore } from pinia export const usePersistentStore defineStore(persistent, () { const state ref(JSON.parse(localStorage.getItem(store) || {})) watch(state, (newValue) { localStorage.setItem(store, JSON.stringify(newValue)) }, { deep: true }) return { state } })使用 pinia-plugin-persistedstateimport { createPinia } from pinia import piniaPluginPersistedstate from pinia-plugin-persistedstate const pinia createPinia() pinia.use(piniaPluginPersistedstate) export const useAuthStore defineStore(auth, { state: () ({ token: null }), persist: { paths: [token], storage: sessionStorage // 可选默认为 localStorage } })自定义持久化策略export const useSecureStore defineStore(secure, { state: () ({ sensitiveData: null }), persist: { serializer: { serialize: (value) encrypt(JSON.stringify(value)), deserialize: (value) JSON.parse(decrypt(value)) }, storage: { getItem: (key) /* 自定义获取逻辑 */, setItem: (key, value) /* 自定义存储逻辑 */ } } })在实际项目中我通常会根据数据类型和安全要求采用不同的持久化策略。对于敏感数据建议结合加密技术对于大型数据考虑使用 IndexedDB 而非 localStorage。
返回列表