nuxt logo

文档翻译(非官方)

useNuxtData

访问数据获取组合函数的当前缓存值。

useNuxtData 允许你访问 useAsyncDatauseLazyAsyncDatauseFetchuseLazyFetch 的当前缓存值,需提供明确的键。

用法

useNuxtData 组合函数用于访问诸如 useAsyncDatauseLazyAsyncDatauseFetchuseLazyFetch 等数据获取组合函数的当前缓存值。通过提供数据获取时使用的键,你可以检索缓存的数据并根据需要使用它。

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

要使用 useNuxtData,请确保数据获取组合函数(useFetchuseAsyncData 等)已使用明确提供的键调用。

参数

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

返回值

  • data: 与提供的键关联的缓存数据的响应式引用。如果不存在缓存数据,值将为 null。如果缓存数据发生变化,此 Ref 会自动更新,从而在组件中实现无缝响应性。

示例

下面的示例展示了如何在从服务器获取最新数据时使用缓存数据作为占位符。

pages/posts.vue
// 我们可以稍后使用 'posts' 键访问相同的数据
const { data } = await useFetch('/api/posts', { key: 'posts' })
pages/posts/[id\
// 访问 posts.vue(父路由)中 useFetch 的缓存值
const { data: posts } = useNuxtData('posts')

const route = useRoute()

const { data } = useLazyFetch(`/api/posts/${route.params.id}`, {
  key: `post-${route.params.id}`,
  default() {
    // 从缓存中找到单个帖子并将其设置为默认值。
    return posts.value.find(post => post.id === route.params.id)
  }
})

乐观更新

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

乐观更新是一种技术,其中用户界面立即更新,假设服务器操作将成功。如果操作最终失败,UI 将回滚到其先前状态。

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

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

async function addTodo () {
  return $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')
    }
  })
}

类型

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