import defaultSettings from "@/settings"; // 导入 Element Plus 中英文语言包 import zhCn from…
- User
import defaultSettings from "@/settings";
// 导入 Element Plus 中英文语言包 import zhCn from "element-plus/es/locale/lang/zh-cn"; import en from "element-plus/es/locale/lang/en"; import { store } from "@/store"; import { DeviceEnum } from "@/enums/settings/device.enum"; import { SidebarStatus } from "@/enums/settings/layout.enum";
// 1、创建 useAppStore 实例 export const useAppStore = defineStore("app", () => { /* useStorage 接受两个参数: 第一个参数是你想要保存的键名(例如 'user'),这会作为 key 存储在浏览器的 localStorage 或 sessionStorage 中 第二个参数是初始值(例如 { name: '', age: 0 }),如果本地存储中没有找到该键的值,它会使用这个初始值 响应式: useStorage 返回的是一个响应式的对象,可以通过 .value 访问和修改其中的数据。这样,当 user 数据发生变化时,Vue 会自动触发视图更新 数据持久化: 当你更新 user 数据时,它会自动同步到 localStorage 中,页面刷新后仍然能够保留这个数据 */ // 设备类型 取值:DESKTOP = "desktop"(默认)、MOBILE = "mobile" const device = useStorage("device", DeviceEnum.DESKTOP); // 布局大小 取值:DEFAULT = "default"(默认)、LARGE = "large"、SMALL = "small" const size = useStorage("size", defaultSettings.size); // 语言 取值:ZH_CN = "zh-cn"(默认)、EN = "en" const language = useStorage("language", defaultSettings.language); // 侧边栏状态 取值:OPENED = "opened"、CLOSED = "closed"(默认) const sidebarStatus = useStorage("sidebarStatus", SidebarStatus.CLOSED); // 侧边栏 包含:opened、withoutAnimation const sidebar = reactive({ opened: sidebarStatus.value === SidebarStatus.OPENED, withoutAnimation: false, }); // 顶部菜单激活路径 const activeTopMenuPath = useStorage("activeTopMenuPath", "");
// 1、根据语言标识读取对应的语言包 const locale = computed(() => { if (language?.value == "en") { return en; } else { return zhCn; } });
// 2、切换侧边栏 function toggleSidebar() { sidebar.opened = !sidebar.opened; sidebarStatus.value = sidebar.opened ? SidebarStatus.OPENED : SidebarStatus.CLOSED; }
// 3、 关闭侧边栏 function closeSideBar() { sidebar.opened = false; sidebarStatus.value = SidebarStatus.CLOSED; }
// 4、打开侧边栏 function openSideBar() { sidebar.opened = true; sidebarStatus.value = SidebarStatus.OPENED; }
// 5、切换设备 function toggleDevice(val: string) { device.value = val; }
/**
- 6、改变布局大小
- @param val 布局大小 default | small | large */ function changeSize(val: string) { size.value = val; }
/**
- 7、切换语言
- @param val */ function changeLanguage(val: string) { language.value = val; }
/**
- 8、混合模式顶部切换 */ function activeTopMenu(val: string) { activeTopMenuPath.value = val; }
return { device, sidebar, language, locale, size, activeTopMenu, toggleDevice, changeSize, changeLanguage, toggleSidebar, closeSideBar, openSideBar, activeTopMenuPath, }; });
/**
- 2、用于在组件外部(如在Pinia Store 中)使用 Pinia 提供的 store 实例
- 官方文档解释了如何在组件外部使用 Pinia Store:
- https://pinia.vuejs.org/core-concepts/outside-component-usage.html#using-a-store-outside-of-a-component */ export function useAppStoreHook() { return useAppStore(store); } 解释下
- Assistant
这段代码是基于 Vue 3 + Pinia 创建的一个状态管理(store)实现,主要用于管理应用的全局状态,特别是和界面布局、语言、设备类型相关的信息。具体解释如下:
1. 模块整体作用
- 创建了一个 Pinia Store,名字是
"app",用来统一管理应用的状态,比如设备类型、布局大小、语言、侧边栏的打开关闭状态等。 - 通过
useStorage持久化状态到浏览器的localStorage中,保证刷新页面后状态依然会保留。 - 提供了一系列操作函数来修改这些状态,比如切换侧边栏、切换设备、切换语言等。
2. 代码详细解释
2.1 import 引入
import defaultSettings from "@/settings"; import zhCn from "element-plus/es/locale/lang/zh-cn"; import en from "element-plus/es/locale/lang/en"; import { store } from "@/store"; import { DeviceEnum } from "@/enums/settings/device.enum"; import { SidebarStatus } from "@/enums/settings/layout.enum";- 引入了默认设置,Element Plus UI 库的中英文语言包。
- 引入了项目中的枚举类型,
DeviceEnum和SidebarStatus用于限定设备类型和侧边栏状态的可能取值。 - 引入了
store(Pinia 的 store 实例),方便在组件外部使用该 store。
2.2
useAppStoreexport const useAppStore = defineStore("app", () => { ... });- 使用
defineStore创建了一个名为app的 Pinia Store,使用的是 Pinia 的组合式 API 风格。 - 这个 store 管理一系列响应式变量和函数。
2.3 响应式状态和持久化状态
useStorageconst device = useStorage("device", DeviceEnum.DESKTOP); const size = useStorage("size", defaultSettings.size); const language = useStorage("language", defaultSettings.language); const sidebarStatus = useStorage("sidebarStatus", SidebarStatus.CLOSED); const activeTopMenuPath = useStorage("activeTopMenuPath", "");useStorage是 VueUse 库的一个组合式函数,功能类似ref,但是数据会同步到localStorage,例如:device: 当前设备类型,默认为桌面设备desktop。size: 布局大小,默认值取自项目的配置。language: 语言,默认为中文zh-cn。sidebarStatus: 侧边栏状态,默认关闭closed。activeTopMenuPath: 顶部菜单激活路径。
这些值在浏览器本地存储中持久化,刷新页面后数据依然存在。
2.4 组合式响应式对象
sidebarconst sidebar = reactive({ opened: sidebarStatus.value === SidebarStatus.OPENED, withoutAnimation: false, });- 这是一个响应式对象,表示侧边栏是否展开和是否无动画。
opened的初始值根据sidebarStatus初始化。withoutAnimation一般用于控制切换时的动画效果。
2.5 计算属性
localeconst locale = computed(() => { if (language?.value == "en") { return en; } else { return zhCn; } });- 根据当前语言返回对应的 Element Plus 语言包。
- 方便 UI 组件库根据语言内容进行国际化。
2.6 函数部分(对状态进行修改)
- 切换侧边栏状态
function toggleSidebar() { sidebar.opened = !sidebar.opened; sidebarStatus.value = sidebar.opened ? SidebarStatus.OPENED : SidebarStatus.CLOSED; }-
逻辑是切换侧边栏的打开和关闭状态,并同步更新
sidebarStatus。 -
关闭侧边栏(强制关闭)
function closeSideBar() { sidebar.opened = false; sidebarStatus.value = SidebarStatus.CLOSED; }-
将侧边栏关闭。
-
打开侧边栏
function openSideBar() { sidebar.opened = true; sidebarStatus.value = SidebarStatus.OPENED; }-
将侧边栏打开。
-
切换设备
function toggleDevice(val: string) { device.value = val; }-
传入设备类型字符串并设置当前设备类型,常见的是
desktop或mobile。 -
改变布局大小
function changeSize(val: string) { size.value = val; }-
改变布局大小,比如
default|small|large。 -
切换语言
function changeLanguage(val: string) { language.value = val; }-
切换应用语言。
-
切换激活的顶部菜单
function activeTopMenu(val: string) { activeTopMenuPath.value = val; }- 设置当前激活的顶部菜单路径。
2.7 返回暴露
return { device, sidebar, language, locale, size, activeTopMenu, toggleDevice, changeSize, changeLanguage, toggleSidebar, closeSideBar, openSideBar, activeTopMenuPath, };- 将状态和操作函数暴露出去,供 Vue 组件调用。
2.8 在组件外部使用 Store
export function useAppStoreHook() { return useAppStore(store); }- 有些时候我们希望在普通的
.ts文件或者 Pinia 以外的场景调用该 store。 - 这时传入
store实例,确保 Pinia store 正常创建和响应。
总结
这段代码实现的是一个应用级别的状态管理的 Pinia Store,重点管理:
- 设备类型(桌面/手机)
- 布局大小
- 应用语言
- 侧边栏展开收缩状态
- 顶部菜单激活路径
并通过
useStorage绑定到 localStorage,实现状态的本地持久化。代码合理组织了状态和对应的操作方法,界面组件可以通过直接导入这个 store 来轻松访问和修改应用全局状态。 - 创建了一个 Pinia Store,名字是
- User
defineStore 详解下
- Assistant
defineStore是 Pinia(Vue 3 官方推荐的状态管理库)的核心 API,用于创建一个 store(状态仓库)实例。它类似于 Vuex 的createStore,但是用更现代、灵活且类型友好的组合式 API 方式定义状态和逻辑。
defineStore概述defineStore会返回一个钩子函数(例如:useAppStore),调用该钩子函数会得到对应的 store 实例。store 包含响应式状态、getter 和 actions,负责管理和操作应用中的全局状态。const useAppStore = defineStore(id, options);id:必填,字符串类型,store 的唯一 ID 标识。options:用来定义 state、getter 和 actions。
defineStore两种写法详解Pinia 支持两种定义 Store 的写法:
1. 选项式 API(Options API)
和 Vue 组件类似,传入一个包含
state、getters和actions的对象。const useAppStore = defineStore('app', { state: () => ({ counter: 0, name: 'pinia', }), getters: { doubleCounter(state) { return state.counter * 2; }, }, actions: { increment() { this.counter++; }, }, });state是一个函数,返回状态对象。getters是一个普通对象,函数会自动接收state参数,也可以通过this来访问 state。actions是函数集合,可以修改状态,支持异步。
使用:
const appStore = useAppStore(); console.log(appStore.counter); appStore.increment();
2. 组合式 API(Setup API)
接收一个返回状态和方法的函数,模式类似 Vue 3 组合式 API Setup。
const useAppStore = defineStore('app', () => { const counter = ref(0); function increment() { counter.value++; } const doubleCounter = computed(() => counter.value * 2); return { counter, increment, doubleCounter, }; });- 使用 Vue 的响应式 API (
ref,reactive,computed)。 - 操作和状态都在一个函数体内定义,极其自由灵活。
- 由于基于组合式 API,类型推断和逻辑复用更自然。
使用方式一样:
const appStore = useAppStore(); appStore.increment(); console.log(appStore.doubleCounter);
defineStore参数详细说明defineStore(id: string, options?: StoreOptions, setup?: () => StoreSetup);常用有两种形式:
defineStore(id: string, options: StoreOptions)— 选项式 API。defineStore(id: string, setup: () => StoreSetup)— 组合式 API。
参数
参数名 类型 说明 id string store 的唯一标识符 options 对象 Store 配置( state、getters、actions)setup 函数 返回要绑定的状态、函数、计算属性的组合式语法
defineStore返回值它返回一个函数,这个函数叫作「store hook」,通过调用它可以获取对应 store 实例。
const store = useAppStore();store对象包含:- 响应式
state - 基于状态派生的
getters(计算属性) - 用于修改状态/业务逻辑的
actions
重要特点总结
特点 说明 唯一 ID 必须给每个 store 一个唯一字符串 ID,Pinia 根据此决定 store 的身份 轻量且类型安全 支持 TypeScript 类型推断,且没有 Vuex 那样显著的样板代码 支持组合式和选项式 同时支持两种风格,方便逐渐迁移或选择喜欢的编码风格 基于 Vue 响应式 store 的状态是响应式的,自动触发视图更新 支持异步和普通方法 actions 既可同步修改 state,也可以做异步操作 自动持久化 结合其他库,如 useStorage可实现状态本地持久化可以在组件外使用 store实例可以在任何.ts文件中使用,方便业务逻辑复用
例子对比
选项式 API 组合式 API ts<br>const useCounterStore = defineStore('counter', {<br> state: () => ({ count: 0 }),<br> getters: { double: (state) => state.count * 2 },<br> actions: { increment() { this.count++ } }<br>});<br>ts<br>const useCounterStore = defineStore('counter', () => {<br> const count = ref(0);<br> const double = computed(() => count.value * 2);<br> function increment() { count.value++; }<br> return { count, double, increment };<br>});<br>
小结
defineStore是 Pinia 的核心 API,通过它你可以:- 定义全局响应式状态。
- 通过方法和计算属性封装业务逻辑。
- 方便维护和组织代码。
- 利用 Vue 3 响应式系统,无缝让组件响应状态改动。
- 类型支持良好,开发体验极佳。
你可以根据项目和喜好自由选择 选项式 API 或 组合式 API 风格,且两者混用无障碍。
如果你想要我针对
defineStore的任意具体点(比如类型推断、复杂用法、持久化方案等)做更细致的讲解,也可以告诉我!