Sequelize实例封装进NPM模块的方式是否存在不良实践？

我们为多个项目封装了一个共享Sequelize的NPM模块，模块结构如下：

模块入口文件：

const instance = require('./instance');
const modelDefinitions = require('./models');
const queries = require('./queries');
const sequelize = require('sequelize');

module.exports = {
  ...queries,
  ...modelDefinitions,
  instance,
  sequelize,
};

其中./instance通过立即执行getInstance()创建并导出数据库连接实例：

const getInstance = () => {
  let instance = null;
  
  // 实例初始化代码
  // .... INSTANCE CODE

  try {
    return instance;
  } catch (error) {}
};

module.exports = getInstance();

模块内的查询文件通过导入该实例执行数据库操作：

const instance = require('../instance');

const testQuery = async id => {
    return instance.models.fakeModel.findAll();
};

外部服务通过以下方式使用该模块：

const { testQuery, instance, <ETC> } = require('@something/db');

目前我们遇到了连接关闭或内存泄漏问题，想请教这种加载并传递Sequelize实例的方式是否属于不良实践，是否是问题的诱因？

这种方式确实存在不良实践，大概率是连接问题或内存泄漏的诱因 #

核心问题点：

1. 模块加载时立即创建单例实例
   Node.js模块是加载时执行的，这意味着只要有任何代码require('@something/db')，你的Sequelize实例就会被立刻创建并建立连接。外部服务无法控制实例的初始化时机，也无法在服务 shutdown 时主动销毁实例、关闭连接——这会导致连接池中的连接无法被正确释放，进而引发连接耗尽或内存泄漏。

2. 硬编码绑定单例实例
   模块内的查询函数直接依赖导入的单例实例，完全丧失了灵活性：

   • 多个项目如果需要不同的数据库配置（比如测试环境、生产环境），无法复用该模块创建不同实例
   • 在多进程场景（如PM2集群模式）下，每个进程都会加载模块并创建独立实例，但如果单例逻辑处理不当（比如你的getInstance里的instance变量是模块级的），可能导致跨进程的连接混乱或资源竞争
   • 热重载场景下，模块被重新加载时，旧的实例连接无法被关闭，直接造成内存泄漏

3. 错误处理缺失
   你的getInstance函数中catch (error) {}直接吞掉了错误，这会导致实例创建失败时，外部服务拿到的是null或未初始化的实例，后续执行查询时会抛出未被捕获的异常，甚至导致连接池处于异常状态无法回收。

改进方案：

1. 导出工厂函数而非直接导出实例
   修改./instance，让它导出可配置的工厂函数，允许外部服务控制实例的创建和销毁：

   let instance = null;
   
   const getInstance = async (config) => {
     if (instance) return instance;
     try {
       // 根据传入的config初始化实例
       instance = new Sequelize(config);
       // 验证连接有效性
       await instance.authenticate();
       return instance;
     } catch (error) {
       throw new Error(`Failed to create Sequelize instance: ${error.message}`);
     }
   };
   
   // 提供关闭连接的方法
   const closeInstance = async () => {
     if (instance) {
       await instance.close();
       instance = null;
     }
   };
   
   module.exports = { getInstance, closeInstance };
   

2. 让查询函数依赖传入的实例
   修改模块内的查询逻辑，不再硬编码导入单例，而是支持传入实例，或者通过上下文注入：

   // queries/testQuery.js
   const testQuery = async (instance, id) => {
       return instance.models.fakeModel.findAll();
   };
   
   // 或者提供初始化函数，绑定实例到查询
   const initQueries = (instance) => {
     return {
       testQuery: async (id) => instance.models.fakeModel.findAll()
     };
   };
   
   module.exports = { testQuery, initQueries };
   

3. 修改模块入口，让外部服务自主管理实例

   const { getInstance, closeInstance } = require('./instance');
   const modelDefinitions = require('./models');
   const { initQueries } = require('./queries');
   const sequelize = require('sequelize');
   
   module.exports = {
     getInstance,
     closeInstance,
     initQueries,
     modelDefinitions,
     sequelize,
   };
   

4. 外部服务中主动管理实例生命周期

   const { getInstance, closeInstance, initQueries } = require('@something/db');
   const dbConfig = require('./config/db');
   
   // 初始化实例
   const dbInstance = await getInstance(dbConfig);
   // 初始化绑定实例的查询
   const { testQuery } = initQueries(dbInstance);
   
   // 服务 shutdown 时主动关闭连接
   process.on('SIGINT', async () => {
     await closeInstance();
     process.exit(0);
   });
   

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