Osheep

时光不回头,当下最重要。

Nodejs学习笔记(三)--- 模块

简介及资料

通过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基于CommonJS,所以直接看的Node的官方文档解释

Module.exports

The module.exports object is created by the Module system. Sometimes this is not acceptable; many want their module to be an instance of some class. To do this, assign the desired export object to module.exports. Note that assigning the desired object to exports will simply rebind the local exports variable, which is probably not what you want to do.
译文:module.exports对象是由模块系统创建的。 有时这是难以接受的;许多人希望他们的模块成为某个类的实例。 为了实现这个,需要将期望导出的对象赋值给module.exports。 注意,将期望的对象赋值给exports会简单地重新绑定到本地exports变量上,这可能不是你想要的。

exports

The exports variable is available within a module’s file-level scope, and is assigned the value of module.exports before the module is evaluated. It allows a shortcut, so that module.exports.f = … can be written more succinctly as exports.f = …. However, be aware that like any variable, if a new value is assigned to exports, it is no longer bound to module.exports:
译文:exports变量是在模块的文件级别作用域内有效的,它在模块被执行前被赋于 module.exports 的值。它有一个快捷方式,以便 module.exports.f = … 可以被更简洁地写成exports.f = …。 注意,就像任何变量,如果一个新的值被赋值给exports,它就不再绑定到module.exports(其实是exports.属性会自动挂载到没有命名冲突的module.exports.属性)

module.exports是真正的接口,exports只不过是它的辅助工具。推荐使用exports导出,除非你打算从原来的“实例化对象”改变成一个类型。如果你想你的模块是一个特定的类型就用Module.exports。如果你想的模块是一个典型的“实例化对象”就用exports。

require

从require导入方式去理解,关键有两个变量(全局变量module.exports,局部变量exports)、一个返回值(module.exports)

Demo

主要探索 Module.exports 和 exports 区别

1.js
console.log(exports); // {}  
console.log(module.exports);  // {}  
console.log(exports === module.exports);    // true  
console.log(exports == module.exports);        // true  
/**
 Module {
  id: '.',
  exports: {},
  parent: null,
  filename: '/1.js',
  loaded: false,
  children: [],
  paths:
   [ 
     '/node_modules' ] 
 }
 */
console.log(module);
《Nodejs学习笔记(三)--- 模块》

image.png

1.每个js文件一创建,都有一个var exports = module.exports = {};,使exports和module.exports都指向一个空对象。
2.module是全局内置对象,exports是被var创建的局部对象。
3.module.exports和exports所指向的内存地址相同

2.js、3.js
// 2.js
exports.id = 'exports的id';  
exports.id2 = 'exports的id2';  
exports.func = function(){  
    console.log('exports的函数');
};
exports.func2 = function() {  
    console.log('exports的函数2');
};
module.exports = {  
    id: 'module.exports的id',
    func:function(){
        console.log('module.exports的函数');
    }

};
// 3.js
var a = require('./2.js');  
// 当属性和函数在module.exports都有定义时:
console.log(a.id);  // module.exports的id  
console.log("~~~~~~~~~~~~~~~~~~"); 
console.log(a.func()); // module.exports的函数
console.log("~~~~~~~~~~~~~~~~~~"); 
// 当属性在module.exports没有定义,函数在module.exports有定义
console.log(a.id2);  // undefined  
console.log("~~~~~~~~~~~~~~~~~~"); 
console.log(a.func());  // module.exports的函数
console.log("~~~~~~~~~~~~~~~~~~"); 

// 当函数在module.exports没有定义,属性在module.exports有定义
console.log(a.id);        // module.exports的id  
console.log("~~~~~~~~~~~~~~~~~~"); 
console.log(a.func2());    // 报错了 TypeError: a.func2 is not a function 
console.log("~~~~~~~~~~~~~~~~~~");
《Nodejs学习笔记(三)--- 模块》

image.png

1.module.exports像是exports的大哥,当module.exports以{}整体导出时会覆盖exports的属性和方法,
2.注意,若只是将属性/方法挂载在module.exports./exports.上时,exports.id=1和module.exports.id=100,module.exports.id=function(){}和exports.id=function(){},最后id的值取决于exports.id和module.exports.id的顺序,谁在后,就是最后的值

3.若exports和module.exports同时赋值时,exports所使用的属性和方法必须出现在module.exports,若属性没有在module.exports中定义的话,出现undefined,若方法没有在module.exports中定义,会抛出TypeError错误。
4.js、5.js

module.exports的对象、prototype、构造函数使用

// 4.js
var a = require('./5.js');  
// 若传的是类,new一个对象
var person = new a('Kylin',20);  
console.log(person.speak()); // my name is Kylin ,my age is 20

// 若不需要在构造函数时初始化参数,直接调用方法/属性
// a.speak();  // my name is kylin ,my age is 20
// 5.js
// Person类
function Person(name,age){  
    this.name = name;
    this.age = age;
}
// 为类添加方法
Person.prototype.speak = function(){  
    console.log('my name is '+this.name+' ,my age is '+this.age);
};

// 返回类
module.exports = Person;

// 若构造函数没有传入参数(name,age),直接传入对象
// module.exports = new Person('kylin',20);
《Nodejs学习笔记(三)--- 模块》

image.png

如果只是单一属性或方法的话,就使用exports.属性/方法。要是导出多个属性或方法或使用对象构造方法,结合prototype等,就建议使用module.exports = {}。
旨在学习记录,其中描述可能不是很准确,若是存在问题,还望大神指正建议。

点赞