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
配置:
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
期间无法提供额外的 query 信息。
这些页面随后将被导出为 HTML 文件,例如 /about
会变成 /about.html
。
exportPathMap
是一个 async
函数,接收两个参数:第一个是 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
默认使用 out
作为输出目录,你可以使用 -o
参数自定义,如下所示:
next export -o outdir
警告:使用
exportPathMap
已被弃用,并会被pages
内的getStaticPaths
覆盖。我们不建议同时使用它们。