如何初始化 Egg.js 项目

目录

1. 安装 Node.js

2. 安装 Egg.js 工具

3. 进入项目目录并安装依赖

4. 启动项目

5. 访问和开发

6. 项目结构

主要目录和文件说明：

---

Egg.js 是一个由阿里巴巴团队开发的 Node.js Web 框架，旨在提供高性能的 Web 应用和服务。它基于 Koa，具有更丰富的功能、工具和插件支持，非常适合企业级应用的开发。

1. 安装 Node.js

首先，你需要确保已经安装了 Node.js。如果你还没有安装 Node.js，请访问[Node.js 官网](https://nodejs.org/en/) 下载并安装它。

安装完成后，可以通过以下命令来确认 Node.js 是否正确安装：

node -v

如果你看到版本号的输出，说明 Node.js 已经成功安装。

2. 安装 Egg.js 工具

为了方便创建和管理 Egg.js 项目，我们将使用 Egg.js 提供的命令行工具 egg-init。你可以全局安装该工具。

npm install -g egg-init

安装完成后，使用下面的命令来初始化一个新的 Egg.js 项目：

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

• my-egg-project 是你要创建的项目名称，可以根据需要替换成你喜欢的名称。

• --type=simple 参数指定了一个简单的模板，你也可以根据需求选择其他模板，比如 koa 或 egg。

3. 进入项目目录并安装依赖

初始化项目后，进入到项目目录：

cd my-egg-project

然后，使用 npm 或 yarn 安装项目所需的依赖包：

npm install

或者，如果你使用 yarn，可以执行：

yarn install

4. 启动项目

一切准备就绪后，使用下面的命令来启动你的 Egg.js 项目：

npm run dev

5. 访问和开发

至此，你的 Egg.js 项目已经成功启动。你可以通过修改 app/controller 目录下的控制器文件，或者在 app/service 目录下创建服务来扩展应用功能。

端口部分可以直接到/config/config.default.js文件中找到对应的端口。

http://localhost:5000

6. 项目结构

Egg.js 提供了一套推荐的项目结构，这有助于组织代码。以下是默认的项目结构：

my-egg-project/
├── app/                # 应用代码
│   ├── controller/     # 控制器，处理请求逻辑
│   ├── service/        # 服务，封装业务逻辑
│   └── router.js       # 路由配置
├── config/             # 配置文件
│   ├── default.js      # 默认配置
│   └── config.default.js
├── public/             # 静态资源
├── views/              # 视图模板
├── package.json        # 项目配置文件
└── README.md           # 项目说明文件

主要目录和文件说明：

• app/controller: 控制器是处理客户端请求的地方。你可以在这里定义每个请求的响应方法。
• app/service: 服务层，处理业务逻辑。在这里可以进行数据库访问、数据处理等操作。
• config: 存放项目的配置文件，你可以在这里进行全局的配置管理。
• public: 用来存放静态文件，比如图片、样式表、JavaScript 文件等。
• views: 存放页面模板文件，如果你使用模板引擎（比如 ejs 或 nunjucks），可以在这里编写前端页面。