Node.js module.exports通过接口

时间:2014-05-12 10:29:23

标签: javascript mysql node.js

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

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

index.js 文件应该是一个接口文件,它提供模块的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);

这样的常见设计模式如何? 最好的马丁

2 个答案:

答案 0 :(得分:1)

要了解poolundefined的原因,您需要逐步查看代码。

1。在你App.js中你有这一行:

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

首先包含myModule,然后在结果上调用createPool

2。index.js的{​​{1}}中,你有这条线:

myModule

在返回此文件的var register = require('./lib/register') 之前调用此行,该行在调用module.exports中的.createPool(options)之前调用。

3。App.js中你有一行:

register.js

但是当你尝试获取 var pool = require('./database').pool; console.log(pool); 时它不存在,因为当时没有调用require('./database').pool

4。createPool完成所有操作后,调用myModule并创建createPool


那你怎么能解决这个问题?

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

但这不是最佳解决方案,因为您需要在文档中写入此订单才能使您的代码正常运行。

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

使用回调:

require('./myModule')

或使用Promises(例如bluebird):

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

您肯定需要为require('./lib/database').getPool() .then(function(pool) { //do something with the pool }) .catch(function(e) { //do something in case of the error }); 实施一些逻辑,具体取决于用例,如果当时getPool不存在pool,则会直接继续出错或者你会等到你创建了游泳池,然后继续成功状态。

答案 1 :(得分:0)

答案很简单,池不是在register.js中创建的

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

你需要先调用createPool,就像你在脚本中写的一样。