Next.js 项目结构
本页面提供了 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 路由约定
以下是用于在 app 路由 中定义路由和处理元数据的文件约定。
Routing Files
| 说明 | 文件扩展名 | 用途 |
|---|---|---|
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 | 平行路由回退页面 |
Nested Routes
| 说明 | 用途 |
|---|---|
folder | 路由片段 |
folder/folder | 嵌套路由片段 |
Dynamic Routes
| 说明 | 用途 |
|---|---|
[folder] | 动态路由片段 |
[...folder] | 捕获所有路由片段 |
[[...folder]] | 可选的捕获所有路由片段 |
Route Groups and Private Folders
| 说明 | 用途 |
|---|---|
(folder) | 不影响路由的组路由 |
_folder | 将文件夹及其所有子片段排除在路由之外 |
并行和拦截路由
@folder | 命名插槽 |
(.)folder | 拦截同级 |
(..)folder | 拦截上一级 |
(..)(..)folder | 拦截上两级 |
(...)folder | 从根拦截 |
元数据文件约定
应用图标
favicon | .ico | 网站图标文件 |
icon | .ico .jpg .jpeg .png .svg | 应用图标文件 |
icon | .js .ts .tsx | 生成的应用图标 |
apple-icon | .jpg .jpeg, .png | 苹果应用图标文件 |
apple-icon | .js .ts .tsx | 生成的苹果应用图标 |
Open Graph 和 Twitter 图片
opengraph-image | .jpg .jpeg .png .gif | Open Graph 图片文件 |
opengraph-image | .js .ts .tsx | 生成的 Open Graph 图片 |
twitter-image | .jpg .jpeg .png .gif | Twitter 图片文件 |
twitter-image | .js .ts .tsx | 生成的 Twitter 图片 |
SEO
sitemap | .xml | 网站地图文件 |
sitemap | .js .ts | 生成的网站地图 |
robots | .txt | Robots 文件 |
robots | .js .ts | 生成的 Robots 文件 |
pages 路由约定
以下是用于定义 pages 路由器 中路由的文件约定。
Special Files
_app | .js .jsx .tsx | 自定义应用 |
_document | .js .jsx .tsx | 自定义文档 |
_error | .js .jsx .tsx | 自定义错误页面 |
404 | .js .jsx .tsx | 404错误页面 |
500 | .js .jsx .tsx | 500错误页面 |
Routes
| 文件夹约定 | ||
index | .js .jsx .tsx | 首页 |
folder/index | .js .jsx .tsx | 嵌套页面 |
| 文件约定 | ||
index | .js .jsx .tsx | 首页 |
file | .js .jsx .tsx | 嵌套页面 |
Dynamic Routes
| 文件夹约定 | ||
[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 | 可选全捕获路由段 |