返回

Egg.js 框架搭建:开启 Node.js 应用开发之旅

前端

Egg.js 简介

Egg.js 是一个基于 Koa 2 的 Node.js 全栈框架,它集成了常用的中间件、模板引擎、数据库连接池、日志记录和安全防护等功能,旨在帮助开发者快速构建企业级应用。Egg.js 框架采用 MVC 架构,支持 TypeScript 和 JavaScript 两种语言,并提供了丰富的插件和扩展,可以满足各种场景的开发需求。

Egg.js 框架搭建

1. 安装 Node.js 和 npm

首先,您需要在您的计算机上安装 Node.js 和 npm。Node.js 是 JavaScript 的运行时环境,而 npm 是 Node.js 的包管理工具。您可以从 Node.js 官网下载最新版本的 Node.js 安装包,并按照安装向导进行安装。

2. 创建 Egg.js 项目

安装好 Node.js 和 npm 后,您就可以使用 npm 来创建 Egg.js 项目了。打开终端窗口,输入以下命令:

npm init egg my-egg-app

这将创建一个名为 my-egg-app 的 Egg.js 项目。

3. 安装依赖包

创建好 Egg.js 项目后,您需要安装必要的依赖包。Egg.js 框架默认使用 MySQL 数据库,因此您需要安装 MySQL 驱动程序。您还可以根据需要安装其他依赖包,例如:

npm install mysql

4. 配置数据库

接下来,您需要配置数据库连接。在项目根目录下的 config/config.default.js 文件中,找到以下配置项:

// config/config.default.js
module.exports = {
  mysql: {
    client: {
      host: 'localhost',
      port: 3306,
      user: 'root',
      password: '',
      database: 'my_egg_app',
    },
    // 其他 MySQL 配置选项
  },
};

请根据您的实际情况修改数据库连接配置。

5. 配置日志

Egg.js 框架提供了丰富的日志记录功能。在项目根目录下的 config/config.default.js 文件中,找到以下配置项:

// config/config.default.js
module.exports = {
  logger: {
    consoleLevel: 'DEBUG',
    fileLevel: 'INFO',
  },
};

请根据您的需要修改日志记录配置。

6. 启动服务器

配置好数据库和日志后,您就可以启动 Egg.js 服务器了。在终端窗口中,输入以下命令:

npm start

这将启动 Egg.js 服务器。

7. 创建第一个 Hello World 应用

现在,您就可以创建您的第一个 Egg.js 应用了。在项目根目录下创建 app/controller/home.js 文件,并输入以下代码:

// app/controller/home.js
module.exports = {
  index() {
    return 'Hello World!';
  },
};

这将创建一个名为 home 的控制器,其中包含一个名为 index 的方法。

在项目根目录下创建 app/router.js 文件,并输入以下代码:

// app/router.js
module.exports = {
  '/': 'home.index',
};

这将创建一个路由规则,将根路径 '/' 映射到 home 控制器中的 index 方法。

现在,您可以打开浏览器,访问 http://localhost:7001,您将看到 "Hello World!" 字样。

结语

以上就是 Egg.js 框架搭建的基本步骤。您还可以参考 Egg.js 官方文档来了解更多关于 Egg.js 框架的内容。