nodejs中模块定义实例详解
本文实例讲述了nodejs中模块定义方法。分享给大家供大家参考,具体如下:
1.模块定义
nodejs所谓的模块就是一个文件!一个.js文件就是一个nodejs的模块,模块与文件是一一对应的,那么引用模块就是require('文件路径')。
如:
var circle = require('./circle.js'); console.log( 'The area of a circle of radius 4 is ' + circle.area(4));
这个取名为foo.js
var PI = Math.PI; exports.area = function (r) { return PI * r * r; }; exports.circumference = function (r) { return 2 * PI * r; };
这个取名为circle.js
两个js代码文件是放在同一个文件夹下的。
如果你要引用其它文件夹下的模块,直接写定路径。这里的路径格式和linux的路径格式一样:/../../.js 这是绝对路径,../.js 这个是上一层 ./.js 这个就是当前路径。
这里需要注意exports与module.exports的区别:exports其实只是module.exports的一个引用(就像a=2,b=a这样,b只是引用了a,当b=c的时候,b就不指向a了),这样就能明白官网上的意思了(如果你想要将exports的根声明为一个函数,或者你想生成一个object,那么就请用module.exports而不是exports)
2.循环引用
a.js:
console.log('a starting'); exports.done = false; var b = require('./b.js'); console.log('in a, b.done = %j', b.done); exports.done = true; console.log('a done');
b.js:
console.log('b starting'); exports.done = false; var a = require('./a.js'); console.log('in b, a.done = %j', a.done); exports.done = true; console.log('b done');
main.js:
console.log('main starting'); var a = require('./a.js'); var b = require('./b.js'); console.log('in main, a.done=%j, b.done=%j', a.done, b.done);
看到没有,这个a.js与b.js两个相互引用了。这样会不会无限循环呢?不会的,这只是会有一个没有加载完毕,也就是有一个module一部分处于不可用状态。像这里,a.js先加载,但是在加载a.js的同时,a.js加载了b.js,此时a.js处于停滞状态,只是仅仅加载了require前面的数据,而对于b.js会一直加载完毕。下面是运行的结果:
$ node main.js main starting a starting b starting in b, a.done = false b done in a, b.done = true a done in main, a.done=true, b.done=true
3.核心模块
所谓核心模块,其实就是nodejs开发的公共包,就像Java的公共包一样。访问核心模块只要require('文件名字'),这样就能访问到。其实公共模块包是放在了nodejs安装的node_modules\npm\lib下面。
4.文件模块
当没有精确匹配所谓的引用时,nodejs会先采用扩展名:.js, .json, and then .node. .js文件就是JavaScript文件,.json就会以json格式解析,.node就会以dlopen加载为一个附加的模块
这里还需要注意,当没有'/'、'./'这样的符号修饰时,模块加载的地方是在node_modules,至于这个文件在哪,请看下面。
5.node_modules文件夹
如果在引用模块时没有'/' '../' './'这样的格式符号限定,那么其采用寻找的方式如下:假设你的文件在'/home/ry/projects/foo.js',其引用了require('bar.js')
,那么这个bar.js寻找方式如下:
/home/ry/projects/node_modules/bar.js
/home/ry/node_modules/bar.js
/home/node_modules/bar.js
/node_modules/bar.js
也就是从当前路基开始,一步一步向父目录添加node_modules文件夹作为模块地址。
require('example-module/path/to/file')
这种引用和require('bar.js')
是一样的解析。
6.以文件夹名字引用模块
大致分为两种:1)写package.json文件,此文件写在项目的根目录下,其形式如下:
{ "name" : "some-library", "main" : "./lib/some-library.js" }
这样写出来的require('./some-library')其真正的是
require('./some-library/lib/some-library.js')
2)直接约定好为index.js或index.node文件加载,同上的require,其加载可能如下:
./some-library/index.js
./some-library/index.node
7.缓存
一个模块的多次引用会只做一次加载。就像java中的static关键字修饰。不过要值得注意的是,当你require('foo')
这样的形式就不一定保证每次都会引用到相同的文件了(因为你可能会在不同的文件夹中引用)。
希望本文所述对大家nodejs程序设计有所帮助。