exportPathMap (已弃用)

此功能仅适用于 next export,目前已弃用,推荐在 pages 中使用 getStaticPaths 或在 app 中使用 generateStaticParams

示例

exportPathMap 允许您指定请求路径到页面目标的映射关系,用于导出过程。在 next dev 中使用时,exportPathMap 中定义的路径也将可用。

让我们从一个示例开始,为包含以下页面的应用创建自定义 exportPathMap

  • pages/index.js
  • pages/about.js
  • pages/post.js

打开 next.config.js 并添加以下 exportPathMap 配置:

next.config.js
module.exports = {
  exportPathMap: async function (
    defaultPathMap,
    { dev, dir, outDir, distDir, buildId }
  ) {
    return {
      '/': { page: '/' },
      '/about': { page: '/about' },
      '/p/hello-nextjs': { page: '/post', query: { title: 'hello-nextjs' } },
      '/p/learn-nextjs': { page: '/post', query: { title: 'learn-nextjs' } },
      '/p/deploy-nextjs': { page: '/post', query: { title: 'deploy-nextjs' } },
    }
  },
}

须知exportPathMap 中的 query 字段不能与 自动静态优化页面getStaticProps 页面 一起使用,因为这些页面在构建时会被渲染为 HTML 文件,且 next export 期间无法提供额外的查询信息。

这些页面随后将被导出为 HTML 文件,例如 /about 将变为 /about.html

exportPathMap 是一个 async 函数,接收 2 个参数:第一个是 defaultPathMap,即 Next.js 使用的默认映射。第二个参数是一个包含以下字段的对象:

  • dev - 当 exportPathMap 在开发环境中调用时为 true。运行 next export 时为 false。在开发环境中,exportPathMap 用于定义路由。
  • dir - 项目目录的绝对路径
  • outDir - out/ 目录的绝对路径(可通过 -o 配置)。当 devtrue 时,outDir 的值为 null
  • distDir - .next/ 目录的绝对路径(可通过 distDir 配置)
  • buildId - 生成的构建 ID

返回的对象是一个页面映射,其中 keypathnamevalue 是一个接受以下字段的对象:

  • page: String - pages 目录中要渲染的页面
  • query: Object - 预渲染时传递给 getInitialPropsquery 对象。默认为 {}

导出的 pathname 也可以是文件名(例如 /readme.md),但如果其内容与 .html 不同,您可能需要将 Content-Type 标头设置为 text/html 以提供其内容。

添加尾部斜杠

可以配置 Next.js 将页面导出为 index.html 文件并要求尾部斜杠,/about 变为 /about/index.html 并可通过 /about/ 路由。这是 Next.js 9 之前的默认行为。

要切换回添加尾部斜杠的模式,请打开 next.config.js 并启用 trailingSlash 配置:

next.config.js
module.exports = {
  trailingSlash: true,
}

自定义输出目录

next export 默认使用 out 作为输出目录,您可以使用 -o 参数自定义此目录,如下所示:

终端
next export -o outdir

警告:使用 exportPathMap 已弃用,且会被 pages 中的 getStaticPaths 覆盖。我们不建议同时使用它们。

On this page