【JS模块】common JS 规范 看这一篇足够了_commonjs规范-程序员宅基地

技术标签: node.js  前端  es6  

为什么会有模块这个说法

我们通常在学习新的东西时,都要问一个问题:为什么需要它,它能干嘛,它解决了什么?
模块往往是语言标准中的一部门,最基本的作用就是隔离命名空间,避免出现命名冲突。
假设:
在a.js中有一个变量"name",在b.js中也有一个变量"name",那么用“script”标签加载这两个js脚本,那么最终name的值是哪一个?

// a.js
var name = 'I am a.js'

// b.js
var name = 'I am b.js'

// index.html
<script type="text/javascript" src="/a.js"></script>
<script type="text/javascript" src="/b.js"></script>

执行之后:

> name
> 'I an b.js'

结果表明b.js中的“name”变量覆盖了a.js中的“name”变量。这种情况我们称之为命名冲突。
最简单的解决方法:即时运行函数:

(
  function(){
    
    var name = 'I am a.js'
  }
)()

我们将name变量封装在一个函数作用域内,这样不会污染全局作用域,是一种简单的封装私有变量方式。
但是,我们可能需要导出一些值,又不想污染全局作用域,普通的封装是不能满足的。
那我们可以新建一个空的Object{},我们把这个对象传给立即执行函数,让它把要导出的变量都放在这个object里面

// a.js
// 运行这个脚本,将执行下面这个匿名函数,这个函数会返回一个函数moduleFn
// module函数接收一个object对象,把a.js要导出的变量放在这个对象里面
(
  function(){
    
    return function moduleFn(object){
    
      object.name = "I am a.js"
    }
  }
)()

// main.js
var exports = {
    }  // 准备一个空对象用来保存a.js导出的变量
eval(readFile('./a.js'))(exports)
console.log(exports.name)

为了方便,我们可以把上面的操作封装成一个require函数

function require( modulePath ){
    
  var exports = {
    }
  eval(readFile(modulePath))(exports)
  return exports
}

有了这个函数,我们可以这样导入一个js文件

var a = require('./a.js')

node.js最开始的导入模块规范:CommonJS模块大致上就是这种思想。

CommonJS 模块规范

假设:a.js 和 b.js 共用一个c.js这个模块,c.js 会计算圆周率,数据量很大,我们希望a.js和b.js共享起来,而不是引用一次计算一次,并且a.js和b.js拿到的应该是同一个对象。
我们需要把每次加载的模块都保存起来。

var cache = {
    }  // 保存加载过的模块
function require( modulePath ){
    
  if(cache[modulePath]) return cache[modulePatch]
  var module = {
    
    path: modulePath,  // 模块路径
    exports: {
    },  // 保存模块导出的变量
  }
  cache[modulePatch] = module
  eval(readFile(modulePatch))(module.export)
  return module.exports
}

通过保存加载的模块,也可以防止由于循环依赖导致加载陷入死循坏的问题:

// a.js
require('a.js')

// b.js
require('b.js')

但是有时候我们可能会导出一个函数而不是Object,如果直接赋值object显然是没有任何作用的

(
  function(){
    
    return function moduleFunction(object){
    
      object = function(){
    }  // 这样是行不通的
    }
  }
)()

因为object只是一个参数,它是module.exports的引用,直接对它赋值,只是让object指向一个函数,并没有实际更改module.exports。我们可以自己把module传给a.js

var cache = {
    }
function require( modulePath ){
    
  if(cache[modulePach]) return cache[modulePath]
  var module = {
    
    path: modulePath,
    exports: {
    },
  }
  cache[modulePath] = module
  /*----- 把module也传给a.js -----*/
  eval(readFile(modulePach))(module,module.exports)
  return module.exports
}

a.js 就函数就可以接受module了

(
  function(){
    
    return function moduleFunction(module,export){
    
      module.export = function(){
    }  // 这样就可以直接导出一个函数了
    }
  }
)()

