Mongoose 中遇到 “CastError: Cast to ObjectId failed” 的解决方案
在使用 Mongoose 进行 Node.js 项目开发时，经常会遇到 "CastError: Cast to ObjectId failed" 错误，这种错误可能会导致数据库操作失败，给开发带来不必要的麻烦。本文将详细介绍这种错误的原因及解决方法，帮助开发者更好地应对此类错误。
错误原因
在使用 Mongoose 的 Schema 定义数据结构时，可以为某些字段指定类型。如果在进行数据库查询时，传入的参数与定义的类型不一致，就会出现 "CastError: Cast to ObjectId failed" 错误。常见的数据类型有 String、Number、Date、Boolean、Array、Object 等等，其中 ObjectId 是 Mongoose 中自有的数据类型，用于标识文档（Document）在 MongoDB 中的唯一标识。
下面是一个简单的 Mongoose Schema 定义示例：
const UserSchema = new mongoose.Schema({ name: String, age: Number, avatar: String })
如果在查询 "User" 数据集合时，传入的参数中，age 字段传入了非数值类型的数据，如下所示：
User.find({ age: '12' }, (err, users) => { console.log(users) })
就会出现 "CastError: Cast to ObjectId failed" 错误。
错误解决方法
解决 "CastError: Cast to ObjectId failed" 错误的方法，最基本和直接的方法是，在传参时，要确保传入参数的类型与 Schema 定义的数据类型一致。下面是一个简单的示例：
User.find({ age: 12 }, (err, users) => { console.log(users) })
如果需要传入的参数类型与 Schema 定义的数据类型不一致，可以使用 Mongoose 提供的 cast() 函数将参数转换为 Schema 定义的数据类型。下面是一个使用 cast() 函数的示例：
const inputAge = '12' User.find({ age: mongoose.Types.ObjectId(inputAge) }, (err, users) => { console.log(users) })
在上面的示例中，使用了 mongoose 的 ObjectId 类型的 cast() 函数将传入的字符串类型 inputAge 转换为 ObjectId 类型的数据。当然，使用 cast() 函数需要注意，仅在传入的参数类型为字符串或数值类型时才有效。
需要注意的是，即使传入的参数类型与 Schema 定义的数据类型一致，也有时会出现 "CastError: Cast to ObjectId failed" 错误。这种情况一般是由于传入的参数包含了非法的字符，如下所示：
const userId = req.params.id // 传入的参数值为 "123abc" User.findById(userId, (err, user) => { console.log(user) })
上述示例中，传入的参数值为 "123abc"，其中包含了非法的字符，将导致查询失败。解决这种情况的方法是，使用 Mongoose 提供的 isValidObjectId() 函数判断对象ID是否合法，如下所示：
const userId = req.params.id // 传入的参数值为 "123abc" if (mongoose.isValidObjectId(userId)) { User.findById(userId, (err, user) => { console.log(user) }) }
在上例中，使用 isValidObjectId() 函数判断传入的参数是否合法，如果合法，则进行数据库操作。
总结
在使用 Mongoose 进行 Node.js 项目开发时，遇到 "CastError: Cast to ObjectId failed" 错误是很常见的情况。在开发中，务必注意传递参数的类型以及传递参数的合法性，避免出现此类错误。本文提供了从多个方面解决此类错误的方法，希望对开发者们有所帮助。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/65b2133eadd4f0e0ffb3f960