javascript - Node.js module.exports 通过接口(interface)

Question

我有一个结构如下的模块: (文件夹以-为前缀，文件以|为前缀)

- MyModule
 |index.js
 - Lib
  |database.js
  |register.js
  |table.js

index.js 文件应该是一个接口(interface)文件，它提供模块的 api，在 Lib...

所以我的 index.js 看起来像这样:

var register  = require('./lib/register');
var table     = require('./lib/table');

module.exports = {
  register        : register.addNewUser,
  createNewTable  : table.createTable,
  dropTable       : table.dropTable
} 

所以我可以在我的应用程序中调用我的模块:

var myModule = require('./myModule');

然后例如:

myModule.register; //registers a new user... 

database.js 比较特别。它看起来像这样:

var mysql     = require('mysql');

module.exports = {
  createPool: function(options) {
    console.log('creating Pool ...')
    return module.exports.pool = mysql.createPool(options);
  }
}

它创建一个 mysql 池 ( with geisendoerfers mysql module ) 并使这个池可供我模块中的其他文件访问:

var pool = require('./database').pool;

在app.js中发起一次:

var options   = {
  host     : 'host',
  user     : 'user',
  password : 'pwd',
  database : 'database'
}

var makePool      = require('./MyModule/lib/database').createPool(options);

这很好用!
但现在我也尝试在 index.js 文件中获取函数 createPool ，这样我就可以调用

var options = {...}
var makePool = require('./MyModule').createPool(options);

我在 index.js 中尝试了这种方法:

var database  = require('./lib/database');
var register  = require('./lib/register');
var table     = require('./lib/table');

module.exports = {
  createPool      : database.createPool,
  register        : register.addNewUser,
  createNewTable  : table.createTable,
  dropTable       : table.dropTable
}

现在对我来说有些奇怪。 这在 App.js 中正常工作:

var options   = {...}

var makePool      = require('./myModule').createPool(options);
var pool          = require('./myModule/lib/database').pool;

pool.getConnection(function(err, connection){
  connection.query('SELECT 12 + 8 AS solution', function(err, result){
    console.log(result);
    connection.release();
  });
});

但这在例如 register.js 中不起作用。 那里的池未定义...

var pool          = require('./database').pool;
console.log(pool);

这种东西的通用设计模式如何？ 最好的马丁

Answer 1

要理解为什么 pool 是 undefined，您需要逐步查看您的代码。

1. 在您的 App.js 中，您有这一行:

var makePool = require('./myModule').createPool(options);

这将首先包含 myModule，然后对结果调用 createPool。

2. 在 myModule 的 index.js 中有一行:

var register  = require('./lib/register')

此行在返回此文件的module.exports之前被调用，它在App.js<中的.createPool(options)之前 被调用。

3. 在 register.js 中，您有以下几行:

 var pool          = require('./database').pool;
 console.log(pool);

但在您尝试获取 require('./database').pool 时，它并不存在，因为当时未调用 createPool。

4. 在 myModule 中完成所有操作后，将调用 createPool 并创建 pool。

---

那你怎么解决这个问题呢？

一种方法是重构您的代码，以便对 .pool 的访问始终包含某些内容。例如在调用 require('./myModule') 之前，在 App.js 中调用 require('./lib/database').createPool(options) 。

但这不是最佳解决方案，因为您需要在文档中写入此顺序才能使您的代码正常工作。

更好的方法是使用某种异步方法来请求池，而不是直接访问属性。

要么使用回调:

require('./lib/database')
.getPool(function(err, pool) {
    //do something with the pool or show the error message
});

或使用 Promise(例如 bluebird ):

require('./lib/database').getPool()
.then(function(pool) {
   //do something with the pool
})
.catch(function(e) {
   //do something in case of the error
});

你肯定需要为你的 getPool 实现一些逻辑，这取决于用例，如果 getPool< 时没有 pool 存在，这可能是 然后直接继续错误，或者您将等到创建池，然后继续成功状态。