深入理解TypeScript——扩展篇之CommonJS规范

TypeScript是编译器 也是一种规范。

通过tsconfig.json可以自定义开发配置,这里有一份官方JSON配置文件,可作为参考。

逼不得已,又熟悉了一波CommonJS规范,这里必须得感谢像阮一峰这样的大佬们(先驱们),在中国互联网迅速发展的大环境中,这些为我们指路的人,是值得尊敬的。

温故而知新,获益匪浅。CommonJS的规范制定是很有必要的,对于服务端(NodeJS)来说,它有着稳定的运行环境,而CommonJS的好处是让代码文件(JS文件)遵循它的规则,从读取到回收,都遵循一套近乎完美的极致,被高效的利用。

引CommonJS规范,做下重点摘录,方便回头翻看。

一、概述

  1. 每个模块都是一个局部环境,在模块内定义的变量、函数、类,都是私有的,在其他文件内不可见。
  2. 如果想在多个文件分享变量,必须定义为global对象的属性。

深入理解TypeScript——扩展篇之CommonJS规范

这样可以被全局引用,但是这个写法官方不推荐。我想不应该在单个模块文件中去定义这种全局变量。 如果真的有需要的话,可以统一一份全局文件或者环境变量去使用,方便维护。知乎上有专门针对这个问题的探讨,可作参考,不多赘述。

3.模块有“入口”和“出口”:模块可以比喻为一个超市,超市从批发市场引入(require)了一堆商品来售卖(export),人们从超市内去获取(require)这些商品。

4.CommonJS实现了以下几点
(1) 所有代码都运行在模块作用域,不会污染全局作用域。(源码中,module外层是一个函数,执行这个函数会导出exports对象)
(2) 模块可以多次加载,但是只会在第一次加载时运行一次,然后运行结果就被缓存了,以后再加载,就直接读取缓存结果。要想让模块再次运行,必须清除缓存。(所以代码文件有改动的话,是需要重新启动程序的)
(3) 模块加载的顺序,按照其在代码中出现的顺序。

二、module对象

  1. Node内部提供一个Module构建函数。所有模块都是Module的实例。

深入理解TypeScript——扩展篇之CommonJS规范

module属性:
(1 ) module.id 模块的识别符,通常是带有绝对路径的模块文件名。
(2) module.filename 模块的文件名,带有绝对路径。
(3) module.loaded 返回一个布尔值,表示模块是否已经完成加载。
(4) module.parent 返回一个对象,表示调用该模块的模块。(判断是否为入口脚本,值为null则是入口脚本)
(5) module.children 返回一个数组,表示该模块要用到的其他模块。
(6) module.exports 表示模块对外输出的值。

深入理解TypeScript——扩展篇之CommonJS规范

2.exports 变量
Node为每个模块提供一个exports变量,指向module.exports。这等同在每个模块头部,有一行这样的命令。(我想作者在定义这个变量的时候,考虑的是代码的书写精简性才加的这个把2333)

深入理解TypeScript——扩展篇之CommonJS规范

注意,不能直接将exports变量指向一个值,因为这样等于切断了exports与module.exports的联系,exports将不再指向module.exports。
推荐只使用module.exports,避免问题产生。

三、AMD规范与CommonJS规范的兼容性

CommonJS规范加载模块是同步的,也就是说,只有加载完成,才能执行后面的操作。AMD规范则是非同步加载模块,允许指定回调函数。由于Node.js主要用于服务器编程,模块文件一般都已经存在于本地硬盘,所以加载起来比较快,不用考虑非同步加载的方式,所以CommonJS规范比较适用。但是,如果是浏览器环境,要从服务器端加载模块,这时就必须采用非同步模式,因此浏览器端一般采用AMD规范。

四、require命令

  1. Node使用CommonJS模块规范,内置的require命令用于加载模块文件。
    require命令的基本功能是,读入并执行一个JavaScript文件,然后返回该模块的exports对象。如果没有发现指定模块,会报错。
  2. 根据参数的不同格式,require命令去不同路径寻找模块文件。
    (1) 如果参数字符串以“/”开头,则表示加载的是一个位于绝对路径的模块文件。比如,require('/home/marco/foo.js')将加载/home/marco/foo.js。(2) 如果参数字符串以“./”开头,则表示加载的是一个位于相对路径(跟当前执行脚本的位置相比)的模块文件。比如,require('./circle')将加载当前脚本同一目录的circle.js。(3) 如果参数字符串不以“./“或”/“开头,则表示加载的是一个默认提供的核心模块(位于Node的系统安装目录中),或者一个位于各级node_modules目录的已安装模块(全局安装或局部安装)。 举例来说,脚本/home/user/projects/foo.js执行了require('bar.js')命令,Node会依次搜索以下文件。

深入理解TypeScript——扩展篇之CommonJS规范

3.目录加载规则
在目录中放置一个package.json文件,并且将入口文件写入main字段。
require发现参数字符串指向一个目录以后,会自动查看该目录的package.json文件,然后加载main字段指定的入口文件。如果package.json文件没有main字段,或者根本就没有package.json文件,则会加载该目录下的index.js文件或index.node文件。

深入理解TypeScript——扩展篇之CommonJS规范

4.模块的缓存
(1) 加载模块
第一次加载某个模块时,Node会缓存该模块。以后再加载该模块,就直接从缓存取出该模块的module.exports属性。
(2) 删除模块

深入理解TypeScript——扩展篇之CommonJS规范

5.环境变量
(1) 将NODE_PATH添加到

深入理解TypeScript——扩展篇之CommonJS规范

(2) package.json

深入理解TypeScript——扩展篇之CommonJS规范

6.循环加载
如果发生模块的循环加载,即A加载B,B又加载A,则B将加载A的不完整版本。

7.require.main

require方法有一个main属性,可以用来判断模块是直接执行,还是被调用执行。
直接执行的时候(node module.js),require.main属性指向模块本身。

深入理解TypeScript——扩展篇之CommonJS规范

五、模块的加载机制

CommonJS模块的加载机制是,输入的是被输出的值的拷贝。也就是说,一旦输出一个值,模块内部的变化就影响不到这个值。

  1. require的内部处理流程
    require命令是CommonJS规范之中,用来加载其他模块的命令。它其实不是一个全局命令,而是指向当前模块的module.require命令,而后者又调用Node的内部命令

Module._load。

深入理解TypeScript——扩展篇之CommonJS规范

module.compile()执行指定模块的脚本,逻辑如下。

深入理解TypeScript——扩展篇之CommonJS规范

2.require函数及其辅助方法主要如下。

深入理解TypeScript——扩展篇之CommonJS规范

一旦require函数准备完毕,整个所要加载的脚本内容,就被放到一个新的函数之中,这样可以避免污染全局环境。该函数的参数包括require、module、exports,以及其他一些参数。

深入理解TypeScript——扩展篇之CommonJS规范

Module._compile方法是同步执行的,所以Module._load要等它执行完成,才会向用户返回module.exports的值。

  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值