【vue】Pinia-2 安装Pinia,使用store

在这里插入图片描述

1. 安装Pinia

在项目路径下执行npm install pinia

在这里插入图片描述
package.json中查看

在这里插入图片描述

2. 使用store

main.js中添加

import { createPinia } from 'pinia'
const pinia = createPinia()

修改createApp方法
最后示例如下(三处修改)

import { createApp } from 'vue'
//修改1
import { createPinia } from 'pinia'

import App from './App.vue'

//修改2
const pinia = createPinia()

// createApp(App).mount('#app')
//修改3
const app = createApp(App)
app.use(pinia)
app.mount('#app')

在这里插入图片描述

在这里插入图片描述

程序

stores/web.js

import { reactive,ref } from "vue";
import { defineStore } from "pinia";



//命名规范:前面加use,后面加Store
export const useWebStore = defineStore("web", ()=>{
    const web = reactive({
        title: "abcdfg",
        url: "https://www.abcdfg.com",
    })

    const users = ref(1000)
    
    const userAdd=()=>{
        users.value+=1
    }

    return {
        web,
        users,
        userAdd
    }
});



App.vue

<template>
  <p>{{ webStore.web.title }} </p>
  <p>{{ webStore.web.url }} </p>
  <p>{{ webStore.users }} </p>


  <button @click="webStore.userAdd()">Add User</button>

</template>

<script setup>
import { reactive, ref, toRef, toRefs } from 'vue';
import { useWebStore } from './stores/web';


const webStore = useWebStore()

console.log(webStore.web)
console.log(webStore.users)

</script>

<style lang="scss" scoped></style>

参考

https://www.bilibili.com/video/BV1nV411Q7RX

