Node模块

理解包结构

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.jsondependenciesdevDependencies

使用模块

使用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给调用者,而不是exportsexports所做的事情是收集属性,如果module.exports当前没有任何属性的话,exports会把这些属性赋予module.exports。如果module.exports已经存在一些属性的话,那么exports中所用的东西都会被忽略。

简单理解核心模块

核心模块中,有些模块使用C/C++编写,有些则由C/C++完成核心部分,由JavaScript实现包装和向外导出。

内建模块被统一放在一个node_module_list数组中,通过get_builtin_module方法取出,通过执行register_func()填充exports对象,将exports对象缓存并返回给调用方。

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

推荐阅读更多精彩内容