Structure des répertoires de Next.js

Dans Next.js, la structure des répertoires est organisée selon un mécanisme de routage basé sur le système de fichiers, ce qui signifie que la structure de vos fichiers et dossiers détermine directement le routage et la mise en page de votre application.

  • app/Le répertoire est utilisé pour stocker les fichiers de page et de mise en page, et c'est le répertoire principal de Next.js.
  • public/Il est utilisé pour stocker les fichiers de ressources statiques publics.
  • styles/Il est utilisé pour stocker les fichiers de style.
  • node_modules/Stocke tous les paquets de dépendances du projet.
  • package.jsonC'est le fichier de configuration du projet, contenant les dépendances du projet et les commandes de script.
  • next.config.jsIl est utilisé pour personnaliser la configuration de Next.js.

Répertoire racine

Le répertoire racine contient généralement certains fichiers de configuration de base et des dépendances. Les fichiers et dossiers courants sont les suivants :

my-next-app/
├── app/                 # 存放应用页面和布局文件
├── public/              # 存放静态资源文件(如图片、字体)
├── styles/              # 存放样式文件(CSS、Sass等)
├── node_modules/        # 存放项目依赖
├── package.json         # 项目配置文件
├── next.config.js       # Next.js 配置文件(可选)
└── .gitignore           # Git 忽略文件
  • app/: Ce répertoire est la nouvelle façon dans Next.js d'organiser les fichiers de page et de layout. Tout le routage et toutes les pages sont créés en fonction de ce répertoire.
  • public/: Ce répertoire stocke les fichiers statiques publics, tels que les images, les polices, le favicon, etc. Vous pouvez accéder directement à ces fichiers via une URL.
  • styles/: Stockez vos fichiers CSS, Sass ou d'autres fichiers de style.

Répertoire app/

Le répertoire app/ est le cœur de Next.js ; il stocke les pages, les layouts et d'autres fichiers associés.

Voici une structure courante du répertoire app/ :

app/
├── layout.tsx           # 根布局文件
├── page.tsx             # 根页面
└── [slug]/              # 动态路由目录
    ├── page.tsx         # 动态页面
    └── layout.tsx       # 特定页面的布局
  • layout.tsx: Dans ce fichier, le layout racine ou le layout de page est défini, généralement utilisé pour définir la structure globale (telle que<html>et<body>balise). Toutes les sous-pages seront imbriquées dans ce layout.
  • page.tsx: Chaque composant de page doit avoir unpage.tsxfichier. Ce fichier représente le contenu de la page correspondant à cette route. Par exemple,app/page.tsxcorrespond au chemin racine (/) page.
  • Routes dynamiques: Next.js prend en charge les routes dynamiques. Les noms des répertoires de routes dynamiques sont placés entre crochets, comme[slug]. Cela signifie que vous pouvez charger différentes pages en fonction de différentes parties de l’URL. Par exemple,[slug]/page.tsxsera basé surslugparamètre pour rendre dynamiquement la page.

Répertoire public/

Ce répertoire est utilisé pour stocker des ressources statiques. Il vous permet d’exposer des ressources telles que des images, des polices, des icônes, etc., dans l’application, et elles peuvent être chargées en accédant directement au chemin du fichier.

public/
├── images/              # 存放图片文件
├── fonts/               # 存放字体文件
└── favicon.ico          # 网站图标
  • Les fichiers sont accessibles via/images/et d’autres chemins directement. Par exemple,public/images/logo.pngest accessible viahttp://localhost:3000/images/logo.png.

Répertoire styles/

Dans le répertoire styles/, vous pouvez organiser et gérer vos fichiers de style. Next.js prend en charge les CSS Modules, les styles globaux et d'autres solutions CSS.

styles/
├── Home.module.css      # CSS 模块化样式
└── globals.css          # 全局样式
  • Home.module.css: Ceci est un fichier CSS Module. Par défaut, Next.js utilise automatiquement les CSS Modules pour chaque composant, ce qui garantit que la portée du style est limitée à ce composant.
  • globals.css: Stocke les styles globaux, généralement utilisé pour définir les polices globales, les couleurs, etc.

Répertoire node_modules/

Ce répertoire stocke tous les paquets de dépendances du projet. Il est généré automatiquement par npm ou yarn à partir des informations de dépendances du fichier package.json, et ne nécessite aucune opération manuelle.

Fichier package.json

package.json est le fichier de configuration central du projet, enregistrant les dépendances, les scripts et d'autres métadonnées du projet. Vous pouvez y définir des commandes telles que start, build et develop.

Exemple

{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "lint": "next lint"
  }
}

Fichier next.config.js (facultatif)

Ceci est un fichier de configuration facultatif utilisé pour configurer le comportement de Next.js. Par exemple, vous pouvez définir l'optimisation des fichiers statiques, les règles de routage, la configuration Webpack, etc., dans ce fichier.

Exemple

module.exports = {
  reactStrictMode: true,
}

Exemple de structure de projet

Voici un exemple typique de structure Next.js :

Exemple : structure de projet Next.js

my-next-app/
├── app/
│ ├── layout.js        //Mise en page racine
│ ├── page.js          //Page d'accueil
│ ├── about/
│ │ ├── layout.js    // /Mise en page pour about
│ │ └── page.js      // /page à propos
│ ├── blog/
│ │ ├── layout.js    // /Mise en page pour le blog
│ │ ├── page.js      // /page de liste du blog
│   │   └── [slug]/
│ │ └── page.js  // /blog/:slug page de détail
│ └── dashboard/
│ ├── layout.js    // /Mise en page pour le tableau de bord
│ └── page.js      // /page du tableau de bord
├── public/
│ ├── logo.png         //Ressources statiques
│ └── favicon.ico      //Icône du site web
├── node_modules/        //Dépendances du projet
├── package.json         //Fichier de configuration du projet
├── next.config.js       //Fichier de configuration Next.js
└── .next/               //Répertoire de sortie de build

Comparaison du répertoire app et du répertoire pages traditionnel

Next.js 13 a introduit le nouveau répertoire app. Il coexiste avec le répertoire pages traditionnel et offre une manière plus flexible d'organiser le routage et les mises en page.

FonctionnalitépagesRépertoireappRépertoire
Définition de routeRoutage basé sur le système de fichiersRoutage par dossier
Gestion des mises en pageImplémentation manuelleMises en page imbriquées
Récupération de donnéesgetStaticPropswaitComposants serveur + async/await
Nommage des fichiersNommage libreDoit être nommépage.js
Fichiers spéciaux_app.js, _document.jswaitlayout.js, loading.jswait
Optimisation des performancesOptimisation manuelleOptimisation par défaut
CompatibilitéEntièrement compatiblePhase bêta, activation manuelle requise
Autres extensions