common JS模块的规范最重要的就是三个对象
module: 保存当前模块的信息,是一个Object
exports:用于导出模块变量的对象
require:用于导入模块的函数

我们在来看看

Node.js 的 CommonJS规范实现

上面讲了那么多,当我们写Node.js的时候,没有看到一个函数需要接受module,exports和require,其实这是node.js帮你做好了。
列如,我们的a.js是这样写的

var test = require('b.js')
module.exports = function(){
    }

其实Node.js通过 readFileSync 把a.js代码读到content变量里:

content = fs.readFileSync(filename,'utf8')
module._compile(content,filename) // 读出来调用_compile函数进行编译

_compile函数中,会把a.js包裹成一个接受module,exports和require的函数:

// _compile 函数调用wrapSafe把a.js包裹成一个函数
const compileWrapper = wrapSafe(filename,content,this)

//wrapSafe 函数中调用 Module.wrap 包裹content字符串
const wrapper = Module.wrap(content)

// Module.wrap函数对content的包裹
const wrapper=[
  '(function(exports,require,module,_filename,_dirname){',
  '\n})'
]
return Module.wrapper[0] + script + Module.wrapper[1]

// 调用wrap函数包裹后,wrapper的值为:
const wrapper = `
  (function(exports,require,module,_filename,_dirname){
    var test = require('b.js')
    module.exports = function(){}
  })
`

// 我们运行这个字符串,compileWrapper 最后得到一个函数
const compileWrapper =  (function(exports,require,module,_filename,_dirname){
    
    var test = require('b.js')
    module.exports = function(){
    }
})

// 然后调用compileWrapper,并且传入module,epxports,require
result = compileWrapper.call(thisValue,exports,require,module,filename,dirname)

可以看的出来包裹后的函数其实是五个函数,多添加_filename和_dirname,用于只是当前js文件的文件名和所在目录。
补充:module在Node.js中是一个Module实例

Module {
    
  id: '', // 模块ID,用于唯一识别一个模块,通常是绝对路径
  path: '', // 模块路径
  exports: {
    }, // 保存模块的导出变量
  parent: null | Module, //父级模块
  filename: '',  // 模块的文件路口
  loaded: true | false , // 模块是否加载完毕
  children: Module [], // 模块内加载的其他模块
  path: [], // 查找模块产生的路径
}
版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/www569006806/article/details/124222755

智能推荐

Docker 快速上手学习入门教程_docker菜鸟教程-程序员宅基地

文章浏览阅读2.5w次,点赞6次,收藏50次。官方解释是,docker 容器是机器上的沙盒进程,它与主机上的所有其他进程隔离。所以容器只是操作系统中被隔离开来的一个进程,所谓的容器化,其实也只是对操作系统进行欺骗的一种语法糖。_docker菜鸟教程

电脑技巧:Windows系统原版纯净软件必备的两个网站_msdn我告诉你-程序员宅基地

文章浏览阅读5.7k次,点赞3次,收藏14次。该如何避免的,今天小编给大家推荐两个下载Windows系统官方软件的资源网站,可以杜绝软件捆绑等行为。该站提供了丰富的Windows官方技术资源,比较重要的有MSDN技术资源文档库、官方工具和资源、应用程序、开发人员工具(Visual Studio 、SQLServer等等)、系统镜像、设计人员工具等。总的来说,这两个都是非常优秀的Windows系统镜像资源站,提供了丰富的Windows系统镜像资源,并且保证了资源的纯净和安全性,有需要的朋友可以去了解一下。这个非常实用的资源网站的创建者是国内的一个网友。_msdn我告诉你

vue2封装对话框el-dialog组件_<el-dialog 封装成组件 vue2-程序员宅基地

文章浏览阅读1.2k次。vue2封装对话框el-dialog组件_

MFC 文本框换行_c++ mfc同一框内输入二行怎么换行-程序员宅基地

