返回

从头到尾使用egg框架搭建项目应用

前端

前言

Egg.js 是一个基于 Node.js 和 Koa.js 的、全栈、高性能、易扩展的企业级框架,拥有丰富的中间件生态、模块化的插件体系、代码热加载等特色功能,广泛用于开发 Web 应用、RESTful API 等应用场景。本文将以一个实际案例,从头到尾带您一步步搭建一个 egg 项目。

1. 创建项目

首先,我们先来创建我们的项目目录和初始化 package.json 文件。

mkdir my-egg-project
cd my-egg-project
npm init -yes

2. 安装 egg

在项目目录中,我们可以使用 npm 来安装 egg CLI 工具:

npm install -g @eggjs/cli

3. 初始化 egg 项目

使用 egg-init 命令初始化一个 egg 项目:

egg-init egg-demo

这将创建一个 egg-demo 项目,项目目录结构如下:

egg-demo/
├── app/
│   ├── controller/
│   │   └── HomeController.js
│   ├── extend/
│   │   └── helper.js
│   ├── middleware/
│   │   └── response_formatter.js
│   ├── router.js
│   ├── service/
│   │   └── UserService.js
│   └── view/
│       └── home.html
├── config/
│   ├── config.default.js
│   ├── config.prod.js
├── database/
│   └── models/
│       └── User.js
├── logs/
├── node_modules/
├── package.json
├── public/
└── test/

4. 安装依赖

接下来,我们需要安装项目依赖:

npm install

5. 启动项目

在项目目录中,我们可以使用 npm 来启动项目:

npm start

6. 访问项目

当项目启动成功后,您可以在浏览器中访问 http://localhost:7001 来查看项目。

7. 开发应用

现在,您可以开始在项目中开发您的应用了。您可以按照如下步骤:

  1. app/controller 目录下创建控制器文件。
  2. app/service 目录下创建服务文件。
  3. app/router.js 文件中配置路由。
  4. app/view 目录下创建视图文件。

总结

以上就是手动搭建一个 egg 项目的步骤。通过本教程,您已经可以开始使用 egg 框架开发您的应用了。如果您遇到任何问题,可以在 egg.js 的官方文档中找到答案。