useNuxtData v3.1

源码
访问数据获取组合式函数当前缓存的值。
useNuxtData 让你可以通过明确提供的键，访问 useAsyncData、useLazyAsyncData、useFetch 和 useLazyFetch 当前缓存的值。

用法

useNuxtData 组合式函数用于访问数据获取组合式函数（例如 useAsyncData、useLazyAsyncData、useFetch 和 useLazyFetch）当前缓存的值。通过提供数据获取时使用的键，你可以检索缓存数据，并按需使用。

这对于通过重用已获取的数据来优化性能，或实现乐观更新、级联数据更新等功能尤其有用。

要使用 useNuxtData，请确保数据获取组合式函数（useFetch、useAsyncData 等）调用时使用了明确提供的键。

类型

Signature
export function useNuxtData<DataT = any> (key: string): { data: Ref<DataT | undefined> }

参数

  • key：标识缓存数据的唯一键。此键应与原始数据获取时使用的键匹配。

返回值

  • data：关联到所提供键的缓存数据的响应式引用。如果不存在缓存数据，则该值将为 undefined。当缓存数据发生变化时，此 Ref 会自动更新，从而让组件中的响应式表现无缝衔接。

示例

以下示例展示了如何在从服务器获取最新数据时，将缓存数据用作占位内容。

app/pages/posts.vue
<script setup lang="ts">
// We can use the 'posts' key to access the same data later
const { data } = await useFetch('/api/posts', { key: 'posts' })
</script>
app/pages/posts/[id].vue
<script setup lang="ts">
// Access the cached value of useFetch in posts.vue (parent route)
const { data: posts } = useNuxtData('posts')

const route = useRoute()

const { data } = useLazyFetch(`/api/posts/${route.params.id}`, {
  key: `post-${route.params.id}`,
  default () {
    // Find a single post in the cache and set it as the default value.
    return posts.value.find(post => post.id === route.params.id)
  },
})
</script>

乐观更新

下面的示例展示了如何使用 useNuxtData 实现乐观更新（Optimistic Updates）。

乐观更新是一种技术，界面会立即更新，假设服务器操作会成功。如果操作最终失败，则界面会回滚到先前状态。

app/pages/todos.vue
<script setup lang="ts">
// 我们可以使用 'todos' 键在稍后访问相同的数据
const { data } = await useAsyncData('todos', (_nuxtApp, { signal }) => $fetch('/api/todos', { signal }))
</script>
app/components/NewTodo.vue
<script setup lang="ts">
const newTodo = ref('')
let previousTodos = []

// 访问 todos.vue 中 useAsyncData 的缓存值
const { data: todos } = useNuxtData('todos')

async function addTodo () {
  await $fetch('/api/addTodo', {
    method: 'post',
    body: {
      todo: newTodo.value,
    },
    onRequest () {
      // 存储之前的缓存值，以便在请求失败时恢复。
      previousTodos = todos.value

      // 乐观地更新 todos。
      todos.value = [...todos.value, newTodo.value]
    },
    onResponseError () {
      // 如果请求失败，则回滚数据。
      todos.value = previousTodos
    },
    async onResponse () {
      // 如果请求成功，则在后台使 todos 失效（重新获取）。
      await refreshNuxtData('todos')
    },
  })
}
</script>