Estructura de directorios de Next.js

En Next.js, la estructura de directorios se organiza mediante el mecanismo de enrutamiento basado en el sistema de archivos, lo que significa que la estructura de tus archivos y carpetas determina directamente las rutas y el diseño de las páginas de tu aplicación.

  • app/El directorio se utiliza para almacenar archivos de páginas y diseños; es el directorio central en Next.js.
  • public/Se utiliza para almacenar archivos de recursos estáticos públicos.
  • styles/Se utiliza para almacenar archivos de estilos.
  • node_modules/Almacena todos los paquetes de dependencias del proyecto.
  • package.jsonEs el archivo de configuración del proyecto, que incluye dependencias y comandos de scripts.
  • next.config.jsSe utiliza para personalizar la configuración de Next.js.

Directorio raíz (Root Directory)

El directorio raíz normalmente contiene algunos archivos de configuración básicos y dependencias. Los archivos y carpetas comunes son los siguientes:

my-next-app/
├── app/                 # 存放应用页面和布局文件
├── public/              # 存放静态资源文件(如图片、字体)
├── styles/              # 存放样式文件(CSS、Sass等)
├── node_modules/        # 存放项目依赖
├── package.json         # 项目配置文件
├── next.config.js       # Next.js 配置文件(可选)
└── .gitignore           # Git 忽略文件
  • app/: Este directorio es la nueva forma en Next.js de organizar archivos de páginas y diseños. Todas las rutas y páginas se crean basándose en este directorio.
  • public/: Este directorio contiene archivos estáticos públicos, como imágenes, fuentes, favicon, etc. Puedes acceder a estos archivos directamente a través de una URL.
  • styles/: Almacena tus archivos CSS, Sass u otros archivos de estilos.

Directorio app/

El directorio app/ es el núcleo de Next.js; contiene páginas, diseños y otros archivos relacionados.

A continuación se muestran algunas estructuras comunes del directorio app/:

app/
├── layout.tsx           # 根布局文件
├── page.tsx             # 根页面
└── [slug]/              # 动态路由目录
    ├── page.tsx         # 动态页面
    └── layout.tsx       # 特定页面的布局
  • layout.tsx: En este archivo se define el layout raíz o el layout de página, generalmente se usa para establecer la estructura global (como la etiqueta<html>y<body>). Todas las subpáginas se anidan dentro de este layout.
  • page.tsx: Cada componente de página debe tener unpage.tsxarchivo. Este archivo representa el contenido de la página correspondiente a esa ruta. Por ejemplo,app/page.tsxcorresponde a la ruta raíz (/) de la página.
  • Rutas dinámicas: Next.js admite rutas dinámicas; el nombre del directorio de las rutas dinámicas se encierra entre corchetes, como[slug]. Esto significa que puedes cargar diferentes páginas según las distintas partes de la URL. Por ejemplo,[slug]/page.tsxsegúnslugel parámetro, se renderiza dinámicamente la página.

Directorio public/

Este directorio se utiliza para almacenar recursos estáticos; permite exponer imágenes, fuentes, iconos y otros recursos en la aplicación, y se pueden cargar accediendo directamente a la ruta del archivo.

public/
├── images/              # 存放图片文件
├── fonts/               # 存放字体文件
└── favicon.ico          # 网站图标
  • Los archivos se pueden acceder a través de/images/rutas como ..., etc., directamente. Por ejemplo,public/images/logo.pngse puede acceder a través dehttp://localhost:3000/images/logo.pngacceder.

Directorio styles/

En el directorio styles/, puedes organizar y gestionar tus archivos de estilos. Next.js admite módulos CSS, estilos globales y otras soluciones CSS.

styles/
├── Home.module.css      # CSS 模块化样式
└── globals.css          # 全局样式
  • Home.module.css: Este es un archivo de módulo CSS. Por defecto, Next.js utiliza automáticamente módulos CSS para cada componente, asegurando que el alcance de los estilos se limite a ese componente.
  • globals.css: Contiene estilos globales, generalmente se usa para configurar fuentes, colores, etc. globales.

Directorio node_modules/

Este directorio almacena todos los paquetes de dependencias del proyecto. Es generado automáticamente por npm o yarn según la información de dependencias del archivo package.json, no requiere operación manual.

Archivo package.json

package.json es el archivo de configuración central del proyecto, que registra las dependencias, scripts y otros metadatos. Aquí puedes definir comandos como iniciar, compilar y desarrollar.

Ejemplo

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

Archivo next.config.js (opcional)

Este es un archivo de configuración opcional, utilizado para configurar el comportamiento de Next.js. Por ejemplo, puedes establecer la optimización de archivos estáticos, reglas de enrutamiento, configuración de Webpack, etc. en este archivo.

Ejemplo

module.exports = {
  reactStrictMode: true,
}

Ejemplo de estructura de proyecto

A continuación se muestra un ejemplo de una estructura de proyecto típica de Next.js:

Ejemplo: Estructura de proyecto de Next.js

my-next-app/
├── app/
│   ├── layout.js        //Layout raíz
│   ├── page.js          //Página de inicio
│   ├── about/
│   │   ├── layout.js    // /Layout de about
│   │   └── page.js      // /Página de about
│   ├── blog/
│   │   ├── layout.js    // /Layout de blog
│   │   ├── page.js      // /Página de listado de blog
│   │   └── [slug]/
│   │       └── page.js  // /blog/Página de detalle :slug
│   └── dashboard/
│       ├── layout.js    // /Layout de dashboard
│       └── page.js      // /Página de dashboard
├── public/
│   ├── logo.png         //Recursos estáticos
│   └── favicon.ico      //Favicon del sitio
├── node_modules/        //Dependencias del proyecto
├── package.json         //Archivo de configuración del proyecto
├── next.config.js       //Archivo de configuración de Next.js
└── .next/               //Directorio de salida de compilación

Comparación entre el directorio app y el directorio tradicional pages

Next.js 13 introdujo el nuevo directorio app, que coexiste con el directorio tradicional pages y ofrece una forma más flexible de organizar rutas y diseños.

CaracterísticaspagesDirectorioappDirectorio
Definición de rutasEnrutamiento por sistema de archivosEnrutamiento por carpetas
Gestión de layoutsImplementación manualLayouts anidados
Obtención de datosgetStaticPropsesperarServer Components + async/await
Nomenclatura de archivosNombres libresDebe nombrarse comopage.js
Archivos especiales_app.js, _document.jsesperarlayout.js, loading.jsesperar
Optimización del rendimientoOptimización manualOptimización predeterminada
CompatibilidadTotalmente compatibleEn fase Beta, requiere activación manual
Otras extensiones