egg.js 怎么用

Egg.js 是一个基于 Koa 的企业级 Node.js 框架，它通过一系列的约定和插件系统帮助开发者快速构建高质量的应用。核心观点包括：模块化设计、插件机制、配置管理、强大的中间件系统、开发体验友好。其中，模块化设计是 Egg.js 的核心特点之一。Egg.js 通过约定大于配置的方式，帮助开发者将应用拆分为多个独立的模块，从而提高代码的可维护性和可扩展性。接下来，我们将详细介绍如何使用 Egg.js 构建一个企业级应用。

一、Egg.js 的安装与初始化

1. 安装 Node.js 和 Egg.js

在开始使用 Egg.js 之前，首先需要确保系统上已经安装了 Node.js。可以通过以下命令检查 Node.js 是否已经安装：

node -v

如果未安装 Node.js，可以从Node.js官网下载并安装。

接下来，使用 npm 或 yarn 安装 Egg.js 脚手架工具：

npm install -g egg-init 或者 yarn global add egg-init

2. 初始化 Egg.js 项目

使用 egg-init 初始化一个新的 Egg.js 项目：

egg-init my-egg-project --type=simple cd my-egg-project npm install

这将会创建一个名为 my-egg-project 的目录，并在其中初始化一个简单的 Egg.js 项目。

二、目录结构与配置管理

1. 目录结构

Egg.js 采用约定大于配置的理念，其目录结构有一定的约定。一个典型的 Egg.js 项目目录结构如下：

my-egg-project ├── app │ ├── controller │ ├── extend │ ├── middleware │ ├── model │ ├── router.js │ ├── service │ └── view ├── config │ ├── config.default.js │ ├── config.prod.js │ └── config.local.js ├── test ├── .gitignore ├── README.md ├── package.json └── app.js

2. 配置管理

Egg.js 提供了强大的配置管理功能，所有的配置文件都放置在 config 目录下。config.default.js 是默认的配置文件，而 config.prod.js 和 config.local.js 分别是生产环境和本地开发环境的配置文件。可以根据需要在这些文件中覆盖默认配置。

例如，在 config.default.js 中配置数据库连接：

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

三、路由与控制器

1. 定义路由

所有的路由定义都放在 app/router.js 文件中。Egg.js 使用类似于 Koa 的路由定义方式。例如：

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

2. 创建控制器

控制器负责处理请求逻辑。可以在 app/controller 目录下创建控制器文件。例如，创建 home.js 控制器：

const Controller = require('egg').Controller;
class HomeController extends Controller {
  async index() {
    const { ctx } = this;
    ctx.body = 'Hello, Egg.js';
  }
}
module.exports = HomeController;

四、服务与模型

1. 定义服务

服务用于封装业务逻辑，可以在 app/service 目录下创建服务文件。例如，创建 user.js 服务：

const Service = require('egg').Service;
class UserService extends Service {
  async find(uid) {
    // 假设从数据库中查询用户信息
    const user = await this.app.mysql.get('users', { id: uid });
    return user;
  }
}
module.exports = UserService;

2. 定义模型

Egg.js 支持使用各种 ORM 库来定义模型，例如 Sequelize。可以在 app/model 目录下定义模型文件。例如，使用 Sequelize 定义 user.js 模型：

module.exports = app => {
  const { STRING, INTEGER } = app.Sequelize;
  const User = app.model.define('user', {
    id: { type: INTEGER, primaryKey: true, autoIncrement: true },
    name: STRING(30),
    age: INTEGER,
  });
  return User;
};

五、中间件与插件

1. 使用中间件

中间件用于处理请求的预处理和后处理逻辑，可以在 app/middleware 目录下创建中间件文件。例如，创建一个日志中间件：

module.exports = (options, app) => {
  return async function logger(ctx, next) {
    const start = Date.now();
    await next();
    const duration = Date.now() - start;
    app.logger.info(`${ctx.method} ${ctx.url} - ${duration}ms`);
  };
};

然后在 config/config.default.js 中配置中间件：

exports.middleware = ['logger'];

2. 使用插件

Egg.js 拥有丰富的插件生态系统，可以通过插件来扩展框架功能。例如，使用 egg-mysql 插件来连接 MySQL 数据库。首先安装插件：

npm install egg-mysql --save

然后在 config/plugin.js 中启用插件：

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

六、测试与调试

1. 编写测试

Egg.js 内置了强大的测试框架，可以在 test 目录下编写测试用例。例如，创建 home.test.js 测试文件：

const { app, assert } = require('egg-mock/bootstrap');
describe('test/app/controller/home.test.js', () => {
  it('should GET /', async () => {
    const result = await app.httpRequest().get('/').expect(200);
    assert(result.text === 'Hello, Egg.js');
  });
});

2. 调试应用

在开发过程中，可以使用以下命令启动应用并进行调试：

npm run dev

Egg.js 提供了详细的日志和错误信息，帮助开发者快速定位和解决问题。

七、项目管理与部署

1. 项目管理

在项目管理中，选择合适的工具可以提高团队协作效率。推荐使用研发项目管理系统PingCode和通用项目协作软件Worktile来进行项目管理。PingCode 提供了全面的研发管理功能，包括需求管理、缺陷跟踪、任务管理等；而 Worktile 则适用于更广泛的项目协作场景，支持任务分配、进度跟踪、文档管理等功能。

2. 部署应用

将应用部署到生产环境时，可以选择使用 Docker、Kubernetes 等容器化技术。下面是一个使用 Docker 部署 Egg.js 应用的简单示例：

首先，创建一个 Dockerfile 文件：

FROM node:14 WORKDIR /app COPY . . RUN npm install EXPOSE 7001 CMD ["npm", "start"]

然后构建并运行 Docker 镜像：

docker build -t my-egg-app . docker run -p 7001:7001 my-egg-app

八、总结

Egg.js 是一个功能强大且灵活的企业级 Node.js 框架，通过模块化设计、插件机制和配置管理等特性，帮助开发者快速构建高质量的应用。在使用 Egg.js 时，充分利用其中间件系统和丰富的插件生态，可以显著提升开发效率和应用性能。同时，借助于研发项目管理系统PingCode和通用项目协作软件Worktile等工具，可以有效地进行项目管理和团队协作，从而确保项目的顺利进行和高质量交付。

通过本文的介绍，相信你已经对如何使用 Egg.js 构建企业级应用有了全面的了解。接下来，可以根据实际项目需求，灵活运用本文中的知识点，开始你的 Egg.js 开发之旅。