跳到内容
配置next.config.js 选项exportPathMap

exportPathMap

此功能仅限于 next export，目前已被弃用，取而代之的是带有 pages 的 getStaticPaths 或带有 app 的 generateStaticParams。

exportPathMap 允许您指定请求路径到页面目标的映射，以便在导出期间使用。在 exportPathMap 中定义的路径在使用 next dev 时也将可用。

让我们从一个示例开始，为具有以下页面的应用程序创建一个自定义的 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 配置）。当 dev 为 true 时，outDir 的值为 null。
  • distDir - .next/ 目录的绝对路径（可通过 distDir 配置）
  • buildId - 生成的构建 ID

返回的对象是页面映射，其中 key 是 pathname，value 是一个接受以下字段的对象

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

导出的 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 覆盖。我们不建议同时使用它们。