模块
在计算机程序的开发中,随着代码越写越多,在一个文件里代码就会越来越长,越来越不容易维护.
为了编写可维护的代码,我们把很多函数分组,分别放在不同的文件里,这样,每个文件包含的代码就相对较少,很多变成语言都采用这种方式组织代码. 在Node环境中,一个.js文件就是一个模块(module)
使用模块有什么好处?
最大的好处就是大大提高了代码的可维护性,其次,编写代码不必从0开始,当一个模块编写完毕,就可以被其他地方引用,我们在编写程序的时候,也经常引用其他模块,包括Node内置的模块和来自第三方的模块.
使用模块还可以避免函数名和变量名冲突,形同名字的函数和变量完全可以分别存在不同的模块中,因此,我们自己在编写模块时,不必考虑名字会与其他模块冲突
在上一节,我们编写了一个hello.js文件,这个hello.js文件就是一个模块,模块的名字就是文件名不带js后缀,所以hello.js文件就是名为hello的模块.
我们把hello.js改造一下,创建一个函数,这样我们就可以在其他地方调用这个函数:
'use strict'
var s = 'Hello';
function greet(name){
console.log(s + ',' + name + '!');
}
module.exports = greet;
函数greet()是在hello模块中定义的,代码的最后一行赋值语句是,把函数greet作为模块的输出暴露出去,这样其他模块就可以使用greet函数了
问题是其他模块怎么使用hello模块这个greet函数呢,我们在编写一个mian.js文件,调用hello模块的greet函数
'use strict'
//引用hello模块
var greet = require('./hello');
var s = 'Michael';
greet(s);
注意到引入hello模块用Node提供的require函数:
引入的模块最为变量保存在greet变量中,那greet变量到底是什么东西?
其实变量greet就是hello.js中我们用module.exports=greet;输出的greet函数,所以main.js就成功引用了hello模块中定义的greet()函数了,因为main.js和hello.js位于同一个目录,所以我们使用了当前目录’.’
var greet = require('./hello'); // 不要忘了写相对目录!
如果只写模块名
var greet = require(‘hello’);
则Node会依次在内置模块,全局模块和当前模块下查找hello.js,你可能会得到一个错误:
module.js
throw err;
遇到这个错误,你要检查:
- 模块名是否写对了;
- 模块文件是否存在;
- 相对路径是否写对了。
CommonJS规范
这种模块加载机制被称为CommonJS规范,在这个规范下,每个.js文件都是一个模块,他们内部各自使用的变量名和函数名都互不冲突
一个模块想要对外暴露变量(函数也是变量),可以用module.exports= variable,一个模块要引用其他模块暴露的变量,用var ref = require(“module_name_”)就拿到了模块引用的变量;
结论
要在模块中对外输出变量,用:
module.exports = variable;
输出的变量可以是任意对象、函数、数组等等。
要引入其他模块输出的对象,用:
var foo = require('other_module');
引入的对象具体是什么,取决于引入模块输出的对象。
如果要输出一个键值对象’{}’,可以利用exports这个已存在的空对象{},并继续在上面添加新的键值;
如果要输出一个函数或数组,必须直接对module.exports对象赋值。
所以我们可以得出结论:直接对module.exports赋值,可以应对任何情况:
module.exports = {
foo: function () { return 'foo'; }
};
或者:
module.exports = function () { return 'foo'; };
最终,我们强烈建议使用module.exports = xxx的方式来输出模块变量,这样,你只需要记忆一种方法。