node.js - 基础之module

nodejs-exports.jpg

1. node.js模块概述

为了让node.js的文件可以相互调用,node.js提供了一个简单的模块系统。模块是node.js应用程序基本的组成部分,文件和模块是一一对应的。换言之,一个node.js文件就是一个模块,这个文件可能是javascript代码、json或者编译过的c/c++扩展。

其中http、fs、net等都是node.js提供的核心模块,使用c/c++实现,外部用javascript封装。

2. 创建模块的两种方式

创建模块有两种方式,

  • 通过exports创建
  • 通过module.exports创建

2.1 通过exports创建模块

node.js中,创建一个模块非常简单,我们创建一个main.js文件,它引用了hello模块,代码如下,

var hello = require('./hello')
hello.world()

在上面的代码中,require('./hello')引入了当前目录下的hello.js文件。

./代表当前目录,node.js默认后缀为js。

node.js提供了exportsrequire两个对象,其中exports是模块公开的接口,require用于从外部获取一个模块的接口,即所获取模块的exports对象。

接下来我们创建hello.js文件,如下代码所示,

exports.world = function() {
  console.log('hello world')
}

以上示例中,hello.js通过exports对象把world作为模块的访问接口,在main.js中通过require('./hello')加载这个模块,然后就可以直接访问hello.js中exports对象的成员函数了。

2.2 通过module.exports创建模块

有时候我们只是想把一个对象封装到模块中,如下格式,

module.exports = function() {
    
}

以上面的格式,来写一个模块,如下hello.js代码,

function Hello() {
    var name;
    this.setName = function(thyName) {
        name = thyName
    }
    
    this.sayHello = function() {
        console.log('hello ' + name)
    }
}

module.exports = Hello

这样就可以直接获取这个对象了,如下main.js代码,

// main.js
var Hello = require('./hello')
hello = new Hello()
hello.setName('BYVoid')
hello.sayHello()

模块接口的唯一变化是使用module.exports = Hello代替了exports.world = function() {}。在外部引用该模块时,其接口对象就是要输出的Hello对象本身,而不是原先的exports。

2.3 exports和module.exports区别

为了更好地解释exports和module.exports之间的关系,先通过一个简单的js示例来做一个说明,如下代码,

var a = {name: 1}
var b = a

console.log(a)
console.log(b)

b.name = 2
console.log(a)
console.log(b)

b = {name: 3}
console.log(a)
console.log(b)

运行test.js结果为,

{ name: 1 }
{ name: 1 }
{ name: 2 }
{ name: 2 }
{ name: 2 }
{ name: 3 }

简单解释一下上面的代码:a是一个对象,b是对a对象的引用,此时a和b只想同一块内存,所以前两个输出一样;当对b做修改时,则a和b只想同一块内存地址的内容发生了改变,所以a的值改变也体现了出来;当b被覆盖时,b只想了一块新的内存,而a还是只想原来的内存,所以最后两个输出不一样。

明白了上面的例子之后,只需要指点3点就能了解exports和module.exports的区别了,

  1. module.exports初始值为一个空对象{}
  2. exports是只想module.exports的引用
  3. require()返回的是module.exports而不是exports

也就是说,module.exports才是真正的接口,exports只不过是它的一个辅助工具。最攻返回给调用者的是module.exports而不是exports。

再强调一点,在node.js中,一个文件对应一个模块。为了方便,模块中会有一个exports对象,它和module.exports指向同一个变量,所以我们修改exports对象的时候也会修改module.exports对象;当我们通过赋值方式为module.exports赋值时候,此时module.exports与exports对象指向的变量就不同了,所以无论exports对象怎么改,都和module.exports对象没有任何关系了。

加粗!加粗!加粗!一般来说,推荐使用module.exports,尽量少使用exports。

3. require搜索module的方式

在node.js中模块有两种类型,即,

  • 核心模块
  • 文件模块

3.1 搜索核心模块

核心模块直接使用名称获取,例如经常使用的http模块,使用如下代码获取,

var http = require('http')
...
http.createServer()

简要描述一下上面的代码,node.js中自带了一个叫做http的模块,在上述代码中我们请求它并把返回的值赋值给一个本地变量,这样本地变量就编程了一个拥有所有http模块所提供的公共方法的对象。

3.2 搜索文件模块

在前面创建模块的demo中,通过require('./hello')语法,如下代码,

var Hello = require('./hello')
hello = new Hello()
hello.setName('BYVoid')
...
...

这里,我们使用./test来获取自定义文件模块,这种通过相对路径或绝对路径是文件模块的搜索方式。

3.3 搜索模块的规则

node.js加载模块时,遵循了如下的加载规则,

  1. 核心模块优先级最高,直接使用名字加载,再有命名冲突的时候首先加载核心模块
  2. 文件模块只能按照路径加载 -- 相对路径或绝对路径,并且可以省略默认的.js后缀名
  3. 查找node_modules目录,当我们在调用npm install <name>命令的时候,会在当前目录下创建node_module目录来安装模块,当require遇到一个既不是核心模块,又不是以路径形式表示的模块名称时,会试图在当前目录下的node_modules目录中查找是不是有这样一个模块。如果没有找到,则会在当前目录的上一层的node_modules目录中继续查找,反复执行这一过程,知道遇到根目录位置。

相对路径 - 例如: ./hello表示同级目录,../hello表示上层目录

绝对路径 - 例如: /Users/user/Desktop/js/hello

4. 参考链接

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

推荐阅读更多精彩内容

  • Node.js是目前非常火热的技术,但是它的诞生经历却很奇特。 众所周知,在Netscape设计出JavaScri...
    w_zhuan阅读 3,612评论 2 41
  • Node.js是目前非常火热的技术,但是它的诞生经历却很奇特。 众所周知,在Netscape设计出JavaScri...
    Myselfyan阅读 4,066评论 2 58
  • topics: 1.The Node.js philosophy 2.The reactor pattern 3....
    宫若石阅读 1,064评论 0 1
  • 1 Node.js模块的实现 之前在网上查阅了许多介绍Node.js的文章,可惜对于Node.js的模块机制大都着...
    zlx_2017阅读 1,232评论 0 1
  • 于不经意间,我们乘着时光的步伐从懵懵懂懂的孩提走向成熟世故的青年。太多的变迁,太多的出世。更在不经意间我们丢失了去...
    左鸿鹄阅读 274评论 0 0