跟我学Nodejs(三)--- Node.js模块


Posted in NodeJs onMay 25, 2014

简介及资料

    通过Node.js的官方API可以看到Node.js本身提供了很多核心模块 http://nodejs.org/api/ ,这些核心模块被编译成二进制文件,可以require('模块名')去获取;核心模块具有最高的加载优先级(有模块与核心模块同名时会体现)

    (本次主要说自定义模块)

    Node.js还有一类模块为文件模块,可以是JavaScript代码文件(.js作为文件后缀)、也可以是JSON格式文本文件(.json作为文件后缀)、还可以是编辑过的C/C++文件(.node作为文件后缀);

    文件模块访问方式通过require('/文件名.后缀')    require('./文件名.后缀')    requrie('../文件名.后缀') 去访问,文件后缀可以省略;以"/"开头是以绝对路径去加载,以"./"开头和以"../"开头表示以相对路径加载,而以"./"开头表示同级目录下文件,

    前面提到文件后缀可以省略,Nodejs尝试加载的优先级 js文件 > json文件 > node文件

创建一个自定义模块

 

以一个计数器为例

跟我学Nodejs(三)--- Node.js模块

var outputVal  = 0;     //输出值
var increment = 1;    //增量
/* 设置输出值 */
function seOutputVal (val) {
    outputVal = val;
}
/* 设置增量 */
function setIncrement(incrementVal){
    increment = incrementVal;
}
/* 输出 */
function printNextCount()
{    
    outputVal += increment;
    console.log(outputVal) ;
}
function printOutputVal() {
    console.log(outputVal);
}
exports.seOutputVal = seOutputVal;
exports.setIncrement = setIncrement;
module.exports.printNextCount = printNextCount;
自定义模块 示例源码

示例中重点在于exports和module.exports;提供了外部访问的接口,下面调用一下看看效果吧

调用自定义模块

跟我学Nodejs(三)--- Node.js模块

/*
    一个Node.js文件就是一个模块,这个文件可能是Javascript代码、JSON或者编译过的C/C++扩展。
    重要的两个对象:
    require是从外部获取模块
    exports是把模块接口公开    
*/
var counter = require('./1_modules_custom_counter');
console.log('第一次调用模块[1_modules_custom_counter]');
counter.seOutputVal(10);               //设置从10开始计数
counter.setIncrement (10);             //设置增量为10
counter.printNextCount();
counter.printNextCount();
counter.printNextCount();
counter.printNextCount();
/*
    require多次调用同一模块不会重复加载
*/
var counter = require('./1_modules_custom_counter');
console.log('第二次调用模块[1_modules_custom_counter]');
counter.printNextCount();
自定义模式调用 源码

    运行可以发现通过exports和module.exports对外公开的方法都可以访问!

    示例中可以看到,我两次通过require('./1_modules_custom_counter')获取模块,但是第二次引用后调用printNextCount()方法确从60开始~~~

    原因是node.js通过requirerequire多次调用同一模块不会重复加载,Node.js会根据文件名缓存所有加载过的文件模块,所以不会重新加载了

    注意:通过文件名缓存是指实际文件名,并不会因为传入的路径形式不一样而认会是不同的文件    

    在我创建的1_modules_custom_counter文件中有一个printOutputVal()方法,它并没有通过exports或module.exports提供对外公开访问方法,

    如果1_modules_load文件中直接访问运行会出现什么样的情况呢?

    答案是:TypeError: Object #<Object> has no method 'printOutputVal'

exports和module.exports 区别

经过上面的例子,通过exports和module.exports对外公开的方法都可以访问!那既然两种都能达到效果,但总得有点区别的吧~~~用个例子看看吧!

跟我学Nodejs(三)--- Node.js模块

var counter  = 0;     
exports.printNextCount = function (){    
    counter += 2;
    console.log(counter);
}
var isEq = (exports === module.exports);
console.log(isEq);
2_modules_diff_exports.js 文件源码

下面再新建个2_modules_diff_exports_load.js文件调用一下

跟我学Nodejs(三)--- Node.js模块

var Counter = require('./2_modules_diff_exports');
Counter.printNextCount();

    调用后,执行结果如上图

    我在2_modules_diff_exports_load.js文件中输出了isEq的值  ( var isEq = (exports === module.exports); ),返回的true

    PS:注意是三个等号,如果不清楚自已查查资料吧!

不用急着下结论,把这两个JS文件分别改成module.exports对应的代码

//修改后的2_modules_diff_exports.js源码如下
var counter  = 0;     
module.exports = function(){    
    counter += 10;
    this.printNextCount = function()
    {
        console.log(counter);    
    }
}
var isEq = (exports === module.exports);
console.log(isEq);
//修改后的2_modules_diff_exports_load.js文件源码如下
var Counter = require('./2_modules_diff_exports');
var counterObj = new Counter();
counterObj.printNextCount();

跟我学Nodejs(三)--- Node.js模块

    调用后,执行结果如上图

    我在2_modules_diff_exports_load.js文件中输出了isEq的值  ( var isEq = (exports === module.exports); ),返回的false,这与用先前得到的结果不一致!

    PS:不要用Counter.printNextCount();去访问,你只会得到一个错误的提示

    API提供了解释

    http://nodejs.org/api/modules.html

    Note that exports is a reference to module.exports making it suitable for augmentation only. If you are exporting a single item such as a constructor you will want to use module.exports directly instead
    exports仅仅是module.exports的一个地址引用。nodejs只会导出module.exports的指向,如果exports指向变了,那就仅仅是exports不在指向module.exports,于是不会再被导出

    参考其它理解:

    http://www.hacksparrow.com/node-js-exports-vs-module-exports.html

    http://zihua.li/2012/03/use-module-exports-or-exports-in-node/

    module.exports才是真正的接口,exports只不过是它的一个辅助工具。 最终返回给调用的是module.exports而不是exports。
    所有的exports收集到的属性和方法,都赋值给了Module.exports。当然,这有个前提,就是module.exports本身不具备任何属性和方法。
    如果,module.exports已经具备一些属性和方法,那么exports收集来的信息将被忽略。

