mongoose 5.x中的Promise和async/await

参考1:Promises in Mongoose
参考2:https://mongoosejs.com/docs/promises.html

mongose 5.x版本废弃了之前自己库的Promise实现,取而代之使用ES6原生Promise。

数据的异步操作,像 .save().find().exec() ,在没有传递回调函数的情况下,会返回一个Promise。具体看 ①

新增数据方法 Model.create(),内部会调用 Document.save() 方法返回原生Promise。

const itemAdd = async (req, res, next) => { // 简化演示一个请求路由回调函数,后面都省略这一外部包裹
  const result = Model.create({name: 'xxx'})
  console.log(result instanceof Promise) // true
   // 通过 await 获得 Promise 的返回值
  const doc = await Model.create(req.body)
  console.log(doc) // 返回被成功保存的这条数据
}

Model.create()有一个可选参数 callback<Function>,如果我们传递了这个回调,那么它就不再有返回值(undefined)。

// 当我们传递了回调函数
const response = Design.create(req.body, (err, doc) => {
  console.log('2. 后输出', err, doc)
  // 1. 操作成功: err是null,doc是被成功插入集合的这条文档
  // 2. 操作失败:err是错误信息,doc是 undefined
  if(err) return next(err)
  // do something
})
console.warn('1. 先输出', response) // undefined 如果添加了回调函数,则不再有返回值

捕获数据库异步操作的错误,要么用 try catch ➕ async/await,要么直接在回调里判断err。

Model的一些静态辅助方法(如findfindOnecountDocuments等等)不返回Promise,它们返回的是一个 Mongoose Query( mongoose查询对象 )。

虽然返回值不是Promise,但 Mongoose Query 也是可以调用 then 方法(即Query.prototype.then() ,模式和原生Promise的then()非常相似) 和使用 async/await 的。

举例:

// 链式调用Promise
Model.findOne({ name: 'Mr. Anderson' })
  .then(doc => Model.updateOne({ _id: doc._id }, { name: 'Neo' }))
  .then(() => Model.findOne({ name: 'Neo' }))
  .then(doc => console.log(doc.name)) // 'Neo'
  .catch(err => next(err))

// 使用 async/await
const doc = await Model.findOne({ name: 'Neo' });
console.log(doc.name); // 'Neo'

使用 Mongoose Query 时,在后面加上exec()可以使其返回成熟完整的Promiseawait Band.findOne().exec()(官方建议模式),这样可以提供更好的堆栈跟踪(报错的时候查找问题更方便)
use exec() to get fully-fledged promise

Mongoose Query 都有一个可选的callback参数( 注⚠️:Mongoose 中的所有回调,参数都遵循callback(error, result)的模式 ),不传回调它返回Mongoose Query,即定义了一个操作命令;一但传了回调方法就等于把这个异步操作执行了。而在exec(err, result) 里传入回调,也可以让这个操作执行。result的值取决于执行的是什么操作 ,详细请看另一篇 mongoose Api CRUD操作返回结果总结梳理

findOneAndUpdate举例:

Model.findOneAndUpdate(conditions, update, options) // returns Query,未执行操作
Model.findOneAndUpdate(conditions, update, options).exec() // returns Promise,未执行操作
await Model.findOneAndUpdate(conditions, update) // 操作已执行,returns Object
Model.findOneAndUpdate(conditions, update, (error, doc) => {}) // 操作已执行,returns undefined
Model.findOneAndUpdate(conditions, update, options).exec((error, doc) => {}) // 操作已执行,returns undefined

如果在exec()中传递了回调函数,这个操作就没有返回值了(undefined),就只能在exec里的回调里进行后续操作,如下:

Design.findByIdAndUpdate(req.body._id, req.body).exec((err, doc) =>{
  if (err) return res.json({
    code: 400,
    message: '修改失败'
  })
  res.json({
    code: 200,
    message: '修改成功'
  })
})

也就是说,mongoose异步操作数据的API,一般情况我们当作原生Promise来使用即可。如果使用这些API的回调或者exec的回调,形参都是(err, result)

分享几种Model CRUD操作常用写法,供参考(具体根据自己的场景和需求):

// 在exec()的回调中拿到异步操作执行的返回值并编写逻辑
Design.findByIdAndUpdate(req.body._id, req.body).exec((err, doc) => {
  if(err) return next(err)
   // 若未出错执行其他操作
})
// 不传回调,用try catch排错
try {
  const list = await Design.find(condition).skip(skip).limit(limit).populate('user').sort(sortCondition).collation({ locale: 'zh' }).exec()
  console.log(list)    
} catch (err) {
  console.log(err.stack)
}
// 单纯查询某条数据是否存在时,省去exec()
// 功能测试完成后不再需要排错的查询请求适用
const design = await Design.findOne({ name: req.body.name });
if(design) ...
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,905评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,140评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,791评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,483评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,476评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,516评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,905评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,560评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,778评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,557评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,635评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,338评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,925评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,898评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,142评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,818评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,347评论 2 342

推荐阅读更多精彩内容