egg.js的基本使用实例

下面我为大家讲解一下 Egg.js 的基本使用实例：

简介

Egg.js 是一个基于 Node.js 和 Koa.js 的企业级应用开发框架，它提供了一套易于上手的约定和最佳实践，并基于这些约定和最佳实践提供了适用于企业级应用的各种插件和扩展，同时还支持基于插件的扩展机制，让用户可以根据自己的需要对框架进行个性化定制。

安装

安装 Egg.js 的前提条件是已经安装了 Node.js 和 npm。安装 Egg.js 只需要执行一行命令，在命令行中输入：

$ npm i egg --save

这样就全局安装了 Egg.js，接下来我们可以通过 Egg.js 的命令行工具来生成一个项目或者一个插件。

项目搭建

在生成 Egg.js 项目之前，需要确认安装了 egg-init 工具，默认已经内置到 egg 模块中，如果没有则需要全局安装：

$ npm i egg-init -g

然后，在命令行中执行以下命令，生成一个基于 Egg.js 的项目：

$ egg-init egg-example --type=simple

其中 egg-example 是项目名称，simple 是模板类型，模板类型有多种，根据自己的需求选择。

生成项目后，进入项目目录，执行以下命令启动服务：

$ npm run dev

然后在浏览器中访问 http://localhost:7001，就可以看到项目已经成功启动。

示例一：路由配置

在 Egg.js 中，路由配置非常简单，只需要在 app/router.js 文件中配置路由即可。例如，我们想要配置一个 GET 请求 /user 的路由，返回一个用户列表页面，只需要在 app/router.js 中添加以下代码：

module.exports = app => {
  const { router, controller } = app;
  router.get('/user', controller.user.list);
};

这样，当用户访问 http://localhost:7001/user 时，就会返回用户列表页面。

示例二：数据库操作

Egg.js 提供了很多常规的数据库插件来简化我们操作数据库的流程。例如，我们要使用 MySQL 数据库，只需要在项目中安装 egg-mysql 插件：

$ npm i egg-mysql --save

然后在 config/plugin.js 中配置：

exports.mysql = {
  enable: true,
  package: 'egg-mysql',
};

接下来配置数据库连接，在 config/config.default.js 中添加以下代码：

exports.mysql = {
  client: {
    host: '127.0.0.1',
    port: '3306',
    user: 'root',
    password: 'password',
    database: 'test',
  },
  app: true,
  agent: false,
};

这里配置了一个名为 mysql 的连接，连接本地的 test 数据库，用户名和密码为 root 和 password。

接着在控制器中就可以使用我们的数据库插件了，例如，我们要查询所有的用户，代码如下：

const users = await app.mysql.select('user');

这样就可以查询到所有的用户数据了。

以上就是 Egg.js 的基本使用实例，希望对大家有所帮助。