参考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的一些静态辅助方法(如find
、findOne
、countDocuments
等等)不返回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()
可以使其返回成熟完整的Promise,await 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) ...