Mongoose脚本卡顿原因及解决方法

亲爱的编程学习爱好者，如果你点开了这篇文章，说明你对《Mongoose脚本挂起原因及解决方法》很感兴趣。本篇文章就来给大家详细解析一下，主要介绍一下，希望所有认真读完的童鞋们，都有实质性的提高。

问题现象与诊断

在开发使用 Mongoose 操作 MongoDB 的 Node.js 脚本时，开发者可能会遇到脚本在执行数据库操作（如 connection.dropCollection() 或 Model.insertMany()）时无故挂起，不再继续执行后续代码的现象。尽管 console.log(connection.readyState) 显示连接状态为 1（已连接），表明数据库连接已建立并活跃，但脚本仍无法推进。

例如，在以下代码结构中，脚本可能会在尝试执行 dropCollection 或随后的 insertMany 操作时停止响应：

// ... 其他文件操作和数据准备代码 ...

console.log("Connection state: ", connection.readyState); // 输出可能是 1

// 等待连接建立（此处是问题的根源）
connection.once('connected', async () => {
  try {
    console.log("Dropping collection if it already exists");
    await connection.dropCollection('mdprodcats'); // 脚本可能在此处挂起
    console.log("Collection dropped successfully");

    // ... 后续的 insertMany 操作也可能无法执行 ...
    await MdProdCat.insertMany(json);
    console.log("Data inserted successfully");

    await connection.close();
    process.exit();
  } catch (error) {
    // ... 错误处理 ...
  }
});

在这种情况下，终端输出会停留在 Connection state: 1 之后，没有任何进展。这表明 connection.once('connected', ...) 内部的回调函数从未被执行。

Mongoose 连接生命周期与 readyState

要理解此问题，首先需要了解 Mongoose 连接的生命周期及其 readyState 属性：

• readyState 值：
  • 0 (disconnected): 未连接。
  • 1 (connected): 已连接并准备好进行操作。
  • 2 (connecting): 正在连接中。
  • 3 (disconnecting): 正在断开连接。
• 连接事件： Mongoose 连接对象会触发一系列事件，例如 connected (连接成功建立)、error (连接错误)、disconnected (连接断开) 等。

当 connection.readyState 为 1 时，意味着 Mongoose 已经成功地与 MongoDB 数据库建立了连接，并且该连接是活跃可用的。此时，可以直接通过 connection 对象或 Mongoose 模型执行数据库操作。

connection.once('connected') 的陷阱

问题的核心在于对 connection.once('connected', ...) 的误用。

connection.once('connected', callback) 是一个事件监听器，它表示当 connected 事件首次发生时，执行一次 callback 函数。

关键点在于： 如果你的脚本在启动时，Mongoose 连接已经通过其他方式（例如在项目启动文件或配置模块中）被初始化并成功建立，那么 connected 事件已经发生过了。在这种情况下，当脚本执行到 connection.once('connected', ...) 这一行时，由于 connected 事件已经成为历史，它将永远不会再次触发。

这意味着包裹在 connection.once('connected', async () => { ... }) 内部的所有数据库操作代码，包括 dropCollection 和 insertMany，将永远不会被执行。脚本会无限期地等待一个已经发生过的事件，从而导致挂起。

解决方案：移除不必要的事件监听

由于 connection.readyState 已经明确指示连接处于 1 (connected) 状态，我们不需要再等待 connected 事件。可以直接在确认连接状态后执行数据库操作。

修正后的代码结构：

const axios = require("axios");
const XLSX = require("xlsx");
const fs = require("fs");
const path = require("path");
const mongoose = require("mongoose");
// 假设 connection 模块导出了一个已连接的 Mongoose 连接实例
const connection = require("../../../config/connection");
const MdProdCat = require("../../../models/MdProdCat");

