背景
分页是 Web 开发中常见的功能，基本上所有 Web 框架都有分页的实现，或内置于框架之内，或使用插件的形式。
最近在使用 Egg.js 做后端开发，由于数据库用的是 MongoDB，所以自然选用官方的 egg-mongoose 作为 ODM Plugin，在开发过程中恰好就遇到一个分页问题。
Koa 中的实现
为了便于理解，首先先讲讲 Koa 中的实现。
使用 Koa 框架时直接基于 Mongoose 本身的 Plugin 机制实现了一个（大家也可以选择三方的实现：mongoose-paginate-v2）
分页 Plugin 使用起来也很方便，在 Mongoose 初始化时加载该 Plugin 即可：
const mongoose = require('mongoose')
const config = require('config')
const paginate = require('../middlewares/paginate')
// 启用分页插件
mongoose.plugin(paginate)
mongoose.connect(config.get('db'), { useNewUrlParser: true })
mongoose.Promise = global.Promise
const db = mongoose.connection
这样全局的 Model 中都可以使用此 Plugin，即：将 paginate 扩展成 Mongoose 模型的一个方法，如：
const apps = await AppModel.paginate({}, {page})
Egg 中的问题
在 Egg 中，由于使用了 egg-mongoose 插件，所以初始化过程已经被插件本身处理过了，那么如果想让插件生效，可以直接在对应的 Model 中增加：
module.exports = app => {
const mongoose = app.mongoose
// 启用分页插件
mongoose.plugin(paginate)
const Schema = mongoose.Schema
const schema = new Schema({
})
return mongoose.model('App', schema);
}
这么逻辑上是没有问题的，也能够全局生效，但是当有多个 Model时，加载 Plugin 的逻辑到底放在哪个 Model 中合适呢？
貌似放在哪个都不合适，毕竟这是个全局的设置，万一加载 Plugin 的 Model 废弃了，如果忘记将此逻辑迁移的话，就会造成一个 Bug，时间一长排查起来就比较麻烦。
那么，要是放在所有的 Model 中呢，这样不就解决问题了吗？
其实这样也不妥，太过冗余，维护起来也不方便。
所以我们还是有必要找一个全局的地方放置，尽可能保证在 App 初始化阶段就能生效，这样只要服务处于运行状态，该插件就必然生效，不会存在 paginate is not a function 的风险
解决问题
仔细看了一下 Egg 的文档，发现 Egg 支持启动时对各种生命周期的自定义（真心赞），应该可以解决我们的问题，于是在项目目录下创建 app.js 文件：
class AppBootHook {
constructor(app) {
this.app = app;
}
configWillLoad() {
// Ready to call configDidLoad,
// Config, plugin files are referred,
// this is the last chance to modify the config.
}
configDidLoad() {
// Config, plugin files have been loaded.
}
async didLoad() {
// All files have loaded, start plugin here.
}
async willReady() {
// All plugins have started, can do some thing before app ready
}
async didReady() {
// Worker is ready, can do some things
// don't need to block the app boot.
}
async serverDidReady() {
// Server is listening.
}
async beforeClose() {
// Do some thing before app close.
}
}
module.exports = AppBootHook
看着这么多生命周期，新的问题再此出现：Mongoose 的 Plugin 应该放在哪个生命周期中呢？
一个个试太不科学了，要想解决此问题，势必需要了解 egg-mongoose 的初始化过程，所以直接看源码：
源码很简单，大概扫了一眼就找到如下行：
app.beforeStart(() => {
loadModelToApp(app);
});
嗯，原来是在 beforeStart 方法中将 Model 们加载到 App 中的。
所以只要在 beforeStart 之前加载 Plugin 即可全局生效，但是上面的生命周期类貌似没有 beforeStart 方法，倒是有一个 beforeClose 方法。
仔细找了一圈文档，终于在文档最下面找到一行字：
如果你的 Egg 框架的生命周期函数是旧版本的，建议你升级到类方法模式；详情请查看升级你的生命周期事件函数。
难道是新旧版本问题？带着问题继续看文档，哈，果然是因为 Egg 升级导致的：
// app.js 或 agent.js 文件：
class AppBootHook {
constructor(app) {
this.app = app;
}
async didLoad() {
// 请将你的插件项目中 app.beforeStart 中的代码置于此处。
}
async willReady() {
// 请将你的应用项目中 app.beforeStart 中的代码置于此处。
}
}
module.exports = AppBootHook;
后面的事就简单了，为了在此之前让分页插件生效，需要将对应的逻辑放在 didLoad 之前的生命周期中，即：configDidLoad，加上相关代码
const paginate = require('./app/middleware/paginate')
class AppBootHook {
constructor(app) {
this.app = app;
}
configWillLoad() {
// Ready to call configDidLoad,
// Config, plugin files are referred,
// this is the last chance to modify the config.
}
configDidLoad() {
// Config, plugin files have been loaded.
const mongoose = this.app.mongoose
mongoose.plugin(paginate)
}
...
}
module.exports = AppBootHook
大功告成
