Node.js和模块范围:将文件读入内存的最有效方法

时间:2018-08-02 14:06:33

标签: javascript node.js readfile fs commonjs

我试图更好地了解node.js模块的范围,并在变量实例化的上下文中进行要求。更具体地说,将文件读取到内存中。

我有一个带有模块的http服务器,该模块读取存储在代码库中的静态sql文件并执行其中包含的查询。例如:

'use strict';

const fs = require('fs')
const executeSql = require('./utils/execute-sql');

module.exports.getDataById = (id) => {
  const sql = fs.readFileSync(
    `./data-access/sql/getDataById.sql`, 'utf8'
  );

  return executeSql(sql, id);
}

module.exports.getDataByName = (name) => {
  const sql = fs.readFileSync(
    `./data-access/sql/getDataByName.sql`, 'utf8'
  );

  return executeSql(sql, name);
}

我的理解是,每次调用这些功能(getDataByIdgetDataByName)时,文件都会以阻塞方式同步读取并阻塞执行线程。我知道我可以异步读取文件来避免这种情况,但是我真正好奇的是是否将sql变量从函数中拉出并进入模块作用域,这意味着readFile操作仅发生一次(实例化节点进程时)最终会更高效。例如:

'use strict';

const fs = require('fs')
const executeSql = require('./utils/execute-sql');
const sql1 = fs.readFileSync(
  `./data-access/sql/getDataById.sql`, 'utf8'
);
const sql2 = fs.readFileSync(
  `./data-access/sql/getDataByName.sql`, 'utf8'
);

module.exports.getDataById = (id) => {
  return executeSql(sql1, id);
}

module.exports.getDataByName = (name) => {
  return executeSql(sql2, name);
}

我知道require在节点进程初始化时同步加载模块,并在其他地方需要时进一步缓存这些模块,但是我想了解的是,如果标准变量声明不使用{{ 1}}产生了一个类似的实例化内存引用,该引用在节点进程的生存期内一直存在,不需要在每次需要模块时都重新实例化。

感谢您提供的任何见解。

1 个答案:

答案 0 :(得分:0)

你是对的。每次模块需要另一个模块时,仅在第一次执行代码时,其余时间仅返回缓存的exports,因此在您的示例中,fs.readFileSync将运行一次(第一次有人需要它时),node.js将缓存exports对象,然后要求返回exports对象,而无需再次运行代码。

您可以使用以下方法进行测试:

var mod = require("./myModule");
console.log(mod.nonExistantProperty); // This will log undefined
mod.nonExistantProperty = "yay";

var requireagain = require("./myModule");
console.log(requireagain.nonExistantProperty); // This will log yay

在第二个需求中,它不再返回执行模块代码,而是仅返回已缓存的对象,因此您可以查看在第二次要求它之前所做的修改。

有了此信息,在第一个示例中,您将在导出中返回函数,每次您调用它们时(显然)将执行它们的代码,因此,如果函数中有readfile方法,则它将每次运行。

您的第二种方法是通常用来提高性能的方法,因为该代码仅运行一次(在第一次需要时),并且每次执行导出的函数时,它们将访问已经缓存了文件内容的变量内容。恭喜您得出这个结论:-)坚持下去。