预渲染

Nuxt 允许页面在构建时进行静态渲染，以改善某些性能或 SEO 指标

Nuxt 允许您的应用程序中的选定页面在构建时进行渲染。Nuxt 会在请求时提供预构建的页面，而不是即时生成它们。

在Nuxt 渲染模式中了解更多。

基于抓取的预渲染

使用 nuxt generate 命令使用 Nitro 爬虫构建和预渲染您的应用程序。此命令类似于设置了 nitro.static 选项为 true 的 nuxt build，或者运行 nuxt build --prerender。

这将构建您的网站，启动一个 Nuxt 实例，并且默认情况下，预渲染根页面 / 以及它链接到的任何网站页面，以及这些页面链接到的任何网站页面，依此类推。

npx nuxt generate

您现在可以将 .output/public 目录部署到任何静态托管服务，或者使用 npx serve .output/public 在本地预览。

Nitro 爬虫的工作原理

  1. 加载应用程序根路由 (/) 的 HTML，~/pages 目录中任何非动态页面，以及 nitro.prerender.routes 数组中的任何其他路由。
  2. 将 HTML 和 payload.json 保存到 ~/.output/public/ 目录，以便静态提供。
  3. 在 HTML 中查找所有锚点标签 (<a href="...">) 以导航到其他路由。
  4. 对找到的每个锚点标签重复步骤 1-3，直到没有更多锚点标签可抓取。

理解这一点很重要，因为未链接到可发现页面的页面无法自动预渲染。

阅读更多关于 nuxt generate 命令。

选择性预渲染

您可以在 nuxt.config 文件中手动指定 Nitro 将在构建期间获取和预渲染的路由，或忽略您不想预渲染的路由，例如 /dynamic。

nuxt.config.ts
export default defineNuxtConfig({
  nitro: {
    prerender: {
      routes: ['/user/1', '/user/2'],
      ignore: ['/dynamic'],
    },
  },
})

您可以将其与 crawlLinks 选项结合使用，以预渲染爬虫无法发现的一组路由，例如您的 /sitemap.xml 或 /robots.txt。

nuxt.config.ts
export default defineNuxtConfig({
  nitro: {
    prerender: {
      crawlLinks: true,
      routes: ['/sitemap.xml', '/robots.txt'],
    },
  },
})

将 nitro.prerender 设置为 true 类似于将 nitro.prerender.crawlLinks 设置为 true。

在 Nitro 文档中了解更多关于预渲染的信息。

最后，您可以使用 routeRules 手动配置此项。

nuxt.config.ts
export default defineNuxtConfig({
  routeRules: {
    // Set prerender to true to configure it to be prerendered
    '/rss.xml': { prerender: true },
    // Set it to false to configure it to be skipped for prerendering
    '/this-DOES-NOT-get-prerendered': { prerender: false },
    // Everything under /blog gets prerendered as long as it
    // is linked to from another page
    '/blog/**': { prerender: true },
  },
})
阅读更多关于 Nitro 的 routeRules 配置。

作为简写，您也可以在页面文件中使用 defineRouteRules 进行配置。

此功能是实验性的，要使用它，您必须在 nuxt.config 中启用 experimental.inlineRouteRules 选项。
app/pages/index.vue
<script setup>
// Or set at the page level
defineRouteRules({
  prerender: true,
})
</script>

<template>
  <div>
    <h1>Homepage</h1>
    <p>Pre-rendered at build time</p>
  </div>
</template>

这将被翻译为

nuxt.config.ts
export default defineNuxtConfig({
  routeRules: {
    '/': { prerender: true },
  },
})

运行时预渲染配置

prerenderRoutes

您可以在 Nuxt 上下文中在运行时使用此功能，为 Nitro 添加更多要预渲染的路由。

app/pages/index.vue
<script setup>
prerenderRoutes(['/some/other/url'])
prerenderRoutes('/api/content/article/my-article')
</script>

<template>
  <div>
    <h1>This will register other routes for prerendering when prerendered</h1>
  </div>
</template>
在prerenderRoutes中了解更多。

prerender:routes Nuxt 钩子

这在预渲染之前调用，用于注册附加路由。

nuxt.config.ts
export default defineNuxtConfig({
  hooks: {
    async 'prerender:routes' (ctx) {
      const { pages } = await fetch('https://api.some-cms.com/pages').then(
        res => res.json(),
      )
      for (const page of pages) {
        ctx.routes.add(`/${page.name}`)
      }
    },
  },
})

prerender:generate Nitro 钩子

这在预渲染期间为每个路由调用。您可以使用它来对每个预渲染的路由进行细粒度处理。

nuxt.config.ts
export default defineNuxtConfig({
  nitro: {
    hooks: {
      'prerender:generate' (route) {
        if (route.route?.includes('private')) {
          route.skip = true
        }
      },
    },
  },
})