theme: channing-cyan
一.Egg.js是什么？
Egg.js 为企业级框架和应用而生，我们希望由 Egg.js 孕育出更多上层框架，帮助开发团队和开发人员降低开发和维护成本。
注：Egg.js 缩写为 Egg
1.设计原则
我们深知企业级应用在追求规范和共建的同时，还需要考虑如何平衡不同团队之间的差异，求同存异。所以我们没有选择社区常见框架的大集市模式(集成如数据库、模板引擎、前端框架等功能)，而是专注于提供 Web 开发的核心功能和一套灵活可扩展的插件机制。我们不会做出技术选型，因为固定的技术选型会使框架的扩展性变差，无法满足各种定制需求。通过 Egg，团队的架构师和技术负责人可以非常容易地基于自身的技术架构在 Egg 基础上扩展出适合自身业务场景的框架。
Egg 的插件机制有很高的可扩展性，一个插件只做一件事(比如 Nunjucks 模板封装成了 egg-view-nunjucks、MySQL 数据库封装成了 egg-mysql)。Egg 通过框架聚合这些插件，并根据自己的业务场景定制配置，这样应用的开发成本就变得很低。
Egg 奉行『约定优于配置』，按照一套统一的约定进行应用开发，团队内部采用这种方式可以减少开发人员的学习成本，开发人员不再是『钉子』，可以流动起来。没有约定的团队，沟通成本是非常高的，比如有人会按目录分栈而其他人按目录分功能，开发者认知不一致很容易犯错。但约定不等于扩展性差，相反 Egg 有很高的扩展性，可以按照团队的约定定制框架。使用 Loader 可以让框架根据不同环境定义默认配置，还可以覆盖 Egg 的默认约定。
2.与社区框架的差异
Express 是 Node.js 社区广泛使用的框架，简单且扩展性强，非常适合做个人项目。但框架本身缺少约定，标准的 MVC 模型会有各种千奇百怪的写法。Egg 按照约定进行开发，奉行『约定优于配置』，团队协作成本低。
Sails 是和 Egg 一样奉行『约定优于配置』的框架，扩展性也非常好。但是相比 Egg，Sails 支持 Blueprint REST API、WaterLine 这样可扩展的 ORM、前端集成、WebSocket 等，但这些功能都是由 Sails 提供的。而 Egg 不直接提供功能，只是集成各种功能插件，比如实现 egg-blueprint，egg-waterline 等这样的插件，再使用 sails-egg 框架整合这些插件就可以替代 Sails 了。
3.特性
egg官网： https://eggjs.org/zh-cn
二.开始项目后端预备
Egg的环境要求：Node >= 8.x, npm >= 6.1.0。
我当前的环境：Node v12.19.0，npm 8.3.0
这里使用Egg为我们提供的脚手架生成指令，几行代码就能初始化一个 Egg 项目，如下： bash $ mkdir egg-example && cd egg-example $ npm init egg --type=simple $ npm i 成功后，用你自己喜欢的编辑器打开项目目录。
三.目录结构
Egg 作为一套解决方案，它内部高度集成了封装好的项目目录结构，现代开发俗称“约定式开发”。正常情况下，你从 0 开始搭建一个 Node 服务端代码，需要结合很多工具插件来辅助完成项目的搭建，而 Egg 则提前为你提供好了这些繁琐的初始工作，让你能专心与业务层面的开发。
当然，“约定式开发”也有不好的地方，很多配置项都是内部约定好的，在你想要用到某一个功能时，你可能需要去查阅 Egg 的官方文档是如何配置的，这就会消耗一点时间，但是相比之下，使用它的利大于弊。
下面我们就先来认识一下，Egg 都为我们提供了哪些文件：
1.app/router.js
用于配置 URL 路由规则，比如上述初始化代码中的 get 请求，npm run dev 启动项目之后，你可以直接在浏览器中访问启动的端口 + 路径，默认是 http://localhost:7001/，你将会拿到 app/controller 文件夹下，home.js 脚本中 index 方法返回的内容。 ```js 'use strict';
const Controller = require('egg').Controller;
class HomeController extends Controller { async index() { const { ctx } = this; ctx.body = 'hi,egg'; } }
module.exports = HomeController; ```
这就是路由配置的作用，当然，抛出的形式有多种，如router.get、router.post、router.delete、router.put 等，都是支持的，更加具体的内容可阅读 Router 配置。
2.app/controller/xx
用于解析用户的输入，处理后返回相应的结果。上述我们也提到了，通过请求路径将用户的请求基于 method 和 URL 分发到对应的 Controller 上，而 Controller 要做的事情就是响应用户的诉求。举个例子，我想拿到 A 用户的个人信息，于是我们要在控制器(Controller)里，通过请求携带的 A 用户的 id 参数，从数据库里获取指定用户的个人信息。我画了一个简易流程图如下：
上述是一个 get 接口，浏览器地址栏直接请求便可，通过 /user 路径，找到对应的控制器，这里需要提前定义好 /user 对应的控制器。控制器需要做的就是处理数据和响应请求返回数据。更加详细的描述请移步至 Controller 文档
3.app/service/xx
简单来说，Service 就是在复杂业务场景下用于做业务逻辑封装的一个抽象层。上述初始化项目中未声明 service 文件夹，它是可选项，但是官方建议我们操作业务逻辑最好做一层封装。我们换一种理解方式，Service 层就是用于数据库的查询，我们尽量将粒度细化，这样以便多个 Controller 共同调用同一个 Service。后续我们链接数据库操作的时候，再进行详细分析。更加详细的描述请移步至 Service 文档。
4.app/middleware/xx
用于编写中间件，中间件的概念就是在路由配置里设置了中间件的路由，每次请求命中后，都要过一层中间件。在我们后续的开发中，也会利用到这个中间件的原理做用户鉴权。当用户未登录的情况下，是不能调用某些接口的。
当然，你可以每次都在 Controller 判断，当前请求是否携带有效的用户认证信息。接口一多，到处都是这样的判断，逻辑重复。所以，中间件在某种程度上，也算是优化代码结构的一种方式。更加详细的描述请移步至 Middleware 文档。
5.app/public/xx
用于放置静态资源。后续我们将会有一个上传静态资源的接口，包括图片、文本文档、excel、word等，都可以通过服务端读取文件之后，将其写入 app/public 文件夹中。在目前没有 OSS 服务的情况下，姑且先用这种方式存储静态资源，会消耗一点服务器的内存。
config/config.{env}.js
用于编写配置文件。目前本小册项目只配置了 config/config.default.js 文件，这个是 Egg 框架约定好的，你可以在内部设置一些全局的配置常量，在任何地方都可以通过 app.config 获取到 config.default.js 文件内的配置项。
6.config/plugin.js
用于配置需要加载的插件。比如 egg-mysql、egg-cors、egg-jwt 等官方提供的插件，你也可以自己编写 Egg 插件，社区很多优秀的插件都可以在 Github 中搜到，点击前往。
上述目录内容都是后续开发会使用到的，先做一个基本的了解，做到心中有数便可，后续实战开发部分具体使用到的时候，会结合实践进行分析讲解。
四.编写基础的 GET 和 POST 接口
“冰冻三尺，非一日之寒”，一上手就写稍复杂的项目需求，是不现实的。我们先上手一些简单的知识点，以此来熟悉如何使用 Egg，为后续的实战部分作准备。
1.GET请求参数获取
打开之前初始化的 egg-example 项目，通过 npm run dev 启动项目之后，浏览器添加如下请求地址： text http://localhost:7001/?id=mint 打开 app/controller/home.js，通过如下形式获取到浏览器查询参数。 ```js 'use strict';
const Controller = require('egg').Controller;
class HomeController extends Controller { async index() { const { ctx } = this; const { id } = ctx.query; ctx.body = id; } }
module.exports = HomeController; ``` 
还有另一种获取申明参数，比如我希望通过这样一个地址获取用户参数 /user/5，想获取用户 id 为 5 的用户信息。我们可以这样操作，首先添加路由，打开 app/router.js 添加一个路由： js 'use strict'; /** * @param {Egg.Application} app - egg application */ module.exports = app => { const { router, controller } = app; router.get('/', controller.home.index); router.get('/user/:id', controller.home.user); }; 其次在 app/controller/home.js 下添加一个 user 方法如下： ```js 'use strict';
const Controller = require('egg').Controller;
class HomeController extends Controller { async index() { const { ctx } = this; const { id } = ctx.query; ctx.body = id; } // 获取用户信息 async user() { const { ctx } = this; const result = await ctx.service.home.user(); ctx.body = result; } }
module.exports = HomeController; ``` 通过如下请求获取参数，打印在网页上：
通过上述操作，其实用 GET 接口，就能把一切都做了，包括 POST 能做的，GET 也是可以轻松应对，只不过为了数据安全以及大小的限制，有些请求还是需要用 POST 来完成。
2.POST 请求参数获取
POST 接口需要借助 Postman 工具进行请求，因为通过浏览器无法手动发起 POST 请求，只能通过浏览器地址栏发起 GET 请求。来编写一个 POST 请求：
js // app/router.js // ... router.post('/add', controller.home.add);
js // app/controller/home.js // post 请求方法 async add() { const { ctx } = this; const { title } = ctx.request.body; // Egg 框架内置了 bodyParser 中间件来对 POST 请求 body 解析成 object 挂载到 ctx.request.body 上 ctx.body = { title }; }
我们打开 Postman 设置如下：
点击 「Send」按钮之后，控制台报错如下：
注意关键字「安全威胁 csrf 的防范」，简单说就是网络请求的安防策略，比如你 Egg 启动的是本地地址 http://127.0.0.1:7001 ，但是你请求的 POST 或 GET 接口是非本地计算机(别人的电脑)，或者使用 Postman 发起请求，都会触发安防策略。
编程的过程就是解决问题的过程，不要怕麻烦，自己踩过坑之后，才能变得更加强大。
前往 config/config.default.js 做好白名单配置，这里我直接全部允许请求： js config.security = { csrf: { enable: false, ignoreJSON: true }, domainWhiteList: [ '*' ], // 配置白名单 }; 重启项目，再次用 Postman 发起请求，如下所示：
成功拿到服务端返回的参数。
3.从 Service 内获取数据
目前还没有链接 MySQL 数据库，所以这边模拟一下在 Service 中获取数据库的数据。
在 app 目录下新建 service，并且创建一个 home.js，为其添加如下代码： ```js // app/service/home.js 'use strict'; const Service = require('egg').Service;
class HomeService extends Service { async user() { // 假设从数据库获取的用户信息 return { name: '嘎子', slogen: '网络的世界太虚拟,你把握不住' }; } } module.exports = HomeService; 我们可以在 `Controller` 内拿到上述方法，如下所示： js // app/controller/home.js // 获取用户信息 async user() { const { ctx } = this; const { name, slogen } = await ctx.service.home.user(); ctx.body = { name, slogen } } `` 打开 Postman` 请求如下所示：
HomeService 中的 user 方法内部，在后续链接数据库之后，可以 this 上下文，拿到 MySQL 的实力方法，对数据库进行 CRUD 操作。
现在来开发一些简单的网页，想快速部署到云服务器上，就可以使用前端模板的开发形式。下面介绍该种方式如何操作：
首先安装插件 egg-view-ejs：
上述的配置，指的是将 view 文件夹下的 .html 后缀的文件，识别为 .ejs。
接着，在 app 目录下创建 view 文件夹，并且新建一个 index.html 文件，作为前端模板，如下所示： ```html
<%-title%>
```
会在 Controller 内把变量注入到 index.html 文件，模板通过 <%-xx%>关键字获取到传入的变量。
下面修改 controller/home.js 下的 index 方法如下： js async index() { const { ctx } = this; // ctx.render 默认会去 view 文件夹寻找 index.html，这是 Egg 约定好的。 await ctx.render('index.html', { title: '后台服务正常Running.', }); const { id } = ctx.query; ctx.body = id; }
4.不用框架，模板一把梭
上述开发模式便是前后端不分离的模式，在页面不复杂的情况下，整个项目不采用如 React 、Vue 这些前端框架，也是可以的。在上述代码 ctx.render 之前，我们可以从数据库获取想要的信息，作为参数塞入模板中，模板拿到数据，便可以自由发挥，构建 HTML。如果是提交事件，可以通过原生 ajax 或者是引入一把梭专家 jQuery，提交数据。
五.总结
基本上对 Egg 有了一个大致的了解。当然，光了解这些基础知识不足以完成整个项目的编写，但是基础还是很重要的嘛。毕竟 Egg 是基于 Koa 二次封装的，很多内置的设置项需要通过小用例去熟悉，逐行的去敲，去琢磨，才能真正的变成自己的知识。
2452
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