<think>我们正在处理一个关于在Vue3中使用Pinia和其持久化插件pinia-plugin-persistedstate的问题。根据引用内容,我们可以整理出以下步骤: 目标:在Vue3项目中使用Pinia进行状态管理,并使用pinia-plugin-persistedstate插件实现状态持久化。 步骤: 1. 安装必要的包:piniapinia-plugin-persistedstate。 2. 创建一个pinia实例,并将插件添加到该实例上。 3. 在定义store时,通过设置`persist: true`来启用持久化。 4. 在main.ts(或main.js)中将pinia实例挂载到Vue应用上。 5. 在组件中使用store。 另外,引用中提到了在uni-app等环境中可能需要自定义存储方式(如使用uni-app的存储API),但一般情况下在浏览器中默认使用localStorage。 根据引用[4],注意不要使用已经废弃的pinia-plugin-persist,而应使用pinia-plugin-persistedstate。 现在,我们按照步骤详细说明: ### 1. 安装 ```bash npm install pinia pinia-plugin-persistedstate # 或者 yarn add pinia pinia-plugin-persistedstate # 或者 pnpm add pinia pinia-plugin-persistedstate ``` ### 2. 创建和配置Pinia实例 在项目的入口文件(如main.ts或main.js)中: ```typescript import { createApp } from 'vue' import { createPinia } from 'pinia' import piniaPluginPersistedstate from 'pinia-plugin-persistedstate' import App from './App.vue' // 创建Pinia实例 const pinia = createPinia() // 使用持久化插件 pinia.use(piniaPluginPersistedstate) const app = createApp(App) app.use(pinia) app.mount('#app') ``` ### 3. 定义Store并启用持久化 在store文件中(例如src/store/user.ts): ```typescript import { defineStore } from 'pinia' import { ref } from 'vue' export const useUserStore = defineStore('user', () => { const token = ref('') const username = ref('') function setUserInfo(newToken: string, newUsername: string) { token.value = newToken username.value = newUsername } return { token, username, setUserInfo } }, { persist: true // 开启持久化 }) ``` ### 4. 在组件中使用Vue组件中,你可以像这样使用store: ```vue <script setup lang="ts"> import { useUserStore } from '@/store/user' const userStore = useUserStore() // 设置用户信息 userStore.setUserInfo('token123', 'John Doe') // 直接访问状态 console.log(userStore.token) // 输出 'token123' </script> <template> <div> <p>用户名: {{ userStore.username }}</p> </div> </template> ``` ### 自定义持久化配置(可选) 如果你需要自定义存储方式(比如在uni-app中使用uni.setStorageSync),可以在创建pinia插件时传入配置。例如,根据引用[3]的示例: ```typescript // 在创建pinia实例的地方(如单独的pinia.ts文件) import { createPinia } from 'pinia' import { createPersistedState } from 'pinia-plugin-persistedstate' const pinia = createPinia() pinia.use(createPersistedState({ storage: { getItem(key: string): string | null { // 使用uni-app的存储API return uni.getStorageSync(key) }, setItem(key: string, value: string) { uni.setStorageSync(key, value) } } })) export default pinia ``` 然后在main.ts中引入这个配置好的pinia实例。 ### 注意事项 - 默认情况下,持久化的数据会存储在localStorage中,key为store的id(如上面例子中的'user')。 - 如果需要进一步配置(如指定要持久化的字段、使用sessionStorage等),可以在定义store时传入一个对象而不是布尔值。例如: ```typescript persist: { storage: sessionStorage, // 使用sessionStorage paths: ['token'] // 只持久化token字段 } ``` -使用组合式API定义store(setup语法)时,注意返回的状态必须是需要持久化的状态。 ### 验证持久化效果 在浏览器中,打开开发者工具,进入Application选项卡,在Local Storage部分可以看到以store id为键存储的数据。 ### 常见问题 - 如果遇到类型错误(如引用[4]中的重载错误),请确保安装的是`pinia-plugin-persistedstate`而不是其他插件。 - 在SSR(服务器端渲染)环境中,需要谨慎使用,因为localStorage在服务器端不可用。 通过以上步骤,你应该能够在Vue3项目中成功使用Piniapinia-plugin-persistedstate实现状态持久化。 ### 相关问题 1. 如何在Pinia持久化时指定存储的key? 2. 如何避免某些字段被持久化? 3.Vue3的setup语法中如何正确使用Pinia store? 4. 如何重置Pinia store的持久化数据? 5. 在TypeScript项目中如何为Pinia store提供类型支持? [^1]: Vue3基本使用PiniaPiniavuex的区别 pinia的基本使用 Pinia状态持久化 pinia-plugin-persistedstate的... [^2]: 在vue3组合式API中使用pinia-plugin-persistedstate持久化存储pinia的state [^3]: vue3 使用 piniapinia-plugin-persistedstate 持久化数据管理 [^4]: vue3+vite+pinia+pinia-plugin-persistedstate持久化存储</think># 在 Vue3 中使用 Piniapinia-plugin-persistedstate 实现状态持久化 下面是如何在 Vue3 项目中完整使用 Pinia 状态管理库及其持久化插件 pinia-plugin-persistedstate 的详细指南: ## 安装依赖 首先安装必要的依赖包: ```bash npm install pinia pinia-plugin-persistedstate # 或使用 yarn yarn add pinia pinia-plugin-persistedstate # 或使用 pnpm pnpm add pinia pinia-plugin-persistedstate ``` ## 配置 Pinia 和持久化插件 ### 1. 创建 Pinia 实例并添加插件 在 `src/main.ts` 文件中配置: ```typescript import { createApp } from 'vue' import { createPinia } from 'pinia' import piniaPluginPersistedstate from 'pinia-plugin-persistedstate' import App from './App.vue' // 创建 Pinia 实例 const pinia = createPinia() // 添加持久化插件 pinia.use(piniaPluginPersistedstate) const app = createApp(App) // 使用 Pinia app.use(pinia) app.mount('#app') ``` ### 2. 创建 Store 并启用持久化 在 `src/store/userStore.ts` 中定义 store: ```typescript import { defineStore } from 'pinia' import { ref, computed } from 'vue' export const useUserStore = defineStore('user', () => { // 用户状态 const token = ref(localStorage.getItem('token') || '') const userInfo = ref({ id: '', name: '访客', email: '', avatar: '', }) // 计算属性 const isLoggedIn = computed(() => !!token.value) // 登录操作 function login(userData: any) { token.value = userData.token userInfo.value = userData } // 登出操作 function logout() { token.value = '' userInfo.value = { id: '', name: '访客', email: '', avatar: '' } } return { token, userInfo, isLoggedIn, login, logout } }, { // 启用持久化 persist: true }) ``` ## 自定义持久化配置(可选) 如果需要自定义存储方式(如在 uni-app 中使用 uniStorage): ```typescript // src/stores/pinia.ts import { createPinia } from 'pinia' import { createPersistedState } from 'pinia-plugin-persistedstate' export const pinia = createPinia() pinia.use(createPersistedState({ storage: { getItem: (key: string) => { return uni.getStorageSync(key) }, setItem: (key: string, value: string) => { uni.setStorageSync(key, value) }, removeItem: (key: string) => { uni.removeStorageSync(key) } } })) // 然后在 main.ts 中导入并使用这个配置好的 pinia 实例 ``` ## 在组件中使用 StoreVue 组件中使用定义好的 store: ```vue <script setup lang="ts"> import { useUserStore } from '@/stores/userStore' const userStore = useUserStore() // 登录操作 const handleLogin = () => { userStore.login({ token: 'abc123xyz', id: 'user001', name: '张三', email: 'zhangsan@example.com', avatar: '/avatar.png' }) } // 登出操作 const handleLogout = () => { userStore.logout() } </script> <template> <div v-if="userStore.isLoggedIn"> <h2>欢迎, {{ userStore.userInfo.name }}</h2> <img :src="userStore.userInfo.avatar" alt="头像" /> <button @click="handleLogout">退出登录</button> </div> <div v-else> <button @click="handleLogin">登录</button> </div> </template> ``` ## 高级配置选项 在定义 store 时,可以配置更详细的持久化选项: ```typescript export const useSettingsStore = defineStore('settings', () => { const theme = ref('light') const fontSize = ref(16) const notifications = ref(true) return { theme, fontSize, notifications } }, { persist: { // 只持久化指定字段 paths: ['theme', 'fontSize'], // 自定义存储键名 key: 'app-settings', // 使用 sessionStorage 替代 localStorage storage: sessionStorage, // 自定义序列化和反序列化方法 serialize: JSON.stringify, deserialize: JSON.parse, // 在恢复状态前执行钩子 beforeRestore: (ctx) => { console.log(`即将恢复状态: ${ctx.store.$id}`) }, // 在恢复状态后执行钩子 afterRestore: (ctx) => { console.log(`状态恢复完成: ${ctx.store.$id}`) } } }) ``` ## 常见问题解决 1. **类型错误问题**: - 确保使用正确的包名:`pinia-plugin-persistedstate` - 不要使用已废弃的 `pinia-plugin-persist` - 如果遇到类型错误,尝试更新 TypeScript 和 Vue 相关依赖 2. **SSR 兼容问题**: ```typescript // 在 SSR 环境中安全使用 persist: { storage: typeof window !== 'undefined' ? localStorage : null } ``` 3. **状态更新未触发持久化**: - 确保直接修改状态属性(如 `userStore.token = 'new'`) - 避免直接替换整个状态对象 ## 持久化原理 pinia-plugin-persistedstate 的工作流程: 1.store 初始化时,从存储中读取并恢复状态 2. 监听 store 的变化 3. 当状态变化时,将新状态序列化后存入存储 4. 在页面加载时,从存储中读取并恢复状态 ## 相关资源 - [Pinia 官方文档](https://pinia.vuejs.org/) - [pinia-plugin-persistedstate 文档](https://prazdevs.github.io/pinia-plugin-persistedstate/) --- ### 相关问题 1. PiniaVuex 有哪些主要区别? 2. 如何在 Pinia 中处理异步操作? 3. 如何实现 Pinia store 之间的相互调用? 4. 在 SSR 应用中如何安全使用 Pinia 持久化? 5. 如何为 Pinia store 添加 TypeScript 类型支持? > 示例代码基于引用内容[^1][^2][^3][^4]实现,展示了在 Vue3 中使用 Pinia 和持久化插件的最佳实践。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值