状态管理

Nuxt 提供强大的状态管理库和 useState 可组合函数以创建响应式且对 SSR 友好的共享状态。

Nuxt 提供了 useState 可组合函数，用于在组件之间创建响应式且对服务器端渲染（SSR）友好的共享状态。

useState 是一个对 SSR 友好的 ref 替代品。它的值将在服务端渲染之后（在客户端 hydration 期间）被保留，并通过唯一键在所有使用它的组件间共享。

由于 useState 内的数据会被序列化为 JSON，因此它不应包含任何无法序列化的内容，例如类、函数或符号。
阅读有关 useState 可组合函数的更多内容。

最佳实践

切勿在 <script setup> 或 setup() 函数之外定义 const state = ref()。
例如，执行 export myState = ref({}) 会导致在服务器上的请求之间共享状态，并可能导致内存泄漏。
应改为使用 const useX = () => useState('x')

示例

基本用法

在此示例中，我们使用组件本地的计数器状态。任何其他使用 useState('counter') 的组件都会共享相同的响应式状态。

app/app.vue
<script setup lang="ts">
const counter = useState('counter', () => Math.round(Math.random() * 1000))
</script>

<template>
  <div>
    Counter: {{ counter }}
    <button @click="counter++">
      +
    </button>
    <button @click="counter--">
      -
    </button>
  </div>
</template>
Read and edit a live example in Docs > 4 X > Examples > Features > State Management.
要在全局使缓存状态失效，请参阅 clearNuxtState 工具。

初始化状态

大多数情况下，您会希望使用异步解析的数据来初始化状态。可以在 app.vue 组件中使用 callOnce 工具来实现。

app/app.vue
<script setup lang="ts">
const websiteConfig = useState('config')

await callOnce(async () => {
  websiteConfig.value = await $fetch('https://my-cms.com/api/website-config')
})
</script>
这类似于 Nuxt 2 中的 nuxtServerInit action，它允许在服务器端渲染页面之前填充 store 的初始状态。
Read more in Docs > 4 X > API > Utils > Call Once.

与 Pinia 一起使用

在此示例中，我们利用 Pinia 模块 创建一个全局 store 并在应用中使用它。

请确保使用 npx nuxt module add pinia 安装 Pinia 模块，或遵循该模块的安装步骤。
export const useWebsiteStore = defineStore('websiteStore', {
  state: () => ({
    name: '',
    description: '',
  }),
  actions: {
    async fetch () {
      const infos = await $fetch('https://api.nuxt.com/modules/pinia')

      this.name = infos.name
      this.description = infos.description
    },
  },
})

高级用法

import type { Ref } from 'vue'

export const useLocale = () => {
  return useState<string>('locale', () => useDefaultLocale().value)
}

export const useDefaultLocale = (fallback = 'en-US') => {
  const locale = ref(fallback)
  if (import.meta.server) {
    const reqLocale = useRequestHeaders()['accept-language']?.split(',')[0]
    if (reqLocale) {
      locale.value = reqLocale
    }
  } else if (import.meta.client) {
    const navLang = navigator.language
    if (navLang) {
      locale.value = navLang
    }
  }
  return locale
}

export const useLocales = () => {
  const locale = useLocale()
  const locales = ref([
    'en-US',
    'en-GB',
    // ...,
    'ja-JP-u-ca-japanese',
  ])
  if (!locales.value.includes(locale.value)) {
    locales.value.unshift(locale.value)
  }
  return locales
}

export const useLocaleDate = (date: Ref<Date> | Date, locale = useLocale()) => {
  return computed(() => new Intl.DateTimeFormat(locale.value, { dateStyle: 'full' }).format(unref(date)))
}
Read and edit a live example in Docs > 4 X > Examples > Advanced > Locale.

共享状态

通过使用自动导入的可组合函数，我们可以定义全局类型安全的状态并在整个应用中导入它们。

composables/states.ts
export const useColor = () => useState<string>('color', () => 'pink')
app/app.vue
<script setup lang="ts">
// ---cut-start---
const useColor = () => useState<string>('color', () => 'pink')
// ---cut-end---
const color = useColor() // Same as useState('color')
</script>

<template>
  <p>Current color: {{ color }}</p>
</template>

使用第三方库

Nuxt 过去曾依赖 Vuex 库来提供全局状态管理。如果您正在从 Nuxt 2 迁移，请参阅迁移指南。

Nuxt 对状态管理并不强制使用特定方案，因此请根据您的需求自由选择合适的解决方案。下面是与一些流行状态管理库的集成：

  • Pinia - Vue 官方推荐
  • Harlem - 不可变的全局状态管理
  • XState - 使用状态机的方法，并提供用于可视化和测试状态逻辑的工具