CommonJS规范

一、引入

1. 什么是模块化?

度娘是这么说的:模块化是指解决一个复杂问题时自顶向下逐层把系统划分成若干模块的过程,有多种属性,分别反映其内部特性。

简单的说,模块就是实现特定功能的一组方法,模块化将使代码更好的管理、维护和使用。

2. 为什么要模块化?

在ES6之前 JavaScript 并没有内置的标准模块系统,无法把大文件有组织地划分成小块,并管理之间地依赖。随着我们写的js代码越来越庞杂,如果不进行模块化,就可能引发命名冲突,造成不易复用、维护性高。

而如果有了模块,我们就可以更方便地使用别人的代码,想要什么功能,就加载什么模块。

3. 那么,什么为commonjs呢?

commonjs是JavaScript的一种模块规范,是nodejs也就是服务器端广泛使用的模块化机制。

该规范的主要内容是:模块必须通过module.exports 导出对外的变量或接口,通过 require() 来导入其他模块的输出到当前模块作用域中。

二、CommonJs

1、概述

每个文件就一个模块,有自己的作用域。在一个文件里面定义的变量、函数、类,都是私有的,对其他文件不可见。

CommonJS规范规定,每个模块内部,module变量代表当前模块。这个变量是一个对象,它的exports属性(即module.exports)是对外的接口。加载某个模块,其实是加载该模块的module.exports属性。

2. 特点

(1)代码运行在模块作用域,不会污染全局作用域。

(2)加载模块顺序按照其在代码中出现的顺序加载。

(3)加载模块是同步的。

(4)单例加载:也就是加载的模块会缓存起来,再次使用时,会直接用运行结果,不会再加载(除非手动清除)。

3. module对象

每个模块内部,都有一个module对象,代表当前模块。它有以下属性。

①module.id 模块的识别符,通常是带有绝对路径的模块文件名。

②module.filename 模块的文件名,带有绝对路径。

③module.loaded 返回一个布尔值,表示模块是否已经完成加载。

④module.parent 返回一个对象,表示调用该模块的模块。

⑤module.children 返回一个数组,表示该模块要用到的其他模块。

⑥module.exports 表示模块对外输出的值。

(1)module.exports

module.exports属性表示当前模块对外输出的接口,其他文件在加载该模块时,实际上就是读取module.exports变量。

(2)exports

为了方便,Node为每个模块提供一个exports变量,指向module.exports。这等同在每个模块头部,有一行这样的命令。

var exports = module.exports;

需要注意的是,如果一个文件中 module.exports 被重新赋值,该文件中其他exports出去的变量(属性)也是无效的。

4. 加载  require

(1)基本用法

node采用CommonJS规范。内置require命令用于加载模块:var foo = require("filename"),引入后了直接通过foo.的方式访问到其对外的接口或属性。

require命令的基本功能是,读入并执行一个JavaScript文件,然后返回该模块的exports对象。如果没有发现指定模块,会报错。

(2)加载规则

① require命令用于加载文件,后缀名默认为.js。

var foo = require('foo');

//  等同于

var foo = require('foo.js');

路径分三种情况

a. ('/main/app.js')  --绝对路径

b. ('./main/app.js') --相对路径 (当前路径下的main文件夹下的appjs文件)

c. ('react') --没有 以 ‘./  和 /’开头的路径,则表示加载的一个默认提供的核心模块,会去node_modules文件夹下找或node的系统安装目录中找。

② 如果指定的文件没有发现,node会尝试为文件名添加.js .json .node后缀,再搜索。.js文件会以文本格式的js脚本文件解析,.json文件会以JSON格式的文本文件解析,.node文件会以编译后的二进制文件解析。

(3)模块缓存

第一次加载某个模块,node会缓存该模块,以后再次加载会直接从缓存中取出该模块的module.exports属性

// 删除指定模块的缓存

delete require.cache[moduleName];

// 删除所有模块的缓存

Object.keys(require.cache).forEach(function(key) {

  delete require.cache[key];

})

5. AMD理解及与CommonJS的区别

(1)AMD是"Asynchronous Module Definition"的缩写,意思就是"异步模块定义"。它采用异步方式加载模块,模块的加载不影响它后面语句的运行。所有依赖这个模块的语句,都定义在一个回调函数中,等到加载完成之后,这个回调函数才会运行。

AMD也采用require()语句加载模块,但是不同于CommonJS,它要求两个参数:require([module], callback);

第一个参数[module],是一个数组,里面的成员就是要加载的模块;第二个参数callback,则是加载成功之后的回调函数。

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

参考:阮一峰http://www.w3cbus.com/nodejs/module.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,681评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,710评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,623评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,202评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,232评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,368评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,795评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,461评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,647评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,476评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,525评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,226评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,785评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,857评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,090评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,647评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,215评论 2 341

推荐阅读更多精彩内容