Node.js+TypeScript中复用Sequelize单实例的方案咨询

我正在使用Sequelize搭配Node.js和TypeScript连接PostgreSQL数据库，希望在整个应用中导出并导入单个Sequelize实例，以维持单一数据库连接。

我见过很多直接从模块导出Sequelize实例的示例：

import { Sequelize } from "sequelize";
import { DB_HOST, DB_NAME, DB_PASSWORD, DB_PORT, DB_USERNAME } from ".";

export default new Sequelize(
  `postgres://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_NAME}`
);

不过我改用函数来获取sequelize实例，代码如下：

import { Sequelize } from "sequelize";
import { DB_HOST, DB_NAME, DB_PASSWORD, DB_PORT, DB_USERNAME } from ".";
let sequelize: Sequelize;

const getDB = async () => {
  if (sequelize) return sequelize;
  try {
    sequelize = new Sequelize(
      `postgres://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_NAME}`
    );
    await sequelize.authenticate();
    console.log(`PostgreSQL is connected to ${DB_HOST}:${DB_PORT}`);
    return sequelize;
  } catch (error) {
    console.error("Unable to connect to the database:", error);
  }
};

export default getDB;

我这么做是为了确保sequelize实例仅创建一次，且在数据库连接建立后才可用，同时处理连接过程中可能出现的错误。

请问：

1. 这种在Node.js中导出和导入单个sequelize实例的方式是否合理？
2. 每次从其他模块导入时，会创建新实例还是复用首次创建的实例？
3. 例如在其他模块中这样使用：

import getDB from "./db";

const sequelize = await getDB();

const User = sequelize.define("User", { ... });

这会每次都创建新的User模型，还是复用首次定义的模型？

1. 你的实现方式是否合理？ #

这种方式是合理的，且比直接导出实例的写法更健壮：

• 直接导出实例会在模块加载时就初始化Sequelize，此时可能数据库配置未加载完成或连接未建立；而你的延迟初始化方式，确保只有在实际需要时才创建实例并验证连接状态。
• 加入authenticate()调用和错误捕获，能在连接失败时及时抛出异常并记录，避免后续代码拿着未连接的实例执行操作。

小优化建议：getDB在连接失败时可能返回undefined，建议在catch块中抛出错误，让调用方可以捕获处理，避免后续代码因拿到undefined报错：

catch (error) {
  console.error("Unable to connect to the database:", error);
  throw error;
}

2. 导入时会复用实例还是创建新实例？ #

会复用首次创建的实例。

Node.js的模块系统是单例缓存机制：模块一旦被加载，内部的变量会被缓存，后续所有导入操作都会复用同一个模块实例。你的sequelize是模块级变量，第一次调用getDB()会创建实例并赋值，后续调用都会直接返回已存在的实例，不会重新初始化，自然也不会创建新的数据库连接。

3. 模型定义会重复创建吗？ #

不会重复创建。

Sequelize的define方法内部会检查当前实例是否已注册同名模型：

• 第一次调用sequelize.define("User", ...)时，会创建并注册该模型到Sequelize实例；
• 后续再次调用时，Sequelize会直接返回之前注册的模型实例，不会重新创建。

更规范的做法是把模型定义单独放在独立文件中，在实例初始化完成后统一加载，避免在多个地方重复调用define。例如创建models/User.ts：

import { Model, DataTypes } from "sequelize";
import getDB from "../db";

class User extends Model {
  declare id: number;
  declare username: string;
}

export default async function initUser() {
  const sequelize = await getDB();
  User.init({
    id: {
      type: DataTypes.INTEGER,
      autoIncrement: true,
      primaryKey: true
    },
    username: {
      type: DataTypes.STRING,
      allowNull: false
    }
  }, {
    sequelize,
    modelName: "User"
  });
  return User;
}

然后在应用启动文件中统一初始化所有模型，确保模型只被初始化一次。

额外建议 #

• 可以在应用启动阶段提前初始化数据库连接，而不是等到第一次使用时才处理，这样能在启动阶段就发现数据库连接问题，避免运行时才报错。
• TypeScript项目中，建议使用类继承或装饰器方式定义模型，类型提示会更友好。

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