从 0 到 1 搭建基于 Egg.js 的后台系统，为企业级应用保驾护航

前端

2024-01-14 14:29:57

在当今数字时代，企业级应用已成为现代化业务运营不可或缺的一部分。它们提供关键功能，简化流程，并提高整体效率。对于这些应用来说，拥有一个强大且可扩展的后端系统至关重要。

本文将带你从零开始搭建一个基于 Egg.js 的后台系统，Egg.js 是一个流行且备受推崇的 Node.js 后端开发框架。它专为企业级应用而设计，提供了一系列功能和工具，可以显著降低开发和维护成本。

选择 Egg.js 的理由

Egg.js 由阿里云开源，其核心优势包括：

前后端分离： Egg.js 严格遵循前后端分离原则，便于开发和维护。
内置中间件： 它提供了大量内置中间件，简化了常见任务的处理，如日志记录、身份验证和错误处理。
可扩展性： Egg.js 被设计为高度可扩展，支持轻松集成第三方插件和服务。
企业级功能： Egg.js 提供了企业级功能，如集群、热重载和监控，确保系统的稳定性和可靠性。

搭建后台系统的步骤

1. 安装 Egg.js

首先，安装 Egg.js 及其 CLI 工具：

npm install -g egg-bin
mkdir my-egg-app
cd my-egg-app
egg init

2. 创建项目结构

Egg.js 遵循约定式目录结构，其中包含以下关键目录：

app： 存放控制器、服务和模型等应用逻辑。
config： 存放应用配置。
public： 存放静态文件。
test： 存放测试用例。

3. 定义模型

模型用于定义数据库中的数据结构和操作。在 app/model 目录下创建模型文件，如 User.js：

// app/model/user.js
module.exports = app => {
  const { STRING, INTEGER } = app.Sequelize;

  const User = app.model.define('user', {
    id: {
      type: INTEGER,
      primaryKey: true,
      autoIncrement: true
    },
    username: STRING(30),
    password: STRING(64)
  });

  return User;
};

4. 编写控制器

控制器负责处理用户请求和渲染视图。在 app/controller 目录下创建控制器文件，如 userController.js：

// app/controller/userController.js
const BaseController = require('./baseController');

class UserController extends BaseController {
  async index() {
    const users = await this.service.user.list();
    return this.success(users);
  }
}

module.exports = UserController;

5. 定义服务

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

// app/service/userService.js
class UserService {
  async list() {
    const users = await this.app.model.User.findAll();
    return users;
  }
}

module.exports = UserService;