预渲染

Nuxt 允许在构建时静态渲染页面,以提高某些性能或 SEO 指标

Nuxt 允许从应用程序中选择页面进行构建时渲染。Nuxt 在请求时将提供预构建的页面,而不是动态生成它们。

Read more in Nuxt 渲染模式.

基于爬虫的预渲染

使用 nuxi generate 命令 来使用 Nitro 爬虫构建和预渲染你的应用程序。此命令类似于将 nitro.static 选项设置为 truenuxt build,或运行 nuxt build --prerender

这将构建你的网站,启动一个 nuxt 实例,并默认预渲染根页面 / 以及其链接的任何页面、这些页面链接的任何页面,等等。

npx nuxi generate

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

Nitro 爬虫的工作原理:

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

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

阅读有关 nuxi generate 命令的更多信息。

选择性预渲染

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

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
: {
// 将 prerender 设置为 true 以配置其为预渲染 "/rss.xml": {
prerender
: true },
// 将其设置为 false 以配置跳过预渲染 "/this-DOES-NOT-get-prerendered": {
prerender
: false },
// 在 /blog 下的所有内容都会被预渲染,只要它 // 是从其他页面链接的 "/blog/**": {
prerender
: true },
}, });
了解有关 Nitro 的 routeRules 配置的更多信息。

作为简写,你还可以在页面文件中使用 defineRouteRules 配置此选项。

此功能为实验性质,使用前必须在 nuxt.config 中启用 experimental.inlineRouteRules 选项。
pages/index.vue
<script setup>
// 或在页面级别设置
defineRouteRules({
  prerender: true,
});
</script>

<template>
  <div>
    <h1>首页</h1>
    <p>在构建时预渲染</p>
  </div>
</template>

这将转化为:

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

运行时预渲染配置

prerenderRoutes

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

pages/index.vue
<script setup>
prerenderRoutes(["/some/other/url"]);
</script>

<template>
  <div>
    <h1>这将在预渲染时注册其他路由</h1>
  </div>
</template>
Read more in prerenderRoutes.

prerender:routes Nuxt 钩子

在预渲染之前调用此钩子以注册额外的路由。

nitro.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 钩子

在预渲染过程中为每个路由调用此钩子。你可以用它来细致处理每个被预渲染的路由。

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