NodeJS/ExpressJS项目API接口调用findById返回null问题求解

问题复现代码 #

控制器代码 #

const getById = async (req, res) => {
  try {
    const myId = Inventory.findById(id).exec();
    res.json(myId);
  } catch (error) {
    res.json({
      message: error
    });
  }
};

路由配置代码 #

router.get('/details/:id', homeController.getById);

问题产生原因 #

• async函数中未使用await等待异步操作完成：findById().exec()返回的是Promise对象，直接赋值的话拿到的是pending状态的Promise而非查询结果，就算查询成功也无法得到正确数据。
• 未正确获取路由传递的id参数：代码中直接使用未定义的id变量，没有从请求参数req.params.id中取值，实际传递给findById的是undefined，自然无法匹配到数据。
• 数据库中不存在对应id的记录：如果传递的id在Inventory对应的集合中没有匹配的文档，findById会正常返回null。
• id格式不符合MongoDB的ObjectId规范：MongoDB默认的_id是24位十六进制的ObjectId类型，如果传递的id格式不对，部分版本的mongoose会直接返回null而非抛出错误。

解决方案 #

1. 修正控制器代码的基础错误 #

const getById = async (req, res) => {
  try {
    // 从路由参数中获取id
    const id = req.params.id;
    // 加await等待查询操作完成
    const myId = await Inventory.findById(id).exec();
    // 增加空值判断，主动抛出404错误
    if (!myId) {
      return res.status(404).json({
        message: '对应ID的记录不存在'
      });
    }
    res.json(myId);
  } catch (error) {
    // 补充状态码，仅返回错误信息避免暴露后端敏感信息
    res.status(500).json({
      message: error.message
    });
  }
};

2. 验证传入的id合法性 #

• 如果使用MongoDB默认的ObjectId作为主键，先校验id格式是否正确：

const mongoose = require('mongoose');
if (!mongoose.Types.ObjectId.isValid(id)) {
  return res.status(400).json({ message: '传入的ID格式不合法' });
}

• 直接连接数据库执行查询，确认传入的id在对应集合中存在匹配的文档。

3. 错误逻辑优化 #

可以根据业务需求给不同错误场景补充对应的HTTP状态码，方便前端区分错误类型做对应处理。

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