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
配置:
值得注意的是:
exportPathMap
中的query
字段不能与自动静态优化的页面或getStaticProps
页面一起使用,因为它们在构建时渲染为 HTML 文件,并且无法在next export
期间提供额外的查询信息。
这些页面随后将被导出为 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
的查询对象。默认为{}
导出的
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 export
将使用 out
作为默认输出目录,你可以使用 -o
参数进行自定义,如下所示:
警告:使用
exportPathMap
已弃用,并被pages
内的getStaticPaths
覆盖。我们不建议同时使用它们。