Next.js与Sequelize数据库单例连接重复创建问题求助

问题原因 #

在Next.js开发模式下，热重载机制会导致模块被多次重新加载，你导出的db实例会被多次初始化，每次实例化Db类都会调用connectDb()创建新的数据库连接，因此会多次打印"Connection has been established successfully."日志。而生产环境中模块只会被加载一次，所以不存在这个问题。

解决方案 #

1. 实现单例模式确保仅创建一个Sequelize实例

通过单例模式限制Db类只能实例化一次，无论模块被加载多少次，都复用同一个连接实例。修改后的代码如下：

import { FindOptions, Model, ModelCtor, Sequelize } from 'sequelize'
import { initModels, Models } from './models';

class Db {
    static instance: Db | null = null;
    connection: Sequelize | null = null;

    // 私有化构造函数，防止外部直接实例化
    private constructor() {}

    // 全局唯一获取实例的方法
    static async getInstance(): Promise<Db> {
        if (!Db.instance) {
            Db.instance = new Db();
            await Db.instance.initConnection();
        }
        return Db.instance;
    }

    // 异步初始化连接（修复原代码中同步调用异步方法的问题）
    private async initConnection() {
        this.connection = await this.connectDb();
        if (this.connection) {
            initModels(this.connection);
        }
    }

    retrieveAll(model: ModelCtor<Model<any, any>>, options: FindOptions<any> = {}) {
        return model?.findAll(options);
    }

    retrieve(model: ModelCtor<Model<any, any>>, options: FindOptions<any> = {}) {
        return model?.findOne(options);
    }

    private async connectDb() {
        const dbName = process.env.DB_NAME
        const dbHost = process.env.DB_HOST
        const dbUser = process.env.DB_USER as string       
        const dbPassword = process.env.DB_PASSWORD
        
        const sequelize = new Sequelize({
            dialect: 'postgres',
            host: dbHost,
            port: 5432,
            database: dbName,
            username: dbUser,
            password: dbPassword,
            pool: {
                max: 5,
                idle: 86400000,
            }
        });
        
        try {
            await sequelize.authenticate();
            console.log('Connection has been established successfully.');
            return sequelize;
        } catch (error) {
            console.error('Unable to connect to the database:', error);
            return null;
        }
    }

    closeConnectionDb() {
        this.connection?.close()
    }
}

export const getDbInstance = Db.getInstance;

使用时需要异步获取实例：

// 在API路由或服务器组件中
export async function GET() {
    const db = await getDbInstance();
    const data = await db.retrieveAll(YourModel);
    // 后续逻辑
}

2. 可选：调整Next.js开发环境模块缓存（不推荐）

可以在next.config.js中添加配置，减少模块重复加载的情况，但可能影响热重载体验，不如单例模式可靠：

/** @type {import('next').NextConfig} */
const nextConfig = {
  experimental: {
    esmExternals: false,
  },
}

module.exports = nextConfig

关键注意点 #

• 原代码中sequelize.authenticate()是异步方法，同步调用会导致未完成连接就返回实例，存在潜在错误，必须改为异步处理。
• 单例模式是解决此类模块重复实例化问题的标准方案，同时适配Next.js开发环境的特性。

内容的提问来源于stack exchange，提问作者Furkan Topaloğlu