Next.js ディレクトリ構成

Next.js では、ディレクトリ構成はファイルシステムベースのルーティングメカニズムに従って編成されます。つまり、ファイルとフォルダの構造が、アプリケーションのルートとページレイアウトを直接決定します。

  • app/ディレクトリはページとレイアウトファイルを格納するために使用され、Next.js の中核となるディレクトリです。
  • public/公開された静的リソースファイルを格納するために使用されます。
  • styles/スタイルファイルを格納するために使用されます。
  • node_modules/プロジェクトのすべての依存パッケージを格納します。
  • package.jsonプロジェクトの構成ファイルであり、プロジェクトの依存関係とスクリプトコマンドが含まれます。
  • next.config.jsNext.js の構成をカスタマイズするために使用されます。

ルートディレクトリ(Root Directory)

ルートディレクトリには通常、いくつかの基本構成ファイルと依存関係が含まれます。一般的なファイルとフォルダは次のとおりです:

my-next-app/
├── app/                 # 存放应用页面和布局文件
├── public/              # 存放静态资源文件(如图片、字体)
├── styles/              # 存放样式文件(CSS、Sass等)
├── node_modules/        # 存放项目依赖
├── package.json         # 项目配置文件
├── next.config.js       # Next.js 配置文件(可选)
└── .gitignore           # Git 忽略文件
  • app/:このディレクトリは、Next.js でページとレイアウトファイルを整理する新しい方法です。すべてのルートとページはこのディレクトリに基づいて作成されます。
  • public/:このディレクトリには、画像、フォント、favicon などの公開静的ファイルが格納されます。これらのファイルには URL から直接アクセスできます。
  • styles/:CSS、Sass、その他のスタイルファイルを格納します。

app/ ディレクトリ

app/ ディレクトリは Next.js の中核であり、ページ、レイアウト、およびその他の関連ファイルを格納します。

以下は app/ ディレクトリの一般的な構成の一部です:

app/
├── layout.tsx           # 根布局文件
├── page.tsx             # 根页面
└── [slug]/              # 动态路由目录
    ├── page.tsx         # 动态页面
    └── layout.tsx       # 特定页面的布局
  • layout.tsx:このファイルでは、ルートレイアウトまたはページレイアウトが定義されます。通常、グローバル構造を設定するために使用されます(例:<html>と<body>タグ)。すべての子ページはこのレイアウト内にネストされます。
  • page.tsx:各ページコンポーネントには、page.tsxファイルが必要です。このファイルは、そのルートに対応するページコンテンツを表します。たとえば、app/page.tsx対応するのはルートパス(/)のページです。
  • 動的ルート:Next.js は動的ルートをサポートしています。動的ルートのディレクトリ名は角括弧で囲みます。例:[slug]。これは、URL のさまざまな部分に応じて異なるページを読み込めることを意味します。たとえば、[slug]/page.tsxは、slugパラメータに基づいてページを動的にレンダリングします。

public/ ディレクトリ

このディレクトリは静的リソースを格納するために使用され、画像、フォント、アイコンなどのリソースをアプリケーション内で公開し、ファイルパスに直接アクセスして読み込むことができます。

public/
├── images/              # 存放图片文件
├── fonts/               # 存放字体文件
└── favicon.ico          # 网站图标
  • ファイルは/images/などのパスから直接アクセスできます。たとえば、public/images/logo.pngはhttp://localhost:3000/images/logo.pngからアクセスできます。

styles/ ディレクトリ

styles/ ディレクトリでは、スタイルファイルを整理および管理できます。Next.js は CSS モジュール、グローバルスタイル、その他の CSS ソリューションをサポートしています。

styles/
├── Home.module.css      # CSS 模块化样式
└── globals.css          # 全局样式
  • Home.module.css:これは CSS モジュールファイルです。デフォルトでは、Next.js は各コンポーネントに CSS モジュールを自動的に適用し、スタイルのスコープがそのコンポーネントに限定されるようにします。
  • globals.css:グローバルスタイルを格納します。通常、グローバルなフォントや色などを設定するために使用されます。

node_modules/ ディレクトリ

このディレクトリには、プロジェクトのすべての依存パッケージが格納されます。これは、npm または yarn が package.json ファイルの依存情報に基づいて自動生成するため、手動で操作する必要はありません。

package.json ファイル

package.json はプロジェクトの中核となる構成ファイルであり、プロジェクトの依存関係、スクリプト、その他のメタデータが記録されます。ここで、起動、ビルド、開発などのコマンドを定義できます。

例

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

next.config.js ファイル(オプション)

これはオプションの構成ファイルであり、Next.js の動作を構成するために使用されます。たとえば、このファイルで静的ファイルの最適化、ルーティングルール、Webpack 構成などを設定できます。

例

module.exports = {
  reactStrictMode: true,
}

プロジェクト構成の例

以下は、典型的な Next.js プロジェクト構成の例です:

例: Next.js プロジェクト構成

my-next-app/
├── app/
│   ├── layout.js        //ルートレイアウト
│   ├── page.js          //ホームページ
│   ├── about/
│   │   ├── layout.js    // /about のレイアウト
│   │   └── page.js      // /about ページ
│   ├── blog/
│   │   ├── layout.js    // /blog のレイアウト
│   │   ├── page.js      // /blog リストページ
│   │   └── [slug]/
│   │       └── page.js  // /blog/:slug 詳細ページ
│   └── dashboard/
│       ├── layout.js    // /dashboard のレイアウト
│       └── page.js      // /dashboard ページ
├── public/
│   ├── logo.png         //静的リソース
│   └── favicon.ico      //サイトアイコン
├── node_modules/        //プロジェクトの依存関係
├── package.json         //プロジェクト構成ファイル
├── next.config.js       //Next.js 構成ファイル
└── .next/               //ビルド出力ディレクトリ

app ディレクトリと従来の pages ディレクトリの比較

Next.js 13 では新しい app ディレクトリが導入されました。これは従来の pages ディレクトリと共存し、より柔軟なルートとレイアウトの構成方法を提供します。

特徴pagesディレクトリappディレクトリ
ルート定義ファイルシステムルーティングフォルダルーティング
レイアウト管理手動実装ネストされたレイアウト
データ取得getStaticProps 等Server Components + async/await
ファイル命名自由な命名必ず命名する必要がありますpage.js
特殊ファイル_app.js, _document.js 等layout.js, loading.js 等
パフォーマンス最適化手動最適化デフォルト最適化
互換性完全互換Beta 段階、手動で有効化が必要
その他の拡張