Lzh on GitHub

数据管理

Nuxt 提供了强大的状态管理库和 useState composable 来创建响应式且 SSR 友好的共享状态。

Nuxt 提供了 useState composable，用于在组件之间创建响应式且 SSR 友好的共享状态。

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

由于 useState 中的数据将被序列化为 JSON，因此重要的是它不包含任何无法序列化的内容，例如类、函数或 symbols。

阅读更多关于 useState composable 的信息。

最佳实践

切勿在 <script setup> 或 setup() 函数之外定义 const state = ref()。
例如，执行 export myState = ref({}) 会导致服务器上的请求之间共享状态，并可能导致内存泄漏。
SSR 运行机制： Nuxt 服务端在单进程处理多个请求，若状态定义在模块作用域（即文件顶层，Node.js 会缓存模块的导出对象，导致每次导入 sharedState 都返回同一引用），则所有请求共享同一 sharedState 实例。
后果：
  • 状态泄漏：用户 A 的数据被用户 B 的请求覆盖
  • 内存泄漏：持续累积的全局状态无法被 GC 回收
  • 数据污染：敏感信息可能暴露给其他用户
而是使用 const useX = () => useState('x')

示例

基本用法

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

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>
要全局使缓存状态失效，请参阅 clearNuxtState 工具。

初始化状态

大多数时候，您需要使用异步解析的数据初始化您的状态。您可以将 app.vue 组件与 callOnce 工具一起使用来完成此操作。

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 > API > Utils > Call Once.

与 Pinia 一起使用

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

请务必使用 npx nuxi@latest 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)))
}

共享状态

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

composables/states.ts
export const useColor = () => useState<string>('color', () => 'pink')
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 - 状态机方法，带有可视化和测试状态逻辑的工具