Express项目报TypeError: Cannot read property 'collection' of undefined如何解决？

该TypeError: Cannot read property 'collection' of undefined错误本质是：你调用.collection方法的前置对象为undefined，绝大多数场景下这个前置对象是MongoDB的数据库实例对象。

常见触发场景 #

• 数据库连接未初始化完成就注册路由：MongoDB连接是异步逻辑，还没等连接成功拿到数据库实例，就已经挂载了POST接口路由，接口被触发时实例还未完成赋值
• 实例作用域错误：数据库实例定义在局部作用域中，路由回调的作用域无法访问到该变量，读取结果为undefined
• 数据库连接失败：MongoDB服务未启动、连接串配置错误、账号权限校验失败，导致连接没有成功建立，自然拿不到可用的数据库实例
• 变量名拼写错误：存储数据库实例的变量名和调用时的拼写不一致，比如定义时用的是database，调用时写为db

排查步骤 #

1. 定位app.js第17行的代码，确认调用.collection的对象名称，比如代码为db.collection('xxx')就重点核查db变量的来源
2. 在第17行前添加打印逻辑：console.log('调用collection的对象值：', 你的对象名)，触发POST接口后查看控制台输出是否为undefined
3. 核查数据库连接逻辑：确认是否监听了MongoDB连接的成功回调，是否在回调触发、拿到有效实例之后才挂载路由、启动Express服务
4. 核查变量作用域：确认存储数据库实例的变量定义在路由可访问的全局/模块顶层作用域内

修复示例 #

常见错误写法 #

const express = require('express')
const MongoClient = require('mongodb').MongoClient
const app = express()
let db

// 异步连接逻辑未完成，就提前注册路由
MongoClient.connect('mongodb://localhost:27017', (err, client) => {
  if (err) throw err
  db = client.db('mydb')
})

// 路由注册在连接回调外部，接口触发时db可能还未赋值
app.post('/api/xxx', (req, res) => {
  // 第17行，db为undefined时触发报错
  db.collection('users').insertOne(req.body, (err, result) => {
    res.send(result)
  })
})

app.listen(3000)

对应修复写法 #

将路由注册、服务启动逻辑全部放到数据库连接成功的回调内部：

const express = require('express')
const MongoClient = require('mongodb').MongoClient
const app = express()

MongoClient.connect('mongodb://localhost:27017', (err, client) => {
  if (err) throw err
  const db = client.db('mydb')

  // 连接成功后再注册路由
  app.post('/api/xxx', (req, res) => {
    db.collection('users').insertOne(req.body, (err, result) => {
      res.send(result)
    })
  })

  app.listen(3000, () => console.log('服务启动成功'))
})

如果使用async/await写法实现数据库连接，同理需要等待连接逻辑执行完成、拿到有效实例后再挂载路由启动服务。

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