作為初級(jí)開(kāi)發(fā)人員，建立 Node.js 後端最具挑戰(zhàn)性的方面之一不是編寫程式碼本身 - 而是以可擴(kuò)展的方式組織程式碼。今天，我們將探索一個(gè)可用於生產(chǎn)的 Node.js 專案結(jié)構(gòu)，您可以將其用作應(yīng)用程式的範(fàn)本。

非結(jié)構(gòu)化程式碼的問(wèn)題
在我們深入研究之前，想像嘗試在圖書館中找到一本特定的書，那裡的書是隨機(jī)放置在書架上的。令人沮喪，對(duì)吧？這同樣適用於程式碼。如果沒(méi)有適當(dāng)?shù)慕Y(jié)構(gòu)，您的 Node.js 應(yīng)用程式很快就會(huì)變成義大利麵條式程式碼的迷宮，難以維護(hù)和擴(kuò)展。

更好的方法：現(xiàn)代 Node.js 專案結(jié)構(gòu)
讓我們分解許多成功公司使用的專業(yè)級(jí) Node.js 專案結(jié)構(gòu)：

？後端/
├─？ src/
│ └── ? @types # TypeScript 類型定義
│ └──？ config # 設(shè)定檔
│ └── ?控制器 # 請(qǐng)求處理程序
│ └── ?實(shí)體 # 資料庫(kù)模型/實(shí)體
│ └── ? helper # 輔助/實(shí)用函數(shù)
│ └── ? middlewares # Express 中間件
│ └── ? paths # API 路由定義
│ └── ? services # 業(yè)務(wù)邏輯
│ └── ? types # 附加型別定義
│ └── ? utils # 實(shí)用函數(shù)
└──？ app.ts # 應(yīng)用程式入口點(diǎn)
└──？ .eslintrc.js # ESLint 設(shè)定
└──？ .prettierrc # 更漂亮的配置
└──？ Dockerfile # Docker 配置
└──？ package.json # 專案依賴
└──？ tsconfig.json # TypeScript 配置
└──？ .dockerignore # Docker 忽略規(guī)則
└──？ .env # 環(huán)境變數(shù)
└──？ docker-compose.yml # Docker Compose 配置

了解每個(gè)組件
1. @型別與型別目錄

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

這些資料夾包含 TypeScript 類型定義。 @types 資料夾通常包含外部模組的聲明，而 types 保存特定於應(yīng)用程式的類型。

2。配置目錄

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

目錄包含所有設(shè)定文件，可以輕鬆管理不同的環(huán)境（開(kāi)發(fā)、登臺(tái)、生產(chǎ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 請(qǐng)求和回應(yīng)，充當(dāng)路由和服務(wù)之間的橋樑。

4。實(shí)體

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

  @Column()
  username: string;

  @Column()
  email: string;
}

實(shí)體目錄包含您的資料庫(kù)模型，通常使用 TypeORM 或 Sequelize 等 ORM。

5。服務(wù)

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

服務(wù)包含您的業(yè)務(wù)邏輯，使其與控制器分開(kāi)。

6。中介軟體

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

中間件處理橫切問(wèn)題，例如驗(yàn)證、日誌記錄和錯(cuò)誤處理。

最佳實(shí)務(wù)與技巧

1。單一職責(zé)： 每個(gè)目錄都應(yīng)該有明確的、單一的目的。不要將業(yè)務(wù)邏輯與路由定義混合在一起。

2。依賴注入：使用依賴注入讓你的程式碼更容易測(cè)試和維護(hù)。

// 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)境配置：使用.env檔案作為環(huán)境特定的變量，並且永遠(yuǎn)不要將它們提交到版本控制。

4。 Docker 整合： Dockerfile 和 docker-compose.yml 的存在表明容器化支持，使跨環(huán)境的部署保持一致。

要避免的常見(jiàn)陷阱
循環(huán)依賴：小心不要在模組之間創(chuàng)建循環(huán)依賴。
海量文件：如果文件變得太大，則可能是做得太多了。將其分成更小、更集中的模組。
不一致的錯(cuò)誤處理：在您的應(yīng)用程式中建立一致的錯(cuò)誤處理策略。

結(jié)論

結(jié)構(gòu)良好的 Node.js 應(yīng)用程式對(duì)於長(zhǎng)期可維護(hù)性和可擴(kuò)展性至關(guān)重要。此結(jié)構(gòu)提供了堅(jiān)實(shí)的基礎(chǔ)，您可以隨著應(yīng)用程式的成長(zhǎng)而建立該基礎(chǔ)。請(qǐng)記住，我們的目標(biāo)不僅僅是讓它發(fā)揮作用，而是讓它可維護(hù)、可擴(kuò)展並且使用起來(lái)愉快。

下次啟動(dòng)新的 Node.js 專案時(shí)，請(qǐng)考慮使用此結(jié)構(gòu)作為範(fàn)本。它將節(jié)省您無(wú)數(shù)的重構(gòu)時(shí)間，並使您的程式碼庫(kù)從第一天起就更加專業(yè)。

專業(yè)提示：使用此結(jié)構(gòu)建立範(fàn)本儲(chǔ)存庫(kù)，以便您可以快速啟動(dòng)具有相同組織的新專案。

以上是Node.js 後端建立可擴(kuò)展的應(yīng)用程式：專案結(jié)構(gòu)實(shí)用指南的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！