快捷導(dǎo)航

一文詳解如何初始化Egg.js?項(xiàng)目

更新時間：2025年08月13日 09:42:50 作者：看-清

egg.js是node.js的一個web后臺框架,為我們進(jìn)行web后臺開發(fā)帶來了太多的便利,這篇文章主要介紹了如何初始化Egg.js?項(xiàng)目的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下

前言

Egg.js 是一個由阿里巴巴團(tuán)隊(duì)開發(fā)的 Node.js Web 框架，旨在提供高性能的 Web 應(yīng)用和服務(wù)。它基于 Koa，具有更豐富的功能、工具和插件支持，非常適合企業(yè)級應(yīng)用的開發(fā)。

1. 安裝 Node.js

首先，你需要確保已經(jīng)安裝了 Node.js。如果你還沒有安裝 Node.js，請訪問[Node.js 官網(wǎng)](https://nodejs.org/en/) 下載并安裝它。

安裝完成后，可以通過以下命令來確認(rèn) Node.js 是否正確安裝：

node -v

如果你看到版本號的輸出，說明 Node.js 已經(jīng)成功安裝。

2. 安裝 Egg.js 工具

為了方便創(chuàng)建和管理 Egg.js 項(xiàng)目，我們將使用 Egg.js 提供的命令行工具 egg-init。你可以全局安裝該工具。

npm install -g egg-init

安裝完成后，使用下面的命令來初始化一個新的 Egg.js 項(xiàng)目：

egg-init my-egg-project --type=simple

my-egg-project 是你要創(chuàng)建的項(xiàng)目名稱，可以根據(jù)需要替換成你喜歡的名稱。

--type=simple 參數(shù)指定了一個簡單的模板，你也可以根據(jù)需求選擇其他模板，比如 koa 或 egg。

3. 進(jìn)入項(xiàng)目目錄并安裝依賴

初始化項(xiàng)目后，進(jìn)入到項(xiàng)目目錄：

cd my-egg-project

然后，使用 npm 或 yarn 安裝項(xiàng)目所需的依賴包：

npm install

或者，如果你使用 yarn，可以執(zhí)行：

yarn install

4. 啟動項(xiàng)目

一切準(zhǔn)備就緒后，使用下面的命令來啟動你的 Egg.js 項(xiàng)目：

npm run dev

5. 訪問和開發(fā)

至此，你的 Egg.js 項(xiàng)目已經(jīng)成功啟動。你可以通過修改 app/controller 目錄下的控制器文件，或者在 app/service 目錄下創(chuàng)建服務(wù)來擴(kuò)展應(yīng)用功能。

端口部分可以直接到/config/config.default.js文件中找到對應(yīng)的端口。

http://localhost:5000

6. 項(xiàng)目結(jié)構(gòu)

Egg.js 提供了一套推薦的項(xiàng)目結(jié)構(gòu)，這有助于組織代碼。以下是默認(rèn)的項(xiàng)目結(jié)構(gòu)：

my-egg-project/
├── app/                # 應(yīng)用代碼
│   ├── controller/     # 控制器，處理請求邏輯
│   ├── service/        # 服務(wù)，封裝業(yè)務(wù)邏輯
│   └── router.js       # 路由配置
├── config/             # 配置文件
│   ├── default.js      # 默認(rèn)配置
│   └── config.default.js
├── public/             # 靜態(tài)資源
├── views/              # 視圖模板
├── package.json        # 項(xiàng)目配置文件
└── README.md           # 項(xiàng)目說明文件

主要目錄和文件說明：

app/controller: 控制器是處理客戶端請求的地方。你可以在這里定義每個請求的響應(yīng)方法。
app/service: 服務(wù)層，處理業(yè)務(wù)邏輯。在這里可以進(jìn)行數(shù)據(jù)庫訪問、數(shù)據(jù)處理等操作。
config: 存放項(xiàng)目的配置文件，你可以在這里進(jìn)行全局的配置管理。
public: 用來存放靜態(tài)文件，比如圖片、樣式表、JavaScript 文件等。
views: 存放頁面模板文件，如果你使用模板引擎（比如 ejs 或 nunjucks），可以在這里編寫前端頁面。