Egg.js 入门指南：快速搭建你的第一个web应用-原创手记-慕课网

概述

Egg.js 是一个基于 Node.js 的高性能框架，它采用插件式架构，提供模块化、易于扩展的开发体验。Egg.js 重点关注性能优化、依赖管理与开发效率提升，适用于构建中大型 Web 应用、API 服务及微服务。通过快速安装和项目初始化，Egg.js 鼓励开发者轻松创建、配置、路由与控制器，支持多种模板引擎，提供部署指南与学习资源推荐，助开发者高效构建高性能应用。

Egg.js 的适用场景

Egg.js 适用于构建中大型 Web 应用、API 服务、微服务等，尤其适合寻求高性能、高可扩展性和灵活性的项目。它的后端开发领域广泛，能够快速搭建功能丰富、高效稳定的服务端应用。

安装 Egg.js

在开始使用 Egg.js 开发项目之前，确保你已安装了 Node.js。接下来，通过以下步骤安装 Egg.js：

使用 npm 安装 Egg.js

npm install -g egg

对熟悉 Yarn 的开发者，可选择使用：

yarn global add egg

快速启动 Egg.js 项目

mkdir eggjs-example
cd eggjs-example

运行以下命令创建并初始化 Egg.js 项目：

egg new eggjs-example

这会自动生成一个基础的 Egg.js 项目结构，并在当前目录下创建项目文件和相应的配置文件。

创建项目

项目创建后，进入项目目录并启动应用：

cd eggjs-example
npm run dev

在浏览器中访问 http://localhost:7001，你会看到一个简单的欢迎页面，这是 Egg.js 默认的欢迎页面，显示 'Hello, Egg!'。

项目结构介绍

Egg.js 项目结构层次分明：

app：包含业务文件和逻辑，有配置、中间件、插件等。
config：项目配置文件，包括框架配置和环境配置。
plugins：插件目录，用于引入和管理各种功能的插件。
utils：项目中常用工具函数和类。
services：业务逻辑服务，与应用层分离。
controllers：处理客户端请求的控制器，是应用的核心。

简单配置文件操作

Egg.js 使用 JSON 配置文件进行配置。在 app/config/config.default.js 中修改应用的默认配置，例如调整日志级别：

module.exports = exports.config = {
    log: {
        level: 'debug'
    }
};

基础路由与控制器

定义路由与控制器

Egg.js 通过 app/router.js 文件定义路由。每个路由通过 app 对象的 route 方法添加，并通过 module.exports 导出。下面是示例代码：

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

处理 HTTP 请求的方法

Egg.js 使用原生的 Node.js HTTP 模块来响应请求。控制器函数接收 ctx 对象作为参数，包含请求和响应方法。处理 GET 请求的示例：

app.controller('index', {
    index: async (ctx) => {
        ctx.body = 'Hello, Egg!';
    }
});

处理 POST 请求的示例：

app.controller('post', {
    doPost: async (ctx) => {
        const { body } = ctx.request;
        ctx.body = `You sent: ${body.message}`;
    }
});

模板引擎

Egg.js 支持多种模板引擎，以下以 Nunjucks 作为示例进行介绍：

首先安装 nunjucks：

npm install nunjucks --save

配置与使用模板引擎：

创建 views 目录，并添加模板文件：

mkdir views

在 views 目录下创建 index.html 文件：

<!DOCTYPE html>
<html>
<head>
    <title>Egg.js Example</title>
</head>
<body>
    <h1>{{ title }}</h1>
</body>
</html>

在 app/config/config.default.js 中配置模板引擎：

module.exports = exports.config = {
    view: {
        engine: 'nunjucks',
        defaultExtension: 'html',
        root: 'app/views'
    }
};

修改控制器的路由以渲染模板：

app.controller('index', {
    index: async (ctx) => {
        ctx.body = ctx.render('index.html', { title: 'Hello, Egg!' });
    }
});

项目部署

选择合适的服务器

部署 Egg.js 应用时，选择 Nginx 作为代理服务器是常见的做法，Nginx 提供高性能和负载均衡的能力，非常适合处理大量并发请求。

配置服务器与项目发布流程

Nginx 配置示例

在 Nginx 配置文件（如 /etc/nginx/nginx.conf）中添加以下配置：

server {
    listen 80;
    server_name example.com;

    location / {
        include proxy_params;
        proxy_pass http://localhost:7001;
    }
}

常见部署问题及解决方法

错误 502 Bad Gateway：这通常表示 Nginx 无法将请求转发到服务器。检查 Nginx 的配置正确无误，并确保 Egg.js 服务器正常运行。
错误 404 Not Found：确认 Nginx 的配置正确指定了代理转发路径，并验证 Egg.js 的路由设置。

学习资源推荐

如果你在学习 Egg.js 的过程中遇到困难，或想进一步提升 Node.js 和框架使用能力，可参考以下资源：

慕课网：https://www.imooc.com/，提供大量 Node.js 和 Egg.js 相关的教程和实战课程，适合不同层次的学习者。
官方文档：Egg.js 的官方文档提供详细的 API 文档和开发指南。
社区论坛：参与 Node.js 和 Egg.js 社区，如 GitHub 项目页面下的 issues 部分，获取其他开发者的问题和解决方案。

通过实践和学习，你将能够熟练掌握 Egg.js，构建高性能 Web 应用。希望本文能助力你的学习之旅。