跟我学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服务器(8):非阻塞是如何实现的
Dec 18 NodeJs
Nodejs Stream 数据流使用手册
Apr 17 NodeJs
图片上传之FileAPI与NodeJs
Jan 24 NodeJs
Ajax异步文件上传与NodeJS express服务端处理
Apr 01 NodeJs
NodeJS基础API搭建服务器详细过程记录
Apr 01 NodeJs
详解nodejs微信jssdk后端接口
May 25 NodeJs
Nodejs之http的表单提交
Jul 07 NodeJs
nodejs接入阿里大鱼短信验证码的方法
Jul 10 NodeJs
nodejs 使用 js 模块的方法实例详解
Dec 04 NodeJs
详解利用nodejs对本地json文件进行增删改查
Sep 20 NodeJs
nodejs实现UDP组播示例方法
Nov 04 NodeJs
nodejs nedb 封装库与使用方法示例
Feb 06 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
IIS下PHP连接数据库提示mysql undefined function mysql_connect()
2010/06/04 PHP
php错误提示failed to open stream: HTTP request failed!的完美解决方法
2011/06/06 PHP
php笔记之:文章中图片处理的使用
2013/04/26 PHP
yii实现图片上传及缩略图生成的方法
2014/12/04 PHP
php递归遍历多维数组的方法
2015/04/18 PHP
PHP中mysqli_get_server_version()的实例用法
2020/02/03 PHP
用js实现控制内容的向上向下滚动效果
2007/06/26 Javascript
JavaScript让IE浏览器event对象符合W3C DOM标准
2009/11/24 Javascript
基于Jquery+Ajax+Json的高效分页实现代码
2011/10/29 Javascript
Jquery 数据选择插件Pickerbox使用介绍
2012/08/24 Javascript
JS实现根据出生年月计算年龄
2014/01/10 Javascript
在浏览器中实现图片粘贴的jQuery插件-- pasteimg使用指南
2014/12/29 Javascript
原生javascript实现图片按钮切换
2015/01/12 Javascript
JavaScript生成SQL查询表单的方法
2015/08/13 Javascript
Google 地图事件实例讲解
2016/08/06 Javascript
Bootstrap3 datetimepicker控件使用实例
2016/12/13 Javascript
javascript canvas检测小球碰撞
2020/04/17 Javascript
JavaScript中的执行环境和作用域链
2020/09/04 Javascript
[04:26]2014DOTA2西雅图国际邀请赛 总决赛TOPPLAY
2014/07/22 DOTA
Python闭包实现计数器的方法
2015/05/05 Python
python调用百度语音识别api
2018/08/30 Python
解决pycharm安装后代码区不能编辑的问题
2018/10/28 Python
python感知机实现代码
2019/01/18 Python
python中通过selenium简单操作及元素定位知识点总结
2019/09/10 Python
python config文件的读写操作示例
2019/09/27 Python
python中np是做什么的
2020/07/21 Python
Python使用xpath实现图片爬取
2020/09/16 Python
基于css3 animate制作绚丽的动画效果
2015/11/24 HTML / CSS
CSS Houdini实现动态波浪纹效果
2019/07/30 HTML / CSS
西班牙家用电器和电子产品购物网站:Mi Electro
2019/02/25 全球购物
写出SQL四条最基本的数据操作语句(DML)
2012/12/12 面试题
致百米运动员广播稿5篇
2014/10/13 职场文书
2014年保安个人工作总结
2014/11/13 职场文书
中班下学期幼儿评语
2014/12/30 职场文书
环保主题班会教案
2015/08/13 职场文书
Java各种比较对象的方式的对比总结
2021/06/20 Java/Android