【前端】NodeJS：NodeJS模块化

1 NodeJS模块化

1.1 模块化与模块

• 将一个复杂的程序文件依据一定规则（规范）拆分成多个文件的过程称之为模块化。
• 其中拆分出的每个文件就是一个模块 ，模块的内部数据是私有的，不过模块可以暴露内部数据以便其他模块使用。

1.2 模块化项目

编码时是按照模块一个一个编码的， 整个项目就是一个模块化的项目。

1.3 模块化好处

下面是模块化的一些好处：

• 防止命名冲突
• 高复用性
• 高维护性

2 模块暴露数据

2.1 模块初体验

/*
	创建 me.js
*/
//声明函数
function tiemo(){
	console.log('贴膜....');
}
//暴露数据
module.exports = tiemo;

/*
	创建 index.js
*/
//导入模块
const tiemo = require('./me.js');
//调用函数
tiemo();

2.2 暴露数据

模块暴露数据的方式有两种：

• module.exports = value
• exports.name = value
  使用时有几点注意：
• module.exports 可以暴露任意数据。
• 不能使用exports = value的形式暴露数据，模块内部module与exports的隐式关系：exports = module.exports = {}，require 返回的是目标模块中module.exports的值。

3 导入（引入）模块

在模块中使用require传入文件路径即可引入文件。

const test = require('./me.js');

require使用的一些注意事项：

• 对于自己创建的模块，导入时路径建议写相对路径，且不能省略 ./ 和 …/。
• js和json文件导入时可以不用写后缀，c/c++编写的 node 扩展文件也可以不写后缀，但是一般用不到。
• 如果导入其他类型的文件，会以 js 文件进行处理。
• 如果导入的路径是个文件夹，则会首先检测该文件夹下package.json文件中main属性对应的文件，如果存在则导入，反之如果文件不存在会报错。如果main属性不存在，或者package.json不存在，则会尝试导入文件夹下的index.js和index.json，如果还是没找到，就会报错。
• 导入node.js内置模块时，直接require模块的名字即可，无需加 ./ 和 …/。

4 导入模块的基本流程

require导入自定义模块的基本流程：

• 将相对路径转为绝对路径，定位目标文件。
• 缓存检测。
• 读取目标文件代码。
• 包裹为一个函数并执行（自执行函数）。通过arguments.callee.toString()查看自执行函数。
• 缓存模块的值。
• 返回 module.exports 的值。

/*
	伪代码
*/
function require(file){
  	//1. 将相对路径转为绝对路径，定位目标文件
  	let absolutePath = path.resolve(__dirname, file);
  	//2. 缓存检测
  	if(caches[absolutePath]){
    	return caches[absolutePath];
  	}
  	//3. 读取文件的代码
  	let code = fs.readFileSync(absolutePath).toString();
  	//4. 包裹为一个函数 然后执行
  	let module = {};
  	let exports = module.exports = {};
  	(function (exports, require, module, __filename, __dirname) {
    	const test = {
      		name: '尚硅谷'
    	}
    	module.exports = test;
    	//输出
    	console.log(arguments.callee.toString());
  	})(exports, require, module, __filename, __dirname)
  	//5. 缓存结果
  	caches[absolutePath] = module.exports;
  	//6. 返回 module.exports 的值
  	return module.exports;
}

const m = require('./me.js');

5 CommonJS规范

• module.exports、exports以及require这些都是CommonJS模块化规范中的内容。
• 而Node.js是实现了CommonJS模块化规范，二者关系有点像JavaScript（实现）与ECMAScript（规范）。