Node.js design pattern : module

Node.js design pattern一书中对Node的Module模块机制这一块,我以为讲的挺透彻和易懂,这里根据本身理解作下总结。本文转发自本人githubjavascript

loadModule

自定义一个简单的模块加载方法loadModule,基本思路跟nodejs一致,将加载的模块内容包裹在一个函数里面实现变量的隔离,保证模块内的变量都是私有的。java

function loadModule(filename, module, require) {
		const wrappedSrc = `(function(module, exports, require) { ${fs.readFileSync(filename, 'utf8')} })(module, module.exports, require);`;
	
		eval(wrappedSrc);
	}
复制代码

这个例子经过evalwrappedSrc进行计算,即经过eval函数处理该字符串脚本。由于这里要把(function(module, exports, require) { 这串东西和 fs.readFileSync(filename, 'utf8')加载的模块内容合并在一块儿做为新的整合代码再运行,因此必须借助eval函数。node

做为对比,在nodejs源码中, wrap是这样实现的git

Module.wrap = function(script) {
  		return Module.wrapper[0] + script + Module.wrapper[1];
	};

	Module.wrapper = [
	  '(function (exports, require, module, __filename, __dirname) { ',
	  '\n});'
	];
复制代码

最终对该warpper的解析实如今Module.prototype._compile方法中,其中用到了vm模块对wrapper脚本进行处理。vm实现的功能与eval函数相似,但比eval函数更强大。github

模块引用require()

对模块的引用咱们经过require(..)函数进行引用,如var http = require('http'),该方法简单实现以下:缓存

const require = (moduleName) => {
		console.log(`Require invoked for module: ${moduleName}`);
		const id = require.resolve(moduleName);
		if (require.cache[id]) { return require.cache[id].exports; }
	
		// 1.module metadata
		const module = {
			exports: {},
			id: id
		}
	
		// 2.require.cache
		require.cache[id] = module;
	
		// 3.load the module
		loadModule(id, module, require);
	
		// 4.return exported variables
		return module.exports;
	}
	
	require.cache = {};
	require.resolve = (moduleName) => {
		/* resolve a full module id from the moduleName */
	}
复制代码
  1. 定义了一个module对象用来保存经过loadModule方法中加载模块中暴露出的接口。
  2. 将第一次加载的模块保存在内部缓存中。即第二次调用require(..)时不会再调用loadModule方法,直接从cache中返回。
  3. 经过loadModule方法经过模块路径加载模块内容。
  4. 返回模块中暴露的接口以供调用。

能够经过下图更加直观的了解其中的关系。app

nodejs-module

module.exports vs exports函数

经过上述代码和图示可知,咱们写的模块中的exports实际上是对module.exports的引用。 所以咱们能够经过exports添加属性来给module.exports引用的对象添加属性。ui

exports.hello = () => { console.log('Hello') };
复制代码

但若是给exports从新赋值,则会失去module.exports的引用spa

exports = () => { console.log('Hello') };
复制代码

此时exports !== module.exports,意味着经过exports暴露的接口是无效的,没有添加到module metadata中的exports中。

相关文章
相关标签/搜索