文章浏览阅读4.7k次,点赞5次,收藏6次。MFC 文本框换行 标签: it mfc 文本框1.将Multiline属性设置为True2.换行是使用"\r\n" (宽字符串为L"\r\n")3.如果需要编辑并且按Enter键换行,还要将 Want Return 设置为 True4.如果需要垂直滚动条的话将Vertical Scroll属性设置为True,需要水平滚动条的话将Horizontal Scroll属性设_c++ mfc同一框内输入二行怎么换行

redis-desktop-manager无法连接redis-server的解决方法_redis-server doesn't support auth command or ismis-程序员宅基地

文章浏览阅读832次。检查Linux是否是否开启所需端口,默认为6379,若未打开,将其开启:以root用户执行iptables -I INPUT -p tcp --dport 6379 -j ACCEPT如果还是未能解决,修改redis.conf,修改主机地址:bind 192.168.85.**;然后使用该配置文件,重新启动Redis服务./redis-server redis.conf..._redis-server doesn't support auth command or ismisconfigured. try

实验四 数据选择器及其应用-程序员宅基地

文章浏览阅读4.9k次。济大数电实验报告_数据选择器及其应用

随便推点

灰色预测模型matlab_MATLAB实战|基于灰色预测河南省社会消费品零售总额预测-程序员宅基地

文章浏览阅读236次。1研究内容消费在生产中占据十分重要的地位,是生产的最终目的和动力,是保持省内经济稳定快速发展的核心要素。预测河南省社会消费品零售总额,是进行宏观经济调控和消费体制改变创新的基础,是河南省内人民对美好的全面和谐社会的追求的要求,保持河南省经济稳定和可持续发展具有重要意义。本文建立灰色预测模型,利用MATLAB软件,预测出2019年~2023年河南省社会消费品零售总额预测值分别为21881...._灰色预测模型用什么软件

log4qt-程序员宅基地

文章浏览阅读1.2k次。12.4-在Qt中使用Log4Qt输出Log文件,看这一篇就足够了一、为啥要使用第三方Log库,而不用平台自带的Log库二、Log4j系列库的功能介绍与基本概念三、Log4Qt库的基本介绍四、将Log4qt组装成为一个单独模块五、使用配置文件的方式配置Log4Qt六、使用代码的方式配置Log4Qt七、在Qt工程中引入Log4Qt库模块的方法八、获取示例中的源代码一、为啥要使用第三方Log库,而不用平台自带的Log库首先要说明的是,在平时开发和调试中开发平台自带的“打印输出”已经足够了。但_log4qt

100种思维模型之全局观思维模型-67_计算机中对于全局观的-程序员宅基地

文章浏览阅读786次。全局观思维模型,一个教我们由点到线,由线到面,再由面到体,不断的放大格局去思考问题的思维模型。_计算机中对于全局观的

线程间控制之CountDownLatch和CyclicBarrier使用介绍_countdownluach于cyclicbarrier的用法-程序员宅基地

文章浏览阅读330次。一、CountDownLatch介绍CountDownLatch采用减法计算;是一个同步辅助工具类和CyclicBarrier类功能类似,允许一个或多个线程等待,直到在其他线程中执行的一组操作完成。二、CountDownLatch俩种应用场景: 场景一:所有线程在等待开始信号(startSignal.await()),主流程发出开始信号通知,既执行startSignal.countDown()方法后;所有线程才开始执行;每个线程执行完发出做完信号,既执行do..._countdownluach于cyclicbarrier的用法

自动化监控系统Prometheus&Grafana_-自动化监控系统prometheus&grafana实战-程序员宅基地

文章浏览阅读508次。Prometheus 算是一个全能型选手,原生支持容器监控,当然监控传统应用也不是吃干饭的,所以就是容器和非容器他都支持,所有的监控系统都具备这个流程,_-自动化监控系统prometheus&grafana实战

React 组件封装之 Search 搜索_react search-程序员宅基地

文章浏览阅读4.7k次。输入关键字,可以通过键盘的搜索按钮完成搜索功能。_react search