约定即配置

本章我们来看一下 create-next-app 的选项、目录结构以及 Next.js 的「约定即配置」。

什么是 App 路由

create-next-app 选项

本专题使用 yarn create next-app 来创建 Next.js 项目，它底层调用的也是 create-next-app 命令。

What is your project named? axum-rs-hello-nextjs-app-router   👉[1]
Would you like to use TypeScript with this project? No / Yes   👉[2]
Would you like to use ESLint with this project? No / Yes  👉[3]
Would you like to use Tailwind CSS with this project? No / Yes  👉[4]
Would you like to use `src/` directory with this project? No / Yes  👉[5]
Use App Router (recommended)? No / Yes  👉[6]
Would you like to customize the default import alias? No / Yes  👉[7]

• 👉[1] ：给创建的项目设置名字，本例为 axum-rs-hello-nextjs-app-router
• 👉[2]：是否使用 TypeScript，本例为 No（不使用）
• 👉[3]：是否使用 ESLint，本例为 No（不使用）
• 👉[4]：是否使用 Tailwind，本例为 No（不使用，需要的时候可以手动安装，并不复杂）
• 👉[5]：是否使用 src 目录，本例为 No（不使用）
• 👉[6]：是否使用 App 路由，本例为 Yes（使用）
• 👉[7]：是否为 import 定义别名，本例为 No （不定义）

显而易见，本专题就是为了讲 App 路由，所以 👉[6] 肯定要选择 Yes。

目录结构

├── app
│   ├── favicon.ico
│   ├── globals.css
│   ├── layout.js
│   ├── page.js
│   └── page.module.css
├── jsconfig.json
├── next.config.js
├── package.json
├── public
│   ├── next.svg
│   └── vercel.svg
├── README.md
└── yarn.lock

• app 目录：项目的路由
  • app/favicon.ico：偏好图标
  • app/global.css：全局样式
  • app/layout.js：应用程序的根布局（root layout）
  • app/page.js：应用程序的“首页”（root page）
  • app/page.module.css：应用程序“首页”的模块化样式
• next.config.js：Next.js 配置文件
• public目录：公共静态资源

约定即配置

Next.js 的重大策略是：约定即配置，大部分功能都是通过约定而不是手动配置(比如手动修改next.config.js)来实现。其中最明显的就是路由系统。

Next.js 使用约定的文件/目录来实现路由：（以下文件/目录均在app/目录里面）

以下内容的 *.js 可以是 *.js/*.jsx/*.ts/*.tsx，为了简化描述，本专题统一以 *.js 进行描述。

嵌套路由

动态路由

并行路由和路由拦截

本专题代码位于AxumCourse/nextjs-app-router仓库。