(async () => {
  try {
    // ... 前期文件下载和数据转换代码 ...
    console.log("=== Commencing MD Product Category import...");
    // ... 省略文件操作和数据转换细节 ...
    const json = [/* 转换后的JSON数据 */];
    console.log("Converted .csv to JSON");

    // 检查连接状态
    console.log("Connection state: ", connection.readyState);

    // 直接执行数据库操作，因为连接已经处于活跃状态
    try {
      console.log("Dropping collection if it already exists");
      // 注意：使用 connection.db.dropCollection() 而不是 connection.dropCollection()
      // connection.dropCollection() 在某些Mongoose版本中可能不存在，
      // 而 connection.db.dropCollection() 是 MongoDB 驱动层的方法，更通用。
      await connection.db.dropCollection('mdprodcats');
      console.log("Collection dropped successfully");
    } catch (error) {
      // 忽略 'ns not found' 错误，表示集合不存在
      if (error.message === 'ns not found') {
        console.log('Collection does not exist. Continuing...');
      } else {
        throw error; // 抛出其他错误
      }
    }

    // 插入数据
    console.log("Inserting data...");
    await MdProdCat.insertMany(json);
    console.log("Data inserted successfully");

    // 关闭连接
    console.log("Closing connection...");
    await connection.close();
    console.log("Connection closed");
    console.log("=== Import completed successfully");

    process.exit(0); // 成功退出
  } catch (error) {
    console.error("An error occurred:", error);
    process.exit(1); // 异常退出
  }
})();

通过移除 connection.once('connected', ...) 包装器，数据库操作会立即在脚本执行到该位置时被调用，从而避免了不必要的等待，解决了脚本挂起的问题。

Mongoose 连接管理最佳实践

为了避免此类问题并确保脚本的健壮性，以下是一些 Mongoose 连接管理的最佳实践：

1. 统一连接管理： 推荐在一个独立的模块（例如 config/database.js）中建立和导出 Mongoose 连接。这样可以确保应用程序的各个部分都使用同一个连接实例，并避免重复连接或连接状态混淆。

   // config/database.js
   const mongoose = require('mongoose');
   
   const DB_URI = process.env.DB_URI || 'mongodb://localhost:27017/your_database';
   
   mongoose.connect(DB_URI, {
     useNewUrlParser: true,
     useUnifiedTopology: true,
     // useCreateIndex: true, // Mongoose 6+ 不再需要
     // useFindAndModify: false // Mongoose 6+ 不再需要
   })
   .then(() => console.log('MongoDB connected successfully'))
   .catch(err => console.error('MongoDB connection error:', err));
   
   module.exports = mongoose.connection;

2. 等待连接建立： 对于独立运行的脚本，如果不能确定连接是否已就绪，最可靠的方法是等待 mongoose.connection.asPromise() 解析。

   // 脚本文件
   const mongoose = require('mongoose');
   const connection = require('../../../config/connection'); // 导入已连接的Mongoose连接实例
   
   (async () => {
     try {
       // 确保连接已就绪，如果config/connection.js是异步连接的
       // 或者如果脚本是独立运行且需要自己管理连接
       if (connection.readyState !== 1) {
         console.log("Waiting for MongoDB connection...");
         await connection.asPromise(); // 等待连接成功
         console.log("MongoDB connection established.");
       } else {
         console.log("MongoDB connection already established.");
       }
   
       // ... 执行数据库操作 ...
       console.log("Connection state: ", connection.readyState);
       await connection.db.dropCollection('mdprodcats').catch(err => {
         if (err.message === 'ns not found') {
           console.log('Collection does not exist. Continuing...');
         } else {
           throw err;
         }
       });
       console.log("Collection operations completed.");
   
       // ... 其他操作 ...
   
       await connection.close();
       process.exit(0);
     } catch (error) {
       console.error("An error occurred:", error);
       process.exit(1);
     }
   })();

3. 错误处理： 始终包含 try...catch 块来捕获数据库操作和连接过程中的潜在错误，并进行适当的日志记录或错误处理。

4. 资源清理： 在脚本执行完毕后，务必调用 connection.close() 来关闭数据库连接，释放资源。对于长时间运行的服务器应用，通常不会关闭连接，但在短生命周期的脚本中，这是必要的。

总结

Mongoose 脚本挂起的问题，往往源于对连接生命周期和事件监听器行为的误解。当 Mongoose 连接已经处于活跃状态 (readyState: 1) 时，再次使用 connection.once('connected', ...) 将导致其内部代码永远不会被执行，从而阻塞脚本的后续操作。正确的做法是，在确认连接已就绪后，直接执行数据库操作。通过遵循 Mongoose 连接管理的最佳实践，可以有效避免此类问题，确保数据库操作的顺利和可靠执行。

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于文章的相关知识，也可关注golang学习网公众号。