走进 node.js - 模块

101 阅读5分钟

持续创作,加速成长!这是我参与「掘金日新计划 · 6 月更文挑战」的第22天,点击查看活动详情

往期推荐

# 走进 node.js
# 走进 node.js - 起步

node.js - 模块 学习目标

  • 模块化编程方式
  • 模块通信规则
  • 模块的三种分类
  • 模块加载过程

模块化

  • 当你的网站开发越来越复杂代码越来越多的时候会经常遇到什么问题?
    • 恼人的命名冲突
    • 繁琐的文件依赖

JavaScript 一直没有模块(module)体系, 无法将一个大程序拆分成互相依赖的小文件,再用简单的方法拼装起来。 其他语言都有这项功能,比如 Ruby 的 require、Python 的 import , 甚至就连 CSS 都有 @import ,但是 JavaScript 任何这方面的支持都没有,这对开发大型的、复杂的项目形成了巨大障碍。

image.png

  • 现实角度(手机、电脑、活动板房)
  • 生产效率高
  • 可维护性好
  • 程序角度
  • 开发效率高(不需要在一个文件中翻来翻去,例如 jQuery 不可能在一个文件写 1w+ 代码,按照功能划分到不同文件中)
  • 可维护性好(哪个功能出问题,直接定位该功能模块即可)、

模块化的概念有了,那程序中的模块到底该具有哪些特性就满足我们的使用了呢?

  • 模块作用域
  • 好处就是模块不需要考虑全局命名空间冲突的问题
  • 模块通信规则
  • 所有模块如果都是封闭自然不行,我们需要让组件与组件相互组织联系起来,例如 CPU 需要读取内存中的数据来进行计算,然后把计算结果又交给了我们的操作系统
  • 所以我们的模块也是需要具有通信的能力的
  • 所谓的通信说白了也就是输入与输出

模块通信规则

  • require 模块导入
// 核心模块
var fs = require("fs");

// 第三方模块
// npm install marked
var marked = require("marked");

// 用户模块(自己写的),正确的,正确的方式
// 注意:加载自己写的模块,相对路径不能省略 ./
var foo = require("./foo.js");

// 用户模块(自己写的),正确的(推荐),可以省略后缀名 .js
var foo = require("./foo");
  • exports 模块导出
console.log(exports === module.exports); // => true
exports.a = 123;
exports.b = 456;
exports.c = 789;
exports.fn = function() {};

为什么 exports = xxx 不行

function fn() {
  // 每个模块内部有一个 module 对象
  // module 对象中有一个成员 exports 也是一个对象
  var module = {
    exports: {}
  };

  // 模块中同时还有一个成员 exports 等价于 module.exports
  var exports = module.exports;

  console.log(exports === module.exports); // => true

  // 这样是可以的,因为 exports === module.exports
  // module.exports.a = 123
  // exports.b = 456

  // 这里重新赋值不管用,因为模块最后 return 的是 module.exports
  // exports = function () {
  // }

  // 这才是正确的方式
  module.exports = function() {
    console.log(123);
  };

  // 最后导出的是 module.exports
  return module.exports;
}

var ret = fn();

console.log(ret);

exports 和 module.exports 的区别

  • 每个模块中都有一个 module 对象
  • module 对象中有一个 exports 对象
  • 我们可以把需要导出的成员都挂载到 module.exports 接口对象中
  • 也就是:moudle.exports.xxx = xxx 的方式
  • 但是每次都 moudle.exports.xxx = xxx 很麻烦,点儿的太多了
  • 所以 Node 为了你方便,同时在每一个模块中都提供了一个成员叫:exports
  • exports === module.exports 结果为 true
  • 所以对于:moudle.exports.xxx = xxx 的方式 完全可以:expots.xxx = xxx
  • 当一个模块需要导出单个成员的时候,这个时候必须使用:module.exports = xxx 的方式
  • 不要使用 exports = xxx 不管用
  • 因为每个模块最终向外 return 的是 module.exports
  • exports 只是 module.exports 的一个引用
  • 所以即便你为 exports = xx 重新赋值,也不会影响 module.exports
  • 但是有一种赋值方式比较特殊:exports = module.exports 这个用来重新建立引用关系的
  • 之所以让大家明白这个道理,是希望可以更灵活的去用它

特殊的导出方式

exports = module.exports = function() {
  console.log("默认函数被调用了");
};

exports.ajax = function() {
  console.log("ajax 方法被调用了");
};

exports.get = function() {
  console.log("get 方法被调用了");
};

模块分类

在开始了解具体的规则之前,我们先来了解一下在 Node 中对不模块的一个具体分类,一共就三种类别:

  • 核心模块
    • 由 Node 本身提供,具名的,例如 fs 文件操作模块、http 网络操作模块
  • 第三方模块
    • 由第三方提供,使用的时候我们需要通过 npm 进行下载然后才可以加载使用,例如我们使用过的 mimeart-templatemarked
    • 注意:不可能有第三方包的名字和核心模块的名字是一样的,否则会造成冲突
  • 用户模块(自己写的)
    • 我们在文件中写的代码很多的情况下不好编写和维护,所以我们可以考虑把文件中的代码拆分到多个文件中,那这些我们自己创建的文件就是用户模块

核心模块

  • 核心模块就是 node 内置的模块,需要通过唯一的标识名称来进行获取。
  • 每一个核心模块基本上都是暴露了一个对象,里面包含一些方法供我们使用
  • 一般在加载核心模块的时候,变量的起名最好就和核心模块的标识名同名即可
    • 例如:const fs = require('fs')
  • 核心模块本质上也是文件模块
    • 核心模块已经被编译到了 node 的可执行程序,一般看不到
    • 可以通过查看 node 的源码看到核心模块文件
    • 核心模块也是基于 CommonJS 模块规范

Node 中都以具名的方式提供了不同功能的模块,例如操作文件就是:fs 核心模块(系统模块)由 Node 提供,使用的时候都必须根据特定的核心模块名称来加载使用。例如使用文件操作模块:fs