NodeJS中Mongoose调用/login接口出现Cast to ObjectId报错如何解决？

问题原因 #

这个报错的核心原因是Express路由匹配顺序问题：你当前路由文件里，一定存在一个路径为/:id的动态参数路由（比如获取单个用户详情的接口），且这个路由的定义位置在/login路由的前面。
Express匹配路由是从上到下依次校验的，当你请求POST /login时，会先命中前面的/:id路由，框架把字符串login当成了路径参数id的值，后续你在这个动态路由的处理逻辑里，直接拿这个值去调用Mongoose的User.findById()之类的方法查询用户，而MongoDB的ObjectId有固定的24位十六进制格式要求，login不符合格式要求，就抛出了类型转换错误。
你给出的/login路由和处理函数本身没有问题，错误是被前面的动态路由触发的。

解决方案 #

• 方案1：调整路由定义顺序，把所有固定路径的路由（比如/login、/register这类路径固定的接口）全部放到动态参数路由（比如/:id这种带占位符的接口）的前面，示例如下：

// 正确顺序：先写固定路由
router.post('/login', authUser);
router.post('/register', registerUser);
// 再写动态参数路由
router.get('/:id', getUserInfo);

• 方案2：给动态参数路由增加参数格式校验，只有符合ObjectId格式的参数才会命中该路由，这样login字符串不会误匹配到动态路由：

// 正则限制id必须是24位十六进制的ObjectId格式
router.get('/:id([0-9a-fA-F]{24})', getUserInfo);

• 方案3：如果你的用户系统不需要用MongoDB默认的_id作为查询参数，也可以在动态路由的处理逻辑里，先校验传入的id是否符合ObjectId格式，不符合的话直接返回参数错误，避免走到数据库查询步骤抛出异常，示例校验逻辑：

const mongoose = require('mongoose');
const isValidId = mongoose.Types.ObjectId.isValid(req.params.id);
if (!isValidId) {
  return res.status(400).json({ message: '无效的用户ID' });
}

内容的提问来源于stack exchange，提问作者valkkorn