当前位置: 首页 > 工具软件 > CommonJS > 使用案例 >

commonjs 使用与原理

梁丘飞鸾
2023-12-01

commonjs特点:

1.在 commonjs 中每一个 js 文件都是一个单独的模块,我们可以称之为 module;

2.该模块中,包含 CommonJS 规范的核心变量: exports、module.exports、require;

3.exports 和 module.exports 可以负责对模块中的内容进行导出;

4.require 函数可以帮助我们导入其他模块(自定义模块、系统模块、第三方库模块)中的内容;

简单的导出(fn_data.js):

let name = '张三'

module.exports = function setName() {
  return name
}

简单的导入(fn_handle.js):

let setName = require('./fn_data.js')

module.exports = function set() {
  return {
    name: setName(),
    title: '夜空中最亮的星'
  }
}

commonjs 实现原理:

每个模块文件上存在 moduleexportsrequire三个变量

  • module 记录当前模块信息。
  • require 引入模块的方法。
  • exports 当前模块导出的属性

这三个变量是没有被定义的,但是我们可以在 Commonjs 规范下每一个 js 模块上直接使用它们。在 nodejs 中还存在 __filename 和 __dirname 变量

在编译的过程中,实际 Commonjs 对 js 的代码块进行了首尾包装,使用的 require ,exports ,module 是通过形参的方式传递到包装函数中的, fn_handle.js中被包装之后的样子如下:

(function(exports,require,module,__filename,__dirname){
   const setName = require('./fn_data.js')
    module.exports = function set(){
        return {
            name: setName(),
            title: '夜空中最亮的星'
        }
    }
})

包装函数:

function wrapper (script) {
    return '(function (exports, require, module, __filename, __dirname) {' + 
        script +
     '\n})'
}
const modulefunction = wrapper(`
  const setName = require('./fn_data.js')
    module.exports = function set(){
        return {
            name: setName(),
            title: '夜空中最亮的星'
        }
    }
`)

在模块加载的时候,会通过 runInThisContext (可以理解成 eval ) 执行 modulefunction ,传入require ,exports ,module 等参数,最终执行

runInThisContext(modulefunction)(module.exports, require, module, __filename, __dirname)

下一篇:require文件加载流程

 类似资料: