Skip to content

CommonJS

在 nodejs 中,由于有且仅有一个入口文件(启动文件),而开发一个应用肯定会涉及到多个文件配合,因此,nodejs 对模块化的需求比浏览器端要大的多

由于 nodejs 刚刚发布的时候,前端没有统一的、官方的模块化规范,因此,它选择使用社区提供的 CommonJS 作为模块化规范

在学习 CommonJS 之前,首先认识两个重要的概念:模块的导出模块的导入

模块的导出

要理解模块的导出,首先要理解模块的含义

什么是模块?

模块就是一个 JS 文件,它实现了一部分功能,并隐藏自己的内部实现,同时提供了一些接口供其他模块使用

模块有两个核心要素:隐藏暴露

隐藏的,是自己内部的实现

暴露的,是希望外部使用的接口

任何一个正常的模块化标准,都应该默认隐藏模块中的所有实现,而通过一些语法或 api 调用来暴露接口

暴露接口的过程即模块的导出

模块的导入

当需要使用一个模块时,使用的是该模块暴露的部分(导出的部分),隐藏的部分是永远无法使用的。

当通过某种语法或 api 去使用一个模块时,这个过程叫做模块的导入

CommonJS 规范

CommonJS 使用exports导出模块,require导入模块

具体规范如下:

  1. 如果一个 JS 文件中存在exportsrequire,该 JS 文件是一个模块
  2. 模块内的所有代码均为隐藏代码,包括全局变量、全局函数,这些全局的内容均不应该对全局变量造成任何污染
  3. 如果一个模块需要暴露一些 API 提供给外部使用,需要通过exports导出,exports是一个空的对象,你可以为该对象添加任何需要导出的内容
  4. 如果一个模块需要导入其他模块,通过require实现,require是一个函数,传入模块的路径即可返回该模块导出的整个内容

nodejs 对 CommonJS 的实现

为了实现 CommonJS 规范,nodejs 对模块做出了以下处理

  1. 为了保证高效的执行,仅加载必要的模块。nodejs 只有执行到require函数时才会加载并执行模块

  2. 为了隐藏模块中的代码,nodejs 执行模块时,会将模块中的所有代码放置到一个函数中执行,以保证不污染全局变量。

    js
    (function () {
      //模块中的代码
    })();
  3. 为了保证顺利的导出模块内容,nodejs 做了以下处理

    1. 在模块开始执行前,初始化一个值module.exports = {}
    2. module.exports即模块的导出值
    3. 为了方便开发者便捷的导出,nodejs 在初始化完module.exports后,又声明了一个变量exports = module.exports
    js
    (function (module) {
      module.exports = {};
      var exports = module.exports;
      //模块中的代码
      return module.exports;
    })();
  4. 为了避免反复加载同一个模块,nodejs 默认开启了模块缓存,如果加载的模块已经被加载过了,则会自动使用之前的导出结果

MIT License