在整个 Express 应用程序中实现单个数据库池的正确方法

Correct way to implement single DB pool throughout express app

注意:这个问题主要是关于节点中的单例对象而不是数据库池

我正在为数据库连接使用 mysqljs 节点模块构建一个 expressjs 应用程序。我想创建一个可以在整个应用程序中重复使用的池对象(用于不同的模型等)。我想知道在整个快速应用程序中使用单个对象实例的正确方法是什么

我见过很多这样的例子,人们像这样创建 db.js 文件或 pool.js 文件,并在需要的地方引用它

// db.js
var mysql = require('mysql');
var pool;
module.exports = {
    getPool: function () {
      if (pool) return pool;
      pool = mysql.createPool(dbConfig);
      return pool;
    }
};

// app.js
var pool = require('pool').getPool();
pool.query('SELECT * FROM users');

但是我觉得这仍然不是正确的方法,因为您每次需要对象时都依赖于 nodejs 缓存 return 相同的实例。如果节点最终加载了两次代码,您将得到两个池,例如

const poolA = require('./pool').getPool();
const poolB = require('./POOL').getPool(); // resolves to same file but node will not get result from cache

console.log(poolA === poolB); // false

从我读过的大多数内容来看,由于这种行为,通常不建议在节点应用程序中使用单例对象,但这似乎是 express 应用程序的常见用例。所以我想知道人们如何在他们的应用程序的生命周期内创建他们的单一池?

注意:我目前一直在做的是在应用程序根目录中实例化池,然后将实例作为构造函数参数传递,但我也不喜欢这个

简答

我没有发现你的代码有任何问题。

长答案

此解决方案是假设您实际上没有名为 POOL.js 且代码完全相同的文件。

下面的 require 解析为与 pool.js 相同的文件,因为您使用的文件系统启用了 case-insensitivity。例如 NTFSAPFS

const poolB = require('./POOL').getPool();

如果你使用 case sensitive 文件系统,比如 ext4 那么你会得到错误。

Error: Cannot find module './POOL'

内部node 根据您提供的文件路径名缓存文件。来自 source:

const relativeResolveCache = Object.create(null);

relResolveCacheIdentifier = `${parent.path}\x00${request}`;
const filename = relativeResolveCache[relResolveCacheIdentifier];

if (filename !== undefined)
...

由于 JavaScriptcase-sensitive,一个对象(上面的 cache)具有 属性(简单地)poolPOOL 将有所不同,并引用完全 2 个不同的对象引用。

结论

当心 陷阱 文件名或标识符名称。