exports和module.exports 覆盖

上面也也基本明白了exports和module.exports的关系和区别,但如果同时针对printNextCount()方法存在exports和module.exports,结果如何?

跟我学Nodejs(三)--- Node.js模块

调用结果

跟我学Nodejs(三)--- Node.js模块

    从结果可以看出,并没有报错,表示可以这么定义,但最终module.exports覆盖了exports

    虽然结果不会报错,如果这么用开发中难免会有一些问题存在,所以

    1.最好别分别定义module.exports和exports

    2.NodeJs开发者建议导出对象用module.exports,导出多个方法和变量用exports

其它...

 

API中还提供了其它的方法,就不细讲了,在上面例子的基础上自已动手一输出就知道了

module.id

返回string类型的模块标识,一般为完全解析后的文件名

module.filename

返回一个string类型的完全解析后文件名

module.loaded

返回一个bool类型,表示是否加载完成

module.parent

返回引用该模块的模块

module.children

返回该模块引用的所有模块对象的数组

NodeJs 相关文章推荐
NodeJS的url截取模块url-extract的使用实例
Nov 18 NodeJs
nodejs实现黑名单中间件设计
Jun 17 NodeJs
Nodejs中读取中文文件编码问题、发送邮件和定时任务实例
Jan 01 NodeJs
用NodeJS实现批量查询地理位置的经纬度接口
Aug 16 NodeJs
nodejs爬虫遇到的乱码问题汇总
Apr 07 NodeJs
详解nodeJS之路径PATH模块
May 31 NodeJs
详解nodejs模板引擎制作
Jun 14 NodeJs
基于nodejs的雪碧图制作工具的示例代码
Nov 05 NodeJs
Nodejs中怎么实现函数的串行执行
Mar 02 NodeJs
nodejs实现获取本地文件夹下图片信息功能示例
Jun 22 NodeJs
nodejs使用Sequelize框架操作数据库的实现
Oct 21 NodeJs
windows如何把已安装的nodejs高版本降级为低版本(图文教程)
Dec 14 NodeJs
跟我学Nodejs(二)--- Node.js事件模块
May 21 #NodeJs
跟我学Nodejs(一)--- Node.js简介及安装开发环境
May 20 #NodeJs
Nodejs使用mysql模块之获得更新和删除影响的行数的方法
Mar 18 #NodeJs
用nodejs实现PHP的print_r函数代码
Mar 14 #NodeJs
nodejs读取memcache示例分享
Jan 02 #NodeJs
利用NodeJS和PhantomJS抓取网站页面信息以及网站截图
Nov 18 #NodeJs
NodeJS的url截取模块url-extract的使用实例
Nov 18 #NodeJs
You might like
在windows平台上构建自己的PHP实现方法(仅适用于php5.2)
2013/07/05 PHP
使用prototype.js 的时候应该特别注意的几个问题.
2007/04/12 Javascript
基于JQuery的Pager分页器实现代码
2010/07/17 Javascript
纯javascript实现简单下拉刷新功能
2015/03/13 Javascript
JavaScript判断对象是否为数组
2015/12/22 Javascript
JavaScript与java语言有什么不同
2016/09/22 Javascript
基于JS实现横线提示输入验证码随验证码输入消失(js验证码的实现)
2016/10/27 Javascript
详解使用Vue.Js结合Jquery Ajax加载数据的两种方式
2017/01/10 Javascript
Vue.js事件处理器与表单控件绑定详解
2017/03/20 Javascript
JS中精巧的自动柯里化实现方法
2017/12/12 Javascript
js中bool值的转换及“&amp;&amp;”、“||”、 “!!”详解
2017/12/21 Javascript
JS的函数调用栈stack size的计算方法
2018/06/24 Javascript
Vue用mixin合并重复代码的实现
2020/11/27 Vue.js
Vue页面渲染中key的应用实例教程
2021/01/12 Vue.js
详解10个可以快速用Python进行数据分析的小技巧
2019/06/24 Python
Python中的几种矩阵乘法(小结)
2019/07/10 Python
使用Python构造hive insert语句说明
2020/06/06 Python
python爬取youtube视频的示例代码
2021/03/03 Python
Html5中localStorage存储JSON数据并读取JSON数据的实现方法
2017/02/13 HTML / CSS
美国嘻哈首饰购物网站:Hip Hop Bling
2016/12/30 全球购物
迷你唐卡软皮鞋:Minnetonka Moccasin
2018/05/01 全球购物
MIRTA官网:手工包,100%意大利制造
2020/02/11 全球购物
环境工程专业个人求职信
2013/12/05 职场文书
八年级美术教学反思
2014/02/02 职场文书
党风廉设责任书
2014/04/16 职场文书
经济贸易系毕业生求职信
2014/05/31 职场文书
2014离婚协议书范文
2014/09/10 职场文书
四风问题个人剖析材料
2014/10/07 职场文书
2014年学习部工作总结
2014/11/12 职场文书
普宁寺导游词
2015/02/04 职场文书
企业党员岗位承诺书
2015/04/27 职场文书
2015年幼儿园中班下学期工作总结
2015/05/22 职场文书
请学会珍惜眼前,因为人生没有下辈子!
2019/11/12 职场文书
如何用python绘制雷达图
2021/04/24 Python
Python集合set()使用的方法详解
2022/03/18 Python
什么是clearfix (一文搞清楚css清除浮动clearfix)
2023/05/21 HTML / CSS