Node.js 教程 04 - 模块系统

时间:2023-12-25 20:35:43

前言:

  Node.js的模块系统类似于C/C++的文件引用,可以声明对象,也可以定义类 创建对象。

  大家这么理解,就简单了。


定义:

  为了让Node.js的文件可以相互调用,Node.js提供了一个简单的模块系统。

  模块是Node.js应用程序的基本组成部分,文件和模块是一一对应的。

  换言之,一个Node.js文件就是一个模块,这个文件可能是Javascript代码、JSON或者编译过的C/C++扩展。


实例一:

  这个实例演示的是,在hello.js中创建一个方法,然后在主程序main.js中调用这个方法。

  在Node.js中,创建一个模块非常简单,大家跟着做一下就OK了。步骤如下:

  步骤1:在E:\NodejsDemo文件夹中,创建一个“hello.js”文件,代码如下:

 exports.welcome = function(){
     console.log("Welcome to My Blog!");
 }

  上述代码中,我们使用exports对象,把welcome作为当前hello.js模块的访问接口。

  这样,在其他的模块(js文件)中,使用require命令,引入当前js文件,即可直接访问welcome了。

  步骤2:同目录下,我们创建一个“main.js”文件,作为要执行的主程序,引入hello.js文件,执行welcome方法,代码如下:

 var Hello = require('./hello'); // 引入hello.js模块(文件)
 Hello.welcome();  // 访问hello.js文件中的welcome函数

  上述代码中,我们使用require函数,引入hello.js文件。

  然后,我们把引入的hello.js模块,存入了一个本地变量“Hello”中。

  最后,我们使用本地变量“Hello”调用welcome函数,也就是访问了hello.js模块中的welcome对外接口函数。

  注意:这里引入hello.js模块的时候,我们并没有加后缀,“./”表示当前目录,Node.js默认后缀为“.js”。

  步骤3:启动DOS,进入目录,执行“node main.js”运行主程序:

Node.js 教程 04 - 模块系统

  OK,大家发现,我们调用welcome方法之后,执行的是hello.js文件中创建的welcome函数。

  这个例子,大家想我开头所说的理解,其实非常简单。重点是exports和require。

  • hello.js中的声明 -  exports.welcome = function(){...}
  • main.js中的第一句话 - 引入hello.js:var Hello = require('./hello');

  require命令我们在之前“Node.js 教程 02 - 经典的Hello World”已经接触过了。

  Node.js 提供了exports 和 require 两个对象,其中 exports 是模块公开的接口,require 用于从外部获取一个模块的接口,即所获取模块的 exports 对象。

  有没有感觉,这个例子很像Java/.NET中的定义类、声明对象、调用方法?


实例二:

  Js大牛们知道,在Javascript中,我们可以“定义类、实例化对象”。

  那我们如果想把一个对象封装到模块中,应该怎么办呢?

  按照上面的实例一,我们照葫芦画瓢:定义一个person类,引入实例化,并赋值,最后调用函数。

  步骤1:创建一个“person.js”文件,作为要引入的模块文件,代码如下:

 function Person(){
     var name;
     this.setName = function(_name){
         name = _name;
     }

     var url;
     this.setUrl = function(_url){
         url = _url;
     }

     this.sayHello = function(){
         console.log("Welcome to my blog!\n" + url);
         console.log("My name is " + name +". Nice to meet you!");
     }
 }

 module.exports = Person;

  上述代码中,我们创建了一个Person对象,包含两个需赋值参数及一个输出函数。

  重点是最后一句: module.exports = Person;

  模块接口的唯一变化是使用  module.exports = Person  代替了 exports.world = function(){} 。

  在外部引用该模块时,其接口对象就是要输出的 Person 对象本身,而不是原先的 exports。

  步骤2:创建主程序“main.js”,引入person.js模块,实例初始化并调用,代码如下:

 var Person = require('./person'); 

 var person = new Person();
 person.setName("GuYing");
 person.setUrl("http://www.cnblogs.com/LonelyShadow");
 person.sayHello();

  上述代码中,我们第1行先引入“person.js”模块文件,并存入本地的Person对象中。

  第3行,实例化这个Person对象,将实例存入本地的person对象中。

  第4-5行,为这个person对象赋值name和url参数。

  第6行,访问person对象的sayHello()函数,输出结果。

  Ps:到此为止,是不是觉得这个东西跟类和对象太相似了?O(∩_∩)O哈哈~


服务器的模块放在那里?

  也许你已经注意到,我们之前在“Node.js 教程 03 - 创建HTTP服务器”中已经在代码中使用了模块了。像这样:

 var http = require("http");
 ...
 http.createServer(function(){});

  Node.js中自带了一个叫做"http"的模块,我们在我们的代码中请求它并把返回值赋给一个本地变量。

  这把我们的本地变量变成了一个拥有所有 http 模块所提供的公共方法的对象。

  Node.js 的 require方法中的文件查找策略如下:

  由于Node.js中存在4类模块(原生模块和3种文件模块),尽管require方法极其简单,但是内部的加载却是十分复杂的,其加载优先级也各自不同。如下图所示:

Node.js 教程 04 - 模块系统

  从文件模块缓存中加载

    尽管原生模块与文件模块的优先级不同,但是都不会优先于从文件模块的缓存中加载已经存在的模块。

  从原生模块加载

    原生模块的优先级仅次于文件模块缓存的优先级。

    require方法在解析文件名之后,优先检查模块是否在原生模块列表中。

    以http模块为例,尽管在目录 下存在一个http/http.js/http.node/http.json文件,require("http")都不会从这些文件中加载,而是从原生 模块中加载。

    原生模块也有一个缓存区,同样也是优先从缓存区加载。如果缓存区没有被加载过,则调用原生模块的加载方式进行加载和执行。

  从文件加载

    当文件模块缓存中不存在,而且不是原生模块的时候,Node.js会解析require方法传入的参数,并从文件系统中加载实际的文件。

    加载过程中的包装和编译细节在前一节中已经介绍过,这里我们将详细描述查找文件模块的过程,其中,也有一些细节值得知晓。

    require方法接受以下几种参数的传递:

  • http、fs、path等,原生模块。
  • ./mod或../mod,相对路径的文件模块。
  • /pathtomodule/mod,绝对路径的文件模块。
  • mod,非原生模块的文件模块。