组件选项

asyncData 和 fetch

Nuxt 3 为 从 API 获取数据 提供了新的选项。

同构 Fetch

在 Nuxt 2 中你可能会使用 @nuxtjs/axios 或 @nuxt/http 来获取数据，或者直接使用被 polyfill 的全局 fetch。

在 Nuxt 3 中，你可以使用全局可用的 fetch 方法（其 API 与 Fetch API 相同），也可以使用基于 unjs/ofetch 的 $fetch 方法。它具有多项优点，包括：

1. 如果在服务器端运行，它会“智能地”进行直接 API 调用；如果在客户端运行，则会发起客户端到你 API 的调用。（它也可以处理调用第三方 API。）
2. 并且，它提供了一些便捷功能，包括自动解析响应和将数据序列化为字符串等。

你可以阅读更多关于 直接 API 调用 或 获取数据 的内容。

组合式函数

Nuxt 3 提供了用于获取数据的新组合式函数：useAsyncData 和 useFetch。它们各自都有“懒加载”变体（useLazyAsyncData 和 useLazyFetch），这些变体不会阻塞客户端导航。

在 Nuxt 2 中，你会在组件中使用类似下面的语法来获取数据：

export default {
  async asyncData ({ params, $http }) {
    const post = await $http.$get(`https://api.nuxtjs.dev/posts/${params.id}`)
    return { post }
  },
  // or alternatively
  fetch () {
    this.post = await $http.$get(`https://api.nuxtjs.dev/posts/${params.id}`)
  },
}

在你的方法和模板中，你可以像使用组件提供的其他数据一样使用 post 变量。

在 Nuxt 3 中，你可以在 setup() 方法或 <script setup> 标签中使用组合式函数来执行此数据获取：

<script setup lang="ts">
// Define params wherever, through `defineProps()`, `useRoute()`, etc.
const { data: post, refresh } = await useAsyncData('post', () => $fetch(`https://api.nuxtjs.dev/posts/${params.id}`))
// Or instead - useFetch is a convenience wrapper around useAsyncData when you're just performing a simple fetch
const { data: post, refresh } = await useFetch(`https://api.nuxtjs.dev/posts/${params.id}`)
</script>

你现在可以在 Nuxt 3 的模板中使用 post，或调用 refresh 来更新数据。

迁移

1. 在页面/组件中将 asyncData 钩子替换为 useAsyncData 或 useFetch。
2. 在组件中将 fetch 钩子替换为 useAsyncData 或 useFetch。

head

key

你现在可以在 definePageMeta 编译宏中定义一个 key。

- <script>
- export default {
-   key: 'index'
-   // or a method
-   // key: route => route.fullPath
- }
+ <script setup>
+ definePageMeta({
+   key: 'index'
+   // or a method
+   // key: route => route.fullPath
+ })
</script>

layout

loading

此功能在 Nuxt 3 中尚不受支持。

middleware

scrollToTop

此功能在 Nuxt 3 中尚不受支持。如果你想覆盖 vue-router 的默认滚动行为，可以在 ~/router.options.ts 中进行配置（更多信息见 文档）。 与 key 类似，在 definePageMeta 编译宏中指定它。

- <script>
- export default {
-   scrollToTop: false
- }
+ <script setup>
+ definePageMeta({
+   scrollToTop: false
+ })
</script>

transition

validate

Nuxt 3 中的 validate 钩子只接受单个参数，即 route。与 Nuxt 2 一样，你可以返回布尔值。如果返回 false 且无法找到其他匹配项，则会导致 404。你也可以直接返回带有 statusCode/statusMessage 的对象以立即响应错误（不会检查其他匹配项）。

- <script>
- export default {
-   async validate({ params }) {
-     return /^\d+$/.test(params.id)
-   }
- }
+ <script setup>
+ definePageMeta({
+   validate: async (route) => {
+     const nuxtApp = useNuxtApp()
+     return /^\d+$/.test(route.params.id)
+   }
+ })
  </script>

watchQuery

在 Nuxt 3 中不支持此功能。相反，你可以直接使用一个 watcher 来触发数据的重新获取。

<script setup lang="ts">
const route = useRoute()
const { data, refresh } = await useFetch('/api/user')
watch(() => route.query, () => refresh())
</script>