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覆盖。我们不建议将它们一起使用。
这有帮助吗?