exportPathMap (已弃用)
此功能仅适用于
next export,目前已弃用,推荐在pages中使用getStaticPaths或在app中使用generateStaticParams。
示例
exportPathMap 允许您指定请求路径到页面目标的映射关系,用于导出过程。在 next dev 中使用时,exportPathMap 中定义的路径也将可用。
让我们从一个示例开始,为包含以下页面的应用创建自定义 exportPathMap:
pages/index.jspages/about.jspages/post.js
打开 next.config.js 并添加以下 exportPathMap 配置:
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 配置:
module.exports = {
trailingSlash: true,
}自定义输出目录
next export 默认使用 out 作为输出目录,您可以使用 -o 参数自定义此目录,如下所示:
next export -o outdir警告:使用
exportPathMap已弃用,且会被pages中的getStaticPaths覆盖。我们不建议同时使用它们。