Pinia 入门 for vuex 开发者

官方给出的理由是:API 更简单、更简洁,对 TypeScript 更友好

  • 没 mutations
  • 没 名称空间,但有模块概念
  • TypeScript 类型支持无需额外 warps 支持
  • 存储默认为动态的
  • 不再嵌套模块结构

Vue < 2.7 需要单独设置

// 基本用法
import { createPinia, defineStore } from 'pinia';
// 初始化
app.use(createPinia());

// 定义一相模块
export const useSomeModuleStore = defineStore('someModule', {
  state: () => ({ count: 0 }),
  getters: {
    double: (state) => state.count * 2,
  },
  actions: {
    increment() {
      this.count++;
    },
  },
});

// or
defineStore('someModule', () => {
  const count = ref(0);
  const double = computed(() => store.doubleCount);
  function increment() {
    count.value++;
  }

  return { count, double, increment };
});

// use
const store = useSomeModuleStore();
console.log('store.count', store.count++);
// 重置
store.$reset();
// 同时修改多个属性
store.$patch({ count: store.count + 1 });
// 复杂属性
store.$patch((state) => {
  state.items.push({ name: 'shoes', quantity: 1 });
});
// ❌ 解构会破坏它的响应式
const { count } = store;
// ✅ 但这样可以
const { count } = storeToRefs(store);

// 订阅
store.$subscribe((mutation, state) => {
  // 每当状态发生变化时,将整个 state 持久化到本地存储。
  localStorage.setItem('xxx', JSON.stringify(state));
});

访问其它模块的 state、getter 或 action 同在组件中访问它们一样

VUEX Pinia
根部 new Vue({store }) 注入 app.use(createPinia())
namespace defineStore('someModule', {...})
state state or someState = ref(x)
getters getters
mutations store.$patch(...)
actions actions
subscribe(监听 mutation 调用) store.$subscribe 只能监听整体,非某个属性
this.$store.someModule.state.x const { x } = storeToRefs(useSomeModuleStore())
this.$store.someModule.getters.x 同上
this.$store.commit('xx') const { xx } = useSomeModuleStore(); xx()
this.$store.dispatch('xx') 同上

Plugins

function SecretPiniaPlugin() {
  // 添加全局状态 secret
  return { secret: 'the cake is a lie' };
}

const pinia = createPinia();
// 将该插件交给 Pinia
pinia.use(SecretPiniaPlugin);
app.use(pinia);

// 在另一个文件中
someStore.secret; // 'the cake is a lie'
// d.ts
pinia.use(plugin: PiniaPlugin): Pinia;
PiniaPlugin = (context: PiniaPluginContext) => object | void
PiniaPluginContext = {
  pinia: Pinia;
  app: App;
  // 该插件想扩展的 store
  store: Store<Id, S, G, A>;
  // 定义传给 `defineStore()` 的 store 的可选对象。
  options: DefineStoreOptionsInPlugin<Id, S, G, A>;
}

添加外部属性、第三方库的类实例或非响应式的简单值时,

import { markRaw } from 'vue';
// 根据你的路由器的位置来调整
import { router } from './router';

pinia.use(({ store }) => {
  store.router = markRaw(router);
});
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,468评论 5 473
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,620评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,427评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,160评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,197评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,334评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,775评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,444评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,628评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,459评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,508评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,210评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,767评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,850评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,076评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,627评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,196评论 2 341

推荐阅读更多精彩内容