Pinia入門學習之實現簡單的使用者狀態管理

import { defineStore } from 'pinia'

// 第一個引數是應用程式中 store 的唯一 id
export const useUserStore = defineStore('user', {
  // other options...
})

import { useUserStore } from '@/stores/user'

export default {
  setup() {
    const userStore = useUserStore()

    return {
      // 您可以返回整個 store 範例以在模板中使用它
      userStore,
    }
  },
}

import { storeToRefs } from 'pinia'

export default defineComponent({
  setup() {
    const userStore = useUserStore()
    // ❌ 這不起作用，因為它會破壞響應式
    // 這和從 props 解構是一樣的
    const { userName } = userStore
    
    // 這樣可以保持響應式
    const { userId } = storeToRefs(userStore)

    userName // "lucio"
    userId // "001"

    return {
      // 一直會是 "lucio"
      userName,
      // 這將是響應式的
      userId,
      // 這將是響應式的
      realUserName: computed(() => userStore.userName),
      }
  },
})

import { defineStore } from 'pinia'

// 第一個引數是應用程式中 store 的唯一 id
export const useUserStore = defineStore('user', {
  state: () => {
    return {
      // 所有這些屬性都將自動推斷其型別
      userName: 'lucio',
      userId: '001',
    }
  },
})

const userStore = useUserStore()
userStore.userId = '002'
userStore.$reset()
return { userStore }

// 一次修改多個資料
userStore.$patch({
  userId: '002',
  userName: 'lucy',
})
// 適合對陣列進行修改
userStore.$patch((state) => {
  state.roles.push({ name: 'admin', priority: 1 })
})

userStore.$state = { userId: '002', userName: 'lucy'}
// 或者通過pinia範例替換整個應用程式的狀態
pinia.state.value = {}

userStore.$subscribe((mutation, state) => {
  // import { MutationType } from 'pinia'
  mutation.type // 'direct' | 'patch object' | 'patch function'
  // 與 userStore.$id 相同
  mutation.storeId // 'user'
  // 僅適用於 mutation.type === 'patch object'
  mutation.payload // 修補程式物件傳遞給 to userStore.$patch()

  // 每當它發生變化時，將整個狀態持久化到本地儲存
  localStorage.setItem('user', JSON.stringify(state))
	},
	{ detached: true }, // detached為true，解除安裝元件後保留訂閱
)

import { defineStore } from 'pinia'

// 第一個引數是應用程式中 store 的唯一 id
export const useUserStore = defineStore('user', {
  state: () => {
    return {
      // 所有這些屬性都將自動推斷其型別
      userName: 'lucio',
      userId: '001',
    }
  },
  getters: {
    // 自動推斷返回型別為字串
    userText: (state) => `User: ${state.userName}`,
    // 也可以使用其他getter, 用this存取store範例，必須要定義返回型別
    userTextPlus: (): string => `The name of ${this.userText}`,
  }
})

userStore.userText

import { defineStore } from 'pinia'

export const useUserStore = defineStore('user', {
  state: () => {
    return {
      userName: 'lucio',
      userId: '001',
      userData: null,
    }
  },
  getters: {
    // ...
  },
  actions: {
  	async loginAndGetUserInfo(password) {
  		try {
  			this.userData = await api.login({password});
  			showToast('Login success');
  		} catch(error) {
  			showToast(error);
  			return error;
  		}
  	}
  }
})

const unsubscribe = userStore.$onAction(
  ({
    name, // action 的名字
    store, // store 範例
    args, // 呼叫這個 action 的引數
    after, // 在這個 action 執行完畢之後，執行這個函數
    onError, // 在這個 action 丟擲異常的時候，執行這個函數
  }) => {
    // 記錄開始的時間變數
    const startTime = Date.now()
    // 這將在 `store` 上的操作執行之前觸發
    console.log(`Start "${name}" with params [${args.join(', ')}].`)

    // 如果 action 成功並且完全執行後，after 將觸發。
    // 它將等待任何返回的 promise
    after((result) => {
      console.log(
        `Finished "${name}" after ${
          Date.now() - startTime
        }ms.nResult: ${result}.`
      )
    })

    // 如果 action 丟擲或返回 Promise.reject ，onError 將觸發
    onError((error) => {
      console.warn(
        `Failed "${name}" after ${Date.now() - startTime}ms.nError: ${error}.`
      )
    })
  }
)

// 手動移除訂閱
unsubscribe()

export default {
  setup() {
    const someStore = useSomeStore()

    // 此訂閱將在元件解除安裝後保留
    someStore.$onAction(callback, true)

    // ...
  },
}