Node.js 模块化

1. 介绍

1.1 什么是模块化与模块 ?

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

1.2 什么是模块化项目 ?

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

1.3 模块化好处

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

1. 防止命名冲突
2. 高复用性
3. 高维护性

2. 模块暴露数据

2.1 模块初体验

可以通过下面的操作步骤，快速体验模块化

1. 创建 me.js

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

2. 创建 index.js

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

2.2 暴露数据

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

1. module.exports = value
2. exports.name = value

使用时有几点注意：

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

2.3 暴露数据 案例

2.3.1 me.js

//声明一个函数
function tiemo(){
  console.log('贴膜...');
}

//捏脚
function niejiao(){
  console.log('捏脚....');
}

//暴露数据
// module.exports = {
//   tiemo,
//   niejiao
// }

// exports 暴露数据
// exports.niejiao = niejiao;
// exports.tiemo = tiemo;

//1. module.exports 可以暴露`任意`数据
// module.exports = 'iloveyou';
// module.exports = 521;

//2. 不能使用 `exports = value`的形式暴露数据
// exports = 'iloveyou' // X

// exports = module.exports = {}
// console.log(module.exports);
// console.log(module.exports === exports);

exports = module.exports = {tiemo:tiemo}
exports.tiemo = tiemo;
// exports = 'iloveyou' // X

2.3.2 index.js

//导入模块
const me = require('./me.js');

//输出 me
console.log(me);
// me.tiemo();
// me.niejiao();

3. 导入（引入）模块

在模块中使用 require 传入文件路径即可引入文件
const test = require('./me.js');

3.1 require 使用的一些注意事项

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

3.2 导入模块 案例

3.2.1 duanzi.js

module.exports = '我是个段子';

3.2.2 duanzi.json

{
  "text": "有一天北极熊打电话给企鹅，问他为什么每次约他去看电影他都不去？为什么啊？企鹅回答到，我他妈太南了。",
  "name": "曹小俊吖",
  "id": 1
}

3.2.3 index.js

//导入模块  // fs 
// const tiemo = require('./me.js');

//省略后缀 JS
// const tiemo = require('./me');

//导入 JSON 文件
// const duanzi = require('./duanzi');
// console.log(duanzi);//对象

//导入其他类型的文件
const test = require('./test');

console.log(test);
// //调用函数
// tiemo();

3.2.4 me.js

//声明一个函数
function tiemo(){
  console.log('贴膜...');
}

//暴露数据
module.exports = tiemo;

4. 导入模块的基本流程

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

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

4.1 导入文件夹 案例

4.1.1 app.js

module.exports = '我是一个模块';

4.1.2 main.js

//导入
const m = require('./module');

console.log(m);

5. CommonJS 规范

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

6. require 案例

6.1 me.js

const test = {
  name: '尚硅谷'
}

module.exports = test;

//输出
// console.log(arguments.callee.toString());
console.log(test);

6.2 show.js

/**
 * 伪代码
 */

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');

6.3 index.js

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