egg.js使用指南

JavaScript07

egg.js使用指南,第1张

官方教程 有点跳跃,很多东西没讲清楚,不太适合小白理解,特此整理、归纳一下。

打开这篇博客的正确方式是:先读一遍 官方教程 ,读不懂的可以略过,然后再带着问题来看这篇文章。然后再回去读官方文档,去理解。最终目的是理解官方文档,我的文章并不权威,只是起到帮助理解文档的作用。

答案:功能更丰富、更规范的koa

使用koa时,你要写一个项目,要往里面加很多中间件,要写脚本加载routes文件夹下面的所有路由以及model文件夹下面的所有sequelize模型,koa仅仅是一个骨架,其他的都是你来完成,自由度高,但集成度低,每创建一个新项目都要做很多重复工作。egg.js是封装了一套koa,可以理解成大礼包版koa,集成度高,可以轻松创建一个项目而不用做很多繁琐的初期工作,解放生产力,更可贵的是有一套现成的规范提供给我们,不需要我们自己再去探索一套规范,比如router放哪里,controller放哪里,需不需要service,哪些放在service等等。

根据egg.js 目录结构 先了解其项目规范,为了了解这些目录/文件是做什么,先从我们最熟悉的request讲起:

在进行下面的阅读前请保证已经理解了egg.js中的 内置对象 。

内置对象可以被方便地获取到,不过功能有限,我们可以通过egg.js的扩展(Extend)功能去进一步加强、定制框架的能力。

egg.js中有非常多新鲜的特性:“扩展”、“插件”、“多环境配置”,这些特性名称虽然不一样,但本质都是一样的:有则覆盖,无则增加。类似于 lodash中的defaults函数 ,也类似于继承。

因此,如果我们想扩展Application对象,根据egg.js规范,应该在projectDir/app/extend/下增加application.js:

以后就可以方便地调用 app.specialName 获取这个值。

Extend特性可以扩展上层框架的内置对象,而 插件 则可以扩展除router和controller之外的整个app。插件拥有自己的package.json,因此可以独立发布到npm,每个人都可以install,享用你的扩展。

如果我要为项目写一个管理微信公众号的功能,我会写一个WxService:

很多项目都可以用到这个Service,因此我会提取为一个插件,然后通过引入插件的形式去引入,我在应用中同样可以调用这个Service,等于是把插件中的文件往应用中复制了一份,和写在应用中没什么两样。

关于如何提取插件,请参见: 渐进式开发

定制自己的框架可以确定项目的技术选型、减少项目初期的工作,定制框架的思想其实和扩展内置对象、开插件是一样的,但是前置工作会比较多一些,参见: egg.js框架开发 。

这些前置工作比较重复、有固定格式,没有必要自己写,建议用骨架搭建。

当我们基于自己定制的框架framework1,并且在应用中依赖了插件plugin2、plugin3,开发了一个应用:

其中framework1直接基于egg并且内置了plugin1,此时整个app的加载顺序是怎样的呢?

加载原则总结一句话是:从被依赖到依赖。

先来分析一下,谁被依赖,谁依赖:

为了最大程度利用多核、增强Node进程健壮性,一般我们会使用PM2一类的工具,如果使用egg.js,就完全不需要担心了,egg利用cluster模块( 了解cluster原理请看这篇文章 )已经创建了一个非常稳定的多进程模型。

官方推荐测试框架: Mocha ( Mocha中文网 )

官方推荐断言库: power-assert

Egg.js 中已经内置 Mocha 、 co-mocha 、 power-assert , nyc 等模块,只需要在 package.json 上配置好 scripts.test 即可。

运行测试:

指定文件路径,可以对某一个单元测试文件进行测试:

约定 test 目录为存放所有测试脚本的目录。

测试脚本文件统一按 ${filename}.test.js 命名,必须以 .test.js 作为文件后缀。

describe 和 it 的第一个字段都只是描述,每一个 it 是一个测试用例。

Mocha 使用 before/after/beforeEach/afterEach 来处理前置后置任务,基本能处理所有问题。 每个用例会按 before -> beforeEach -> it -> afterEach -> after 的顺序执行,而且可以定义多个。

也可以直接对 Service 层进行测试。

首先,在需要调试的地方打好断点 如上图,点击左侧的行数,158行就可以打上断点了 点击 vscode 左侧的debug窗口,如果你之前没有配置过 launch.json 文件,那么现实效果就会如下图一样。 点击左上方,【没有配置】,添加配置 VSCode本身就内置了Node.js的调试工具,如果将来你需要调试别的东西,可以在这里选择添加对应的调试插件工具。 这里我们调试的是Node.js,就选择Node.js,然后VSCode会在 /.vscode 目录中新建一个 launch.json 文件launch.json 文件新建好后,我们需要进行一些配置操作,这里我们选择的是,附加到进程。 后面我们是先启动egg的调试进程,然后再将vscode附加到进程中的。 这里有一个很关键的节点, program 这个属性写的就是你需要调试的js文件,我这边调试的是刚才打上断点的文件 pledges.js使用 iterm 进入到工程目录,开启调试模式 在VSCode中选择 Attach to Process ,并且选择egg-cluster这个进程。 等请求进入到刚才打断点的地方,VSCode就会自己跳转到调试点啦,然后就可以尽情调试啦~ BTW,如果你有更好,更简单的调试方式请告诉我...