如何创建 Next.js 应用程序的静态导出

Next.js 允许以静态网站或单页应用程序（SPA）开始，之后可选择升级使用需要服务器的功能。

当运行 next build 时，Next.js 为每个路由生成一个 HTML 文件。通过将严格的 SPA 拆分为单独的 HTML 文件，Next.js 可以避免在客户端加载不必要的 JavaScript 代码，从而减小捆绑包大小并实现更快的页面加载。

由于 Next.js 支持这种静态导出，它可以部署并托管在任何能够提供 HTML/CSS/JS 静态资源的 Web 服务器上。

配置

要启用静态导出，请在 next.config.js 中更改输出模式：

next.config.js

/**
 * @type {import('next').NextConfig}
 */
const nextConfig = {
  output: 'export',
 
  // 可选：更改链接 `/me` -> `/me/` 并生成 `/me.html` -> `/me/index.html`
  // trailingSlash: true,
 
  // 可选：防止自动 `/me` -> `/me/`，而是保留 `href`
  // skipTrailingSlashRedirect: true,
 
  // 可选：更改输出目录 `out` -> `dist`
  // distDir: 'dist',
}
 
module.exports = nextConfig

运行 next build 后，Next.js 将创建一个包含应用程序的 HTML/CSS/JS 资源的 out 文件夹。

支持的功能

Next.js 的核心设计支持静态导出。

服务器组件

当你运行 next build 生成静态导出时，app 目录中使用的服务器组件将在构建期间运行，类似于传统的静态站点生成。

生成的组件将被渲染为初始页面加载的静态 HTML 和用于路由之间客户端导航的静态负载。使用静态导出时，你的服务器组件不需要任何更改，除非它们使用了动态服务器函数。

app/page.tsx

TypeScript

export default async function Page() {
  // 这个 fetch 将在 `next build` 期间在服务器上运行
  const res = await fetch('https://api.example.com/...')
  const data = await res.json()
 
  return <main>...</main>
}

客户端组件

如果你想在客户端执行数据获取，可以使用带有 SWR 的客户端组件来记忆请求。

app/other/page.tsx

TypeScript

'use client'
 
import useSWR from 'swr'
 
const fetcher = (url: string) => fetch(url).then((r) => r.json())
 
export default function Page() {
  const { data, error } = useSWR(
    `https://jsonplaceholder.typicode.com/posts/1`,
    fetcher
  )
  if (error) return 'Failed to load'
  if (!data) return 'Loading...'
 
  return data.title
}

由于路由转换在客户端发生，这表现得像传统的 SPA。例如，以下索引路由允许你在客户端导航到不同的帖子：

app/page.tsx

TypeScript

import Link from 'next/link'
 
export default function Page() {
  return (
    <>
      <h1>Index Page</h1>
      <hr />
      <ul>
        <li>
          <Link href="/post/1">Post 1</Link>
        </li>
        <li>
          <Link href="/post/2">Post 2</Link>
        </li>
      </ul>
    </>
  )
}

图像优化

通过在 next.config.js 中定义自定义图像加载器，可以在静态导出中使用 next/image 进行图像优化。例如，你可以使用 Cloudinary 等服务优化图像：

next.config.js

/** @type {import('next').NextConfig} */
const nextConfig = {
  output: 'export',
  images: {
    loader: 'custom',
    loaderFile: './my-loader.ts',
  },
}
 
module.exports = nextConfig

这个自定义加载器将定义如何从远程源获取图像。例如，以下加载器将构建 Cloudinary 的 URL：

my-loader.ts

TypeScript

export default function cloudinaryLoader({
  src,
  width,
  quality,
}: {
  src: string
  width: number
  quality?: number
}) {
  const params = ['f_auto', 'c_limit', `w_${width}`, `q_${quality || 'auto'}`]
  return `https://res.cloudinary.com/demo/image/upload/${params.join(
    ','
  )}${src}`
}

然后，你可以在应用程序中使用 next/image，定义 Cloudinary 中图像的相对路径：

app/page.tsx

TypeScript

import Image from 'next/image'
 
export default function Page() {
  return <Image alt="turtles" src="/turtles.jpg" width={300} height={300} />
}

路由处理程序

路由处理程序在运行 next build 时将渲染静态响应。仅支持 GET HTTP 动词。这可用于从缓存或未缓存的数据生成静态 HTML、JSON、TXT 或其他文件。例如：

app/data.json/route.ts

TypeScript

export async function GET() {
  return Response.json({ name: 'Lee' })
}

上面的文件 app/data.json/route.ts 将在 next build 期间渲染为静态文件，生成包含 { name: 'Lee' } 的 data.json。

如果你需要从传入请求中读取动态值，则无法使用静态导出。

浏览器 API

客户端组件在 next build 期间被预渲染为 HTML。由于 Web API 如 window、localStorage 和 navigator 在服务器上不可用，你需要仅在浏览器中运行时安全地访问这些 API。例如：

'use client';
 
import { useEffect } from 'react';
 
export default function ClientComponent() {
  useEffect(() => {
    // 现在你可以访问 `window`
    console.log(window.innerHeight);
  }, [])
 
  return ...;
}

不支持的功能

需要 Node.js 服务器或无法在构建过程中计算的动态逻辑的功能不受支持：

带有 dynamicParams: true 的动态路由
没有 generateStaticParams() 的动态路由
依赖 Request 的路由处理程序
Cookies
重写
重定向
头信息
中间件
增量静态再生
使用默认 loader 的图像优化
草稿模式
服务器操作
拦截路由

尝试使用 next dev 使用这些功能将导致错误，类似于在根布局中设置 dynamic 选项为 error。

export const dynamic = 'error'

部署

通过静态导出，Next.js 可以部署并托管在任何能够提供 HTML/CSS/JS 静态资源的 Web 服务器上。

运行 next build 时，Next.js 将静态导出生成到 out 文件夹中。例如，假设你有以下路由：

/
/blog/[id]

运行 next build 后，Next.js 将生成以下文件：

/out/index.html
/out/404.html
/out/blog/post-1.html
/out/blog/post-2.html

如果你使用的是像 Nginx 这样的静态主机，可以配置从传入请求到正确文件的重写：

nginx.conf

server {
  listen 80;
  server_name acme.com;
 
  root /var/www/out;
 
  location / {
      try_files $uri $uri.html $uri/ =404;
  }
 
  # 当 `trailingSlash: false` 时这是必要的。
  # 当 `trailingSlash: true` 时可以省略这个。
  location /blog/ {
      rewrite ^/blog/(.*)$ /blog/$1.html break;
  }
 
  error_page 404 /404.html;
  location = /404.html {
      internal;
  }
}

版本历史

版本	变更
`v14.0.0`	`next export` 已被移除，改为使用 `"output": "export"`
`v13.4.0`	App Router（稳定版）增加了增强的静态导出支持，包括使用 React 服务器组件和路由处理程序。
`v13.3.0`	`next export` 已弃用，并替换为 `"output": "export"`