Node.js的模块系统

  编写稍大一点的程序时一般都会将代码模块化。Node.js提供了一个简单的模块系统。模块既可能是一个文件,也可能是包含一个或多个文件的目录。

      模块的创建 

  •   如果模块是个文件,一般将代码合理拆分到不同的JS文件中,每一个文件就是一个模块,而文件路径就是模块名。
  •   如果模块是个目录, Node通常会在这个目录下找一个叫index.js的文件作为模块的入口(这个默认设置可以重写)。

 

       模块的导出 

  Node模块允许你从被引入文件中选择要暴露给程序的函数和变量。如果模块返回的函数或变量不止一个,那它可以通过设定exports对象的属性来指明它们。但如果模块只返回一个函数或变量,则可以设定module.exports属性。

      引用的函数或变量为多个的情况:

      

      引用一个函数对象的情况,但下面是个错误的例子:

  

        exports = Currency 应改为 module.exports = Currency ;

        这是因为最终在程序里导出的是module.exports。 exports只是对module.exports的一个全局 引 用 , 最 初 被 定 义 为 一 个 可 以 添 加 属 性 的 空 对 象 。 所 以 exports.myFunc 只 是module.exports.myFunc的简写。所以,如果把exports设定为别的,就打破了module.exportsexports之间的引用关系。

 

 

       

       模块路径解析规则

  require函数支持斜杠(/)或盘符(C:)开头的绝对路径,也支持./开头的相对路径。但这两种路径在模块之间建立了强耦合关系,一旦某个模块文件的存放位置需要变更,使用该模块的其它模块的代码也需要跟着调整,变得牵一发动全身。因此,require函数支持第三种形式的路径,写法类似于foo/bar,并依次按照以下规则解析路径,直到找到模块位置。

  1.内置模块

如果传递给require函数的是NodeJS内置模块名称,不做路径解析,直接返回内部模块的导出对象,例如require('fs')。

  

  2. node_modules目录

NodeJS定义了一个特殊的node_modules目录用于存放模块。例如某个模块的绝对路径是/home/user/hello.js,在该模块中使用require('foo/bar')方式加载模块时,则NodeJS依次尝试使用以下路径。

/home/user/node_modules/foo/bar
/home/node_modules/foo/bar
/node_modules/foo/bar

     

  3.NODE_PATH环境变量

与PATH环境变量类似,NodeJS允许通过NODE_PATH环境变量来指定额外的模块搜索路径。NODE_PATH环境变量中包含一到多个目录路径,路径之间在Linux下使用:分隔,在Windows下使用;分隔。例如定义了以下NODE_PATH环境变量:

NODE_PATH=/home/user/lib:/home/lib
当使用require('foo/bar')的方式加载模块时,则NodeJS依次尝试以下路径。

/home/user/lib/foo/bar
/home/lib/foo/bar

 

  模块初始化
一个模块中的JS代码仅在模块第一次被使用时执行一次,并在执行过程中初始化模块的导出对象。之后,缓存起来的导出对象被重复利用。

  主模块
通过命令行参数传递给NodeJS以启动程序的模块被称为主模块。主模块负责调度组成整个程序的其它模块完成工作。例如通过以下命令启动程序时,main.js就是主模块。

$ node main.js

 

      总结

  Node的模块系统基于CommonJS模块规范(www.commonjs.org/specs/modules/1.0/),你可以通过组装exportsmodule.exports轻松重用模块。当你在程序代码中require模块时,模块
的查找系统会在几个位置上查找它们,很灵活。除了可以把模块放到程序的源码树中,还可以用node_modules文件夹在几个程序间分享模块代码。

  在模块被引用时,在模块内部的package.json文件可以用来指明先计算模块源码树中的哪个文件。

posted @ 2018-08-28 12:59  杭州胡欣  阅读(357)  评论(0编辑  收藏  举报