细数js模块机制内涵

说个事, 亲,你知道当你运行js的时候，发生错误的时候下面的信息代表的是什么吗？like

 SyntaxError: Unexpected token .     at exports.runInThisContext (vm.js:53:16)     at Module._compile (module.js:414:25)     at Object.Module._extensions..js (module.js:442:10)     at Module.load (module.js:356:32)     at Function.Module._load (module.js:313:12)     at Function.Module.runMain (module.js:467:10)     at startup (node.js:136:18) 

母鸡吧,实际上，这个nodeJS中Module模块的内容。 说道模块，这就牵扯到整个js现存的那些优秀的模块机制呢。首当其冲的要数,AMD,然后是NodeJS的加载模块.下面，我们来了解一下内部的机制,确定上面的错误，到底代表什么.

AMD

define([arr], function(para){//...});

该函数接受两个参数

• 第一个参数: 接受的是数组类型, 里面定义的参数是相关的js文件的路径或者js文件的alias. 路径或者alias 代表着一个引入的js模块. 比如:

  ['/arr/script.js','/js/demo.js','jquery']

不管是定义路径还是定义alias, 最终, 都会被插件解析为 实际的js代码. 这个具体就涉及路径的解析了， 我们下文在说一下

• 第二个参数: 接受的是函数. 并且函数可以带入参数. 参数的位置, 和前面数组引入的模块位置一致. 然后我们就可以直接使用模块内容。

  define(['/arr/isArray.js','jquery'],function(isArray,$){//...})

我们接着就可以直接使用定义好的模块alias就可以了。

NodeJS 的模块化

由于AMD 仅仅提出了一个define函数用来异步加载脚本. 但是服务端的场景，这显然就有点鸡肋了. 所以, nodeJS 基本上参考了 CommonJS Modules/1.1 proposal . 他为了更精确的表达 server 端模块化的机制. 定义了3个全局的变量 exports , require , module . 需要注意的是... 其实exports 并不是单一的一块，他其实是.

var exports = module.exports = {};

即, 其实nodeJS模块交互只有require 和 module 在进行。 我们来具体看一下 , nodeJS 端 进行模块化的机制吧.首先，我们得明白什么叫做模块？

什么是模块

var sayHello = function(){     return 'hello'; } var move = function(){     return 'Now, I am moving'; }

上面两个函数我们就可以说，是模块.Ok~ 现在我们已经写了一个简单的模块了, 那接下来该怎么导出这个模块呢?

导出模块

这里我们就需要使用exports方法进行导出即可.

//dist.js // var exports = module.exports = {}; exports.sayHello = function(){     return 'hello'; } exports.move = function(){     return 'Now, I am moving'; }

这里，我们需要注意一下:exports = module.exports.由于是对象，我们还可以利用对象本来的特征, 通过字面量形式书写

//dist.js //下面的module.exports 不能使用exports代替  module.exports = {     sayHello : function(){     return 'hello';     }     move : function(){     return 'Now, I am moving';     } } //如果你写成如下 exports = {//...} //那么你的exports关键字已经和module.exports断开联系了.

但是, 现实情况是， 不推荐这样直接 将 exports 用字面量表达. 因为这样造成将一开始写入的内容给覆盖掉.

exports.getName = function(){     return "jimmy"; }; exports.flag = "It will be overloaded"; //上面所有的都将会被覆盖掉 module.exports = {  //这里只能使用   getName : function(){     return "sam"   },   sayName :function(){     return "Michael"   } }

所以，推荐的两点:

• 如果一开始使用 exports.xxx 导出的话, 后面就不要使用 exports = {} 导出.

• 可以在最后部分直接使用 exports = {} 进行导出， 这样的, 能够让你的代码更清晰.

OK, 基本模块样式我们已经写完了. 现在就轮到如何引用模块了.

引用模块

最后上面3个关键字，就只剩下了 require . 那require的工作机制是怎样的呢？

var require = function(path) {    // 通过路径查找文件, 并解析    return module.exports; };

所以, 现在模块机制的难点不在是 模块是怎么 引用的, 而变成了 路径解析的问题， 我们可以放到后面再进行讨论。 我们现在可以梳理一下, 模块内容传递的 Process.

• app.js => module.exports => require => 自定义变量

所以，一个模块 就经历了以上的流程传递到你最后引用的变量里面了。 我们来看一下整体的demo.

//dist.js module.exports = {       sayHello : function(){     return 'hello';     }     move : function(){     return 'Now, I am moving';     } } //main.js var action = require('../dist.js'); console.log(action.sayHello()); //hello console.log(action.move()); //Now, I am moving

通过模块机制, 我们可以很容易的了解到. require其实就是一个包装函数. 在函数体内部进行 一些列的路径转换. 比如, 路径解析, 包的缓存,模块的加载,内置模块等等。我们稍微肤浅一点,看一下. require是怎样进行路径加载的吧.

require 路径解析规则

这里,我们依照官方的说明.前提是:在Y路径下,使用require(X) 引用. 会按一下步骤进行解析

1. 如果X是内置的模块,比如http,net等. 直接返回. over

2. 如果X带上'/'或者'./'或者'../'.

   • 会根据X所在的父目录,确定X所在的绝对位置.

   • 先假设X是文件,然后按照顺序依次查找下列文件

     • x

     • x.js

     • x.json

     • x.node如果找到则返回

   • 如果X是目录,则依次查找下列文件:

     • X/package.json(main 字段)

     • X/index.js

     • X/index.json

     • X/index.node如果找到则返回.

3. 如果X不是以'/'或'./'或'../'开头. 则会根据X所在的父目录,对node_modules进行回朔遍历. 接着,通过上述确定X为文件或者目录的方式,进行查找.

4. 如果上述的流程都没有找到则会抛出错误(Not Found)

这里,我们具体来看一下 node_modules的查找. 假设在路径/usr/app/shop 下运行 require('bar'); 之后, 程序遍历的结果是.

• 首先, 假设bar是文件,查找路径为

  • /usr/app/shop/node_modules/bar

  • /usr/app/shop/node_modules/bar.js

  • /usr/app/shop/node_modules/bar.json

  • /usr/app/shop/node_modules/bar.node

• 如果,在该目录下没有找到,则会进行回朔(../).则遍历路径为:

  • /usr/app/shop/node_modules

  • /usr/app/node_modules

  • /usr/node_modules

  • /node_modules

• 如果假设为目录. 类似,查找为:

  • bar/package.json(main)

  • bar/index.js

  • bar/index.json

  • bar/index.node

• 同样,也有路径回朔(../). 如上,这里就不赘述了

require() 运行的内部机制

(function (exports, require, module, __filename, __dirname) {   // 模块源码   return exports; });

实际上,module其实就是Modules的一个实例,在源码中定义的Modules函数实际内容，并不复杂:

function Module(id, parent) {   this.id = id;   this.exports = {};   this.parent = parent;   if (parent && parent.children) {     parent.children.push(this);   }    this.filename = null;   this.loaded = false;   this.children = []; } module.exports = Module;

console.log('module.id: ', module.id); console.log('module.exports: ', module.exports); console.log('module.parent: ', module.parent); console.log('module.filename: ', module.filename); console.log('module.loaded: ', module.loaded); console.log('module.children: ', module.children); console.log('module.paths: ', module.paths);

运行: ndoe app.js
结果,为:

module.id:  . module.exports:  {} module.parent:  null module.filename:  /Users/jimmy_thr/Documents/code/shopping/app/sam.js module.loaded:  false module.children:  [] module.paths:  [ //内容过多忽略 ]

有兴趣的童鞋,可以自己运行试一试.那每个属性对应的是什么内容呢?

可以看出,通过run之后, 有3个global对象,分别为,require,module,exports. 那实际上,他们3者的关系是什么呢？

我们来看一下源码里面是怎么做的吧.

Module内部细节

这是require 方法的具体细节:

Module.prototype.require = function(path) {   return Module._load(path, this); };

实际上, require 只是一层皮, 里面套的是Module的_load方法.代码内有很多debug和alert, 去掉检测的内容,我们来看一下内部机理.

 Module._load = function(request, parent, isMain) {    //  计算绝对路径   var filename = Module._resolveFilename(request, parent);    //  第一步：如果有缓存，取出缓存   var cachedModule = Module._cache[filename];   if (cachedModule) {     return cachedModule.exports;    // 第二步：是否为内置模块   if (NativeModule.exists(filename)) {     return NativeModule.require(filename);   }    // 第3.1步：加载模块,生成模块实例，存入缓存   var module = new Module(filename, parent);   Module._cache[filename] = module;    // 第3.2步: 载入模块内容   try {     module.load(filename);     hadException = false;   } finally {     if (hadException) {       delete Module._cache[filename];     }   }    // 第四步：输出模块的exports属性   return module.exports; };

这下大概清楚了,实际上, 在路径解析之前，其实Module 还会对内置模块进行其他的检测.实际顺序为:

• 是否已经缓存

• 是否为内置模块

• 加载模块

  • 生成模块实例,存入缓存

  • 路径解析

• 最终返回module.exports

Module里面自定义了很多路径的处理和缓存的处理。 我们这里, 只关注一下. module.load的内容. 源码如下

Module.prototype.load = function(filename) {   this.filename = filename;   this.paths = Module._nodeModulePaths(path.dirname(filename));    var extension = path.extname(filename) || '.js';   if (!Module._extensions[extension]) extension = '.js';   Module._extensions[extension](this, filename);   this.loaded = true; };

这里很简单,用来确定文件后缀的加载:

• X

• X.js

• X.json

• X.node

首先,在理解内部机制之前,我们需要了解一下关于path 模块。 该模块通常使用来处理文件路径的.

• path.basename(p[, ext])

返回基本的文件名. 如果ext有参数,则表示不带指定尾缀返回. 比如: usr/home/app.js => app.js . 如果指定ext为 .js 则返回 app . 更好的理解方式为: p-ext

• path.dirname(p)返回目录名. usr/home/app.js => usr/home

• path.extname(p)

  返回文件名的后缀。通常是最后一个'.'到字符串最后. index.html => .html 。如果没有'.'则会返回一个空字符. index => ''

• path.format(pathObject)

  将路径对象转化为字符串路径. 即. path.format({//...}) . Object可以带的属性有:

  • root

  • dir

  • base

  • ext

  • name一个简单的demo:

path.format({     root : "/",     dir : "/home/user/dir", //后面不用加`/`系统会自动补充     base : "file.txt",     name : "file",     ext : ".txt" }); // returns '/home/user/dir/file.txt'

实际上, 我们只需要使用一部分即可。俺，常用的组合为: dir + base. 或者 dir+name+ext

• path.isAbsolute(path)用来检查路径是否为绝对路径。绝对路径很好理解, 1. 看你的路径是否在根目录上. 2. 看你的路径的开头是否是 / 。

/usr/path => true, shop/app.js =>false

• path.join(path1[, ...])使用 / 来连接多个字符,并对 .. 或者 . 进行路径转化. 这是一个比较重要的方法. 常常用在路径处理.

path.join('/foo', 'bar', 'baz/sam', 'quux', '..'); 返回为: '/foo/bar/baz/sam'

• path.normalize(p)对路径字符串解释, 会处理 .. 和 . 。

path.normalize('/usr/home/../sam'); 返回: '/usr/sam'

• path.parse(pathString)

  该方法和path.format相反,是将路径字符串转化为路径对象

  path.parse('/home/user/dir/file.txt') // returns // { //    root : "/", //    dir : "/home/user/dir", //    base : "file.txt", //    ext : ".txt", //    name : "file" // }

• path.resolve([from ...], to)组合所有的路径，找出绝对路径. 如果路径中不存在以 / 开头,或者根目录的话,则以当前js文件所在的目录为起始参考路径. NodeJS官方给出一种更好理解的方式:

path.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile') // cd foo/bar // cd /tmp/file/ // cd .. // cd a/../subfile 最后返回: /tmp/subfile

• path.relative(fromPath, toPath)计算出,相对于fromPath 到 toPath的相对路径。两个参数需要是绝对路径. 在MAC下面开头需要为 / . 如果不是, 则会默认以执行的js文件所在目录进行转化.

path.relative('/usr/home/sam','/usr/app') 返回: ../../app

总结一下:

回到load方法。 该方法主要就是对尾缀进行不同的处理策略:

var extension = path.extname(filename) || '.js';   if (!Module._extensions[extension]) extension = '.js';   Module._extensions[extension](this, filename);   this.loaded = true;

再反观,源码对不同后缀的处理

Module._extensions['.js'] = function(module, filename) {...} Module._extensions['.json'] = function(module, filename) {...} Module._extensions['.node'] = function(module, filename) {...}

找到文件之后，再通过vm模块，进行编译处理.最后, 在_compile函数里, 对scope和sandbox进行处理后，争取运行文件.

Module.prototype._compile = function(content, filename) {   var self = this;   var args = [self.exports, require, self, filename, dirname];   return compiledWrapper.apply(self.exports, args); };

最后就编译为,我们前文所述的那样:

(function (exports, require, module, __filename, __dirname) {   // 模块源码   return exports; });

通过上文,我们也能够很好地理解。 出错的时候，下面的信息到底意味着什么了.

SyntaxError: Unexpected token .     at exports.runInThisContext (vm.js:53:16)     at Module._compile (module.js:414:25)     at Object.Module._extensions..js (module.js:442:10)     at Module.load (module.js:356:32)     at Function.Module._load (module.js:313:12)     at Function.Module.runMain (module.js:467:10)     at startup (node.js:136:18)