理解包结构
commonjs包结构规范:http://wiki.commonjs.org/wiki/Packages/1.0
- 一个package.json文件应该存在于包顶级目录下
- 二进制文件应该包含在bin目录下。
- JavaScript代码应该包含在lib目录下。
- 文档应该在doc目录下。
- 单元测试应该在test目录下。
理解描述文件package.json
输入 npm init
后会弹出一堆问题,我们可以输入对应内容,也可以使用默认值。在回答一堆问题后输入 yes
就会生成图中所示内容的 package.json
文件。如果嫌回答这一大堆问题麻烦,可以直接输入 npm init --yes
跳过回答问题步骤,直接生成默认值的 package.json
文件
- name。包名,需要在NPM上是唯一的,不能带有空格。
- description。包简介,通常会显示在一些列表中。
- version。版本号,一个语义化的版本号(http://semver.org/ ),通常为x.y.z。
- keywords。关键字数组,用于NPM中的分类搜索。
- maintainers。包维护者的数组,数组元素是一个包含name、email、web三个属性的JSON对象。
- contributors。包贡献者的数组。第一个就是包的作者本人。在开源社区,如果提交的patch被merge进master分支的话,就应当加上这个贡献patch的人。格式包含name和email。
"contributors": [{
"name": "Jackson Tian",
"email": "mail @gmail.com"
}, {
"name": "fengmk2",
"email": "mail2@gmail.com"
}],
bugs。一个可以提交bug的URL地址,可以是邮件地址(mailto:mailxx@domain),也可以是网页地址(http://url)。
licenses。包所使用的许可证,例如:
"licenses": [{ "type": "GPLv2", "url": "http://www.example.com/licenses/gpl.html", }]
repositories。托管源代码的地址数组。
dependencies。当前包需要的依赖,这个属性十分重要,NPM会通过这个属性,帮你自动加载依赖的包。
理解npm install
我们可以把项目发布到npm中央仓库,别人拿到我们的项目时,可以执行npm install下载所需要的模块,这些模块是依赖package.json中定义的,这些依赖都会被安装在当前目录下。
npm的包安装分为本地安装(local)、全局安装(global)两种。
npm install xxx # 本地安装
将安装包放在 ./node_modules 下(运行npm时所在的目录)
npm install -g xxx # 全局安装
将安装包放在/usr/local/lib/node_modules下。
使用 npm install
时增加 --save
或者 --save -dev
表示将这个包名及对应的版本添加到 package.json
的 dependencies
或devDependencies
。
使用模块
使用require函数用于在当前模块中加载和使用别的模块,传入一个模块名,返回一个模块导出对象。
优先从缓存中加载模块,其次在核心模块中加载,然后是指定文件路径的模块加载,如果以上三个条件均不满足,则定义为自定义模块,查找策略为从当前目录下的node_modules查找,找不到则向父目录的node_modules查找,直到根目录或找到为止。
如果在环境变量中设置了HOME目录和NODE_PATH目录的话,整个路径还包含NODE_PATH和HOME目录下的.node_libraries与.node_modules。
全局模块
为什么我们使用npm install -g命令安装的模块不能即时生效,那是因为npm install -g 会将模块默认安装在/usr/local/lib/node_modules中,而require模块的流程如刚才所说,默认情况下并没有自动查找到全局路径中。
可以通过三种方法解决:
- 可以在工程目录下执行npm link module_name
- 可以设置环境变量NODE_PATH
- 可以软链接一个目录,在某个父节点路径中创建node_modules,如下:
设置一个代理全局模块路径,这样npm install -g的模块都会安装在此
npm config set prefix "~/npm_global"
建立一个软链接
ln -s ~/npm_global/lib/node_modules ~/node_modules
查看全局安装模块的命令:
npm list --depth=0 -global
导出模块
exports该对象是当前模块的导出对象,用于导出模块公有方法和属性,默认为一个空对象{}。别的模块通过require()函数使用当前模块时得到的就是当前模块的exports对象。以下代码中导出了一个公有方法:
exports.hello = function() {
console.log("Hello World!");
};
在下面的情况下,你的模块是一个类:
module.exports = function(name, age) {
this.name = name;
this.age = age;
this.about = function() {
console.log(this.name +' is '+ this.age +' years old');
};
};
然后你应该这样使用它:
var Rocker = require('./rocker.js');
var r = new Rocker('Ozzy', 62);
r.about(); // Ozzy is 62 years old
在下面的情况下,你的模块是一个数组:
module.exports = ['Lemmy Kilmister', 'Ozzy Osbourne', 'Ronnie James Dio', 'Steven Tyler', 'Mick Jagger'];
然后你应该这样使用它:
var rocker = require('./rocker.js');
console.log('Rockin in heaven: ' + rocker[2]); //Rockin in heaven: Ronnie James Dio
exports
只是module.exports
的辅助方法。你的模块最终返回module.exports
给调用者,而不是exports
。exports
所做的事情是收集属性,如果module.exports
当前没有任何属性的话,exports
会把这些属性赋予module.exports
。如果module.exports
已经存在一些属性的话,那么exports
中所用的东西都会被忽略。
简单理解核心模块
核心模块中,有些模块使用C/C++编写,有些则由C/C++完成核心部分,由JavaScript实现包装和向外导出。
内建模块被统一放在一个node_module_list数组中,通过get_builtin_module方法取出,通过执行register_func()填充exports对象,将exports对象缓存并返回给调用方。