在Node.js中大家通常如何实现单例模式？

在Node.js中大家通常如何实现单例模式？

打算把数据库连接池单独封装成一个模块，连接池对象全局只有一个。感觉怎么写都挺别扭的，不知道大家通常怎么写？

var mysql = require('mysql');
var pool = undefined;
module.exports.getPool  = function(){
    if (pool == undefined){
        pool = mysql.createPool({
            host     : 'localhost',
            user     : 'root',
            password : 'root'
        });
    }
    return pool;
}

这么写会不会导致每次require(‘xxx’).pool的时候都会创造一个连接池对象……

这个pool变量的作用域是哪里啊？


6 回复

在Node.js中实现单例模式是一种常见的需求，尤其是在需要全局共享某些资源（如数据库连接池）的情况下。你提到的需求正好符合这种场景。让我们来详细探讨一下如何正确地实现这一点，并解决你提到的问题。

单例模式的基本概念

单例模式确保一个类只有一个实例，并提供一个全局访问点。这在数据库连接池、配置管理等场景中非常有用。

解决方案

在Node.js中，可以通过模块系统本身来实现单例模式。每个Node.js模块在首次加载时会被缓存，之后的引用将直接从缓存中获取。这意味着你可以通过模块导出一个函数来创建并返回单例对象。

示例代码

// dbPool.js
var mysql = require('mysql');

// 检查是否已经存在连接池实例
var pool = null;

function createPool() {
    return mysql.createPool({
        host: 'localhost',
        user: 'root',
        password: 'root'
    });
}

module.exports.getPool = function () {
    if (!pool) {
        pool = createPool();
    }
    return pool;
};

解释

  1. 模块化设计：我们将数据库连接池的逻辑封装在一个独立的模块dbPool.js中。
  2. 私有变量：使用pool变量作为私有变量存储连接池实例。这样可以避免外部直接访问或修改这个实例。
  3. 惰性初始化：在getPool方法中检查pool是否存在。如果不存在，则创建新的连接池实例。之后的所有调用都将返回同一个实例。
  4. 模块缓存：Node.js会自动缓存每个模块，因此无论你在应用的哪个部分调用require('./dbPool')，都会得到相同的模块实例，从而保证了单例的特性。

使用示例

// app.js
var dbPool = require('./dbPool');

// 在任何地方都可以安全地使用同一个数据库连接池实例
var pool1 = dbPool.getPool();
var pool2 = dbPool.getPool();

console.log(pool1 === pool2); // 输出 true，证明它们是同一个实例

通过这种方式，你可以确保在整个应用程序中只存在一个数据库连接池实例，从而有效地管理和复用资源。


require('xxx').pool 应该是 undefined 把

直接这么用肯定是undefine。关键是我不清楚pool在模块内部的作用域是各模块之间共享？还是每次require之后都复制出一份来？

模块在首次 require 时执行代码，之后的 require 都是之前的执行结果

明白了。查了一下手册，发现确实是这样……缓存机制哈~

为了确保在Node.js中实现单例模式并且全局只有一个数据库连接池对象，可以使用模块的特性来确保只初始化一次。你提供的代码已经接近正确了，但是为了更清晰地展示单例模式，并且确保pool变量不会被重复创建，可以稍微调整一下。

示例代码

// dbPool.js
const mysql = require('mysql');

let pool;

function createPool() {
    return mysql.createPool({
        host: 'localhost',
        user: 'root',
        password: 'root'
    });
}

module.exports = {
    getPool: function () {
        if (!pool) {
            pool = createPool();
        }
        return pool;
    }
};

解释

  1. 模块封装：将数据库连接池的逻辑封装在一个模块中（例如dbPool.js）。
  2. 单例模式：通过检查pool是否已经被定义来确保连接池只被创建一次。
  3. 函数返回：getPool函数返回的是同一个连接池实例。

使用方式

在其他文件中，你可以通过以下方式获取连接池：

const dbPool = require('./dbPool');
const pool = dbPool.getPool();

pool.query('SELECT * FROM table', (error, results, fields) => {
    // 处理查询结果
});

这样做的好处是确保在整个应用程序运行期间，你始终使用同一个数据库连接池实例，从而节省资源并提高性能。

回到顶部