若手開発者にとって、Node.js バックエンドの構(gòu)築で最も難しい側(cè)面の 1 つは、コード自體を記述することではなく、スケーラブルな方法でコードを編成することです。今日は、アプリケーションのテンプレートとして使用できる、本番環(huán)境に対応した Node.js プロジェクト構(gòu)造について説明します。

非構(gòu)造化コードの問題
本題に入る前に、本が本棚にランダムに配置されている図書館で、特定の本を見つけようとしているところを想像してみてください。イライラしますよね？同じことがコードにも當(dāng)てはまります。適切な構(gòu)造がなければ、Node.js アプリケーションはすぐにスパゲッティ コードの迷路となり、維持や拡張が困難になる可能性があります。

より良い方法: 最新の Node.js プロジェクト構(gòu)造
多くの成功した企業(yè)が使用しているプロフェッショナル レベルの Node.js プロジェクト構(gòu)造を詳しく見てみましょう:

?バックエンド/
§─？ src/
│ ── ？ @types # TypeScript の型定義
│ ━─？ config # 設(shè)定ファイル
│ ── ？コントローラ # リクエストハンドラ
│ ── ？エンティティ # データベース モデル/エンティティ
│ ── ？ helper # ヘルパー/ユーティリティ関數(shù)
│ ── ？ミドルウェア # Express ミドルウェア
│ ── ？ルート # API ルート定義
│ ── ？サービス # ビジネスロジック
│ ── ？ type # 追加の型定義
│ ── ？ utils # ユーティリティ関數(shù)
━──？ app.ts # アプリケーションエントリーポイント
━──？ .eslintrc.js # ESLint 構(gòu)成
━──？ .prettierrc # Prettier 設(shè)定
━──？ Dockerfile # Docker 構(gòu)成
━──？ package.json # プロジェクトの依存関係
━──？ tsconfig.json # TypeScript 設(shè)定
━──？ .dockerignore # Docker はルールを無(wú)視します
━──？ .env # 環(huán)境変數(shù)
━──？ docker-compose.yml #Docker Compose 構(gòu)成

各コンポーネントを理解する
1. @types と types ディレクトリ

`// @types/express/index.d.ts
declare namespace Express {
 export interface Request {
 user?: {
 id: string;
 role: string;
 };
 }
}`

これらのフォルダーには TypeScript の型定義が含まれています。 @types フォルダーには通常、外部モジュールの宣言が含まれ、types フォルダーにはアプリケーション固有の型が含まれます。

2.構(gòu)成ディレクトリ

// config/database.ts
export const dbConfig = {
 host: process.env.DB_HOST,
 port: process.env.DB_PORT,
 username: process.env.DB_USER,
 // … other configuration
};

このディレクトリにはすべての構(gòu)成ファイルが格納され、さまざまな環(huán)境 (開発、ステージング、運(yùn)用) の管理が容易になります。

3.コントローラー

// controllers/userController.ts
export class UserController {
  async getUser(req: Request, res: Response) {
    try {
      const user = await userService.findById(req.params.id);
      res.json(user);
    } catch (error) {
      res.status(500).json({ error: error.message });
    }
  }
}

コントローラーは HTTP リクエストとレスポンスを処理し、ルートとサービス間のブリッジとして機(jī)能します。

4.エンティティ

typescript// entity/User.ts
@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  username: string;

  @Column()
  email: string;
}

エンティティ ディレクトリにはデータベース モデルが含まれており、通常は TypeORM や Sequelize などの ORM を使用します。

5.サービス

services/userService.ts
export class UserService {
  async createUser(userData: CreateUserDto) {
    const user = new User();
    Object.assign(user, userData);
    return await this.userRepository.save(user);
  }
}

サービスにはビジネス ロジックが含まれており、コントローラーから分離されています。

6.ミドルウェア

`// @types/express/index.d.ts
declare namespace Express {
 export interface Request {
 user?: {
 id: string;
 role: string;
 };
 }
}`

ミドルウェアは、認(rèn)証、ロギング、エラー処理などの橫斷的な問題を処理します。

ベストプラクティスとヒント

1.単一の責(zé)任: 各ディレクトリには明確な単一の目的がある必要があります。ビジネス ロジックとルート定義を混同しないでください。

2.依存関係の注入: 依存関係の注入を使用すると、コードのテストと保守が容易になります。

// config/database.ts
export const dbConfig = {
 host: process.env.DB_HOST,
 port: process.env.DB_PORT,
 username: process.env.DB_USER,
 // … other configuration
};

3.環(huán)境構(gòu)成: 環(huán)境固有の変數(shù)には .env ファイルを使用し、バージョン管理には決してコミットしないでください。

4. Docker 統(tǒng)合: Dockerfile と docker-compose.yml の存在は、コンテナ化のサポートを示し、環(huán)境間でデプロイの一貫性を確保します。

避けるべき一般的な落とし穴
循環(huán)依存関係: モジュール間に循環(huán)依存関係を作成しないように注意してください。
大容量ファイル: ファイルが大きくなりすぎる場(chǎng)合は、処理が過剰になっている可能性があります。より小さな、焦點(diǎn)を絞ったモジュールに分割します。
一貫性のないエラー処理: アプリケーション全體で一貫したエラー処理戦略を確立します。

結(jié)論

長(zhǎng)期的な保守性とスケーラビリティには、適切に構(gòu)造化された Node.js アプリケーションが不可欠です。この構(gòu)造は、アプリケーションの成長(zhǎng)に合わせて構(gòu)築できる強(qiáng)固な基盤を提供します。目標(biāo)は単に動(dòng)作させることではなく、保守可能でスケーラブルで、楽しく作業(yè)できるようにすることであることを忘れないでください。

次回新しい Node.js プロジェクトを開始するときは、この構(gòu)造をテンプレートとして使用することを検討してください。これにより、數(shù)え切れないほどのリファクタリング時(shí)間が節(jié)約され、コードベースが初日からよりプロフェッショナルなものになります。

プロのヒント: この構(gòu)造でテンプレート リポジトリを作成すると、同じ組織で新しいプロジェクトを迅速にブートストラップできます。

以上がNode.js バックエンド スケーラブルなアプリの構(gòu)築: プロジェクト構(gòu)造の実踐ガイドの詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國(guó)語(yǔ) Web サイトの他の関連記事を參照してください。