如何创建 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 和客户端路由导航间的静态有效负载。使用静态导出时，除非服务端组件使用了动态服务端功能，否则无需对它们进行修改。

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 的客户端组件来缓存请求。

'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 '加载失败'
  if (!data) return '加载中...'

  return data.title
}

'use client'

import useSWR from 'swr'

const fetcher = (url) => fetch(url).then((r) => r.json())

export default function Page() {
  const { data, error } = useSWR(
    `https://jsonplaceholder.typicode.com/posts/1`,
    fetcher
  )
  if (error) return '加载失败'
  if (!data) return '加载中...'

  return data.title
}

由于路由转换发生在客户端，其行为类似于传统的 SPA。例如，以下索引路由允许您在客户端导航到不同的文章：

import Link from 'next/link'

export default function Page() {
  return (
    <>
      <h1>索引页</h1>
      <hr />
      <ul>
        <li>
          <Link href="/post/1">文章 1</Link>
        </li>
        <li>
          <Link href="/post/2">文章 2</Link>
        </li>
      </ul>
    </>
  )
}

import Link from 'next/link'

export default function Page() {
  return (
    <>
      <h1>索引页</h1>
      <p>
        <Link href="/other">其他页面</Link>
      </p>
    </>
  )
}

图片优化

通过 next/image 实现的图片优化可以在静态导出中使用，只需在 next.config.js 中定义自定义图片加载器。例如，您可以使用 Cloudinary 等服务优化图片：

next.config.js

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

module.exports = nextConfig

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

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}`
}

export default function cloudinaryLoader({ src, width, quality }) {
  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 中图片的相对路径：

import Image from 'next/image'

export default function Page() {
  return <Image alt="海龟" src="/turtles.jpg" width={300} height={300} />
}

import Image from 'next/image'

export default function Page() {
  return <Image alt="海龟" src="/turtles.jpg" width={300} height={300} />
}

路由处理器

运行 next build 时，路由处理器会渲染静态响应。仅支持 GET HTTP 方法。这可用于从缓存或非缓存数据生成静态 HTML、JSON、TXT 或其他文件。例如：

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

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

上述文件 app/data.json/route.ts 将在 next build 期间渲染为静态文件，生成包含 { name: '李' } 的 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`	应用路由（稳定版）增加了增强的静态导出支持，包括使用 React 服务端组件和路由处理器。
`v13.3.0`	`next export` 已弃用，改用 `"output": "export"`

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

On this page