本页面提供了 Next.js 项目文件和文件夹结构的概述。涵盖了顶层文件和文件夹、配置文件以及app和pages目录中的路由约定。
顶层文件夹
app | 应用路由 |
pages | 页面路由 |
public | 待提供的静态资源 |
src | 可选的应用源文件夹 |
顶层文件
| Next.js | |
next.config.js | Next.js 的配置文件 |
package.json | 项目的依赖和脚本 |
instrumentation.ts | OpenTelemetry 和 Instrumentation 文件 |
middleware.ts | Next.js 请求中间件 |
.env | 环境变量 |
.env.local | 本地环境变量 |
.env.production | 生产环境变量 |
.env.development | 开发环境变量 |
.eslintrc.json | ESLint 的配置文件 |
.gitignore | 忽略的 Git 文件和文件夹 |
next-env.d.ts | Next.js 的 TypeScript 声明文件 |
tsconfig.json | TypeScript 的配置文件 |
jsconfig.json | JavaScript 的配置文件 |
app 路由约定
路由文件
layout | .js .jsx .tsx | 布局 |
page | .js .jsx .tsx | 页面 |
loading | .js .jsx .tsx | 加载界面 |
not-found | .js .jsx .tsx | 未找到页面 |
error | .js .jsx .tsx | 错误页面 |
global-error | .js .jsx .tsx | 全局错误页面 |
route | .js .ts | API 端点 |
template | .js .jsx .tsx | 重新渲染的布局 |
default | .js .jsx .tsx | 平行路由回退页面 |
嵌套路由
folder | 路由段 |
folder/folder | 嵌套路由段 |
动态路由
[folder] | 动态路由段 |
[...folder] | 匹配所有路由段 |
[[...folder]] (opens in a new tab) | 可选的匹配所有路由段 |
路由组和私有文件夹
(folder) | 组织路由，不影响路由 |
_folder | 将文件夹和所有子段移出路由 |
平行和拦截路由
@folder | 命名槽 |
(.)folder | 拦截同级 |
(..)folder | 拦截上一级 |
(..)(..)folder | 拦截上两级 |
(...)folder | 从根目录拦截 |
元数据文件约定
应用图标
favicon | .ico | Favicon 文件 |
icon | .ico .jpg .jpeg .png .svg | 应用图标文件 |
icon | .js .ts .tsx | 生成的应用图标文件 |
apple-icon | .jpg .jpeg, .png | 苹果应用图标文件 |
apple-icon | .js .ts .tsx | 生成的苹果应用图标文件 |
开放图和推特图片
opengraph-image | .jpg .jpeg .png .gif | Open Graph 图片文件 |
opengraph-image | .js .ts .tsx | 生成的 Open Graph 图片 |
twitter-image | .jpg .jpeg .png .gif | 推特图片文件 |
twitter-image | .js .ts .tsx | 生成的推特图片 |
SEO
sitemap | .xml | Sitemap 文件 |
sitemap | .js .ts | 生成的 Sitemap |
robots | .txt | Robots 文件 |
robots | .js .ts | 生成的 Robots 文件 |
pages 路由约定
特殊文件
_app | .js .jsx .tsx | 自定义应用 |
_document | .js .jsx .tsx | 自定义文档 |
_error | .js .jsx .tsx | 自定义错误页面 |
404 | .js .jsx .tsx | 404 错误页面 |
500 | .js .jsx .tsx | 500 错误页面 |
路由
| 文件夹约定 | ||
index | .js .jsx .tsx | 首页 |
folder/index | .js .jsx .tsx | 嵌套页面 |
| 文件约定 | ||
index | .js .jsx .tsx | 首页 |
file | .js .jsx .tsx | 嵌套页面 |
动态路由
| 文件夹约定 | ||
[folder]/index | .js .jsx .tsx | 动态路由段 |
[...folder]/index | .js .jsx .tsx | 匹配所有动态路由段 |
[[...folder]]/index | .js .jsx .tsx | 可选的匹配所有动态路由段 |
| 文件约定 | ||
[file] | .js .jsx .tsx | 动态路由段 |
[...file] | .js .jsx .tsx | 匹配所有动态路由段 |
[[...file]] | .js .jsx .tsx | 可选的匹配所有动态路由段 |