十.模块

前言

模块化的开发方式可以提高代码复用率，方便进行代码的管理。通常一个文件就是一个模块，有自己的作用域，只向外暴露特定的变量和函数。目前流行的 js 模块化规范有 CommonJS、AMD、CMD 以及 ES6 的模块系统

1.CommonJS

Node.js 是 commonJS 规范的主要实践者，它有四个重要的环境变量为模块化的实现提供支持：module、exports、require、global。实际使用时，用module.exports定义当前模块对外输出的接口（不推荐直接用exports）,用require加载模块。

• 定义模块 math.js

var basicNum = 0
function add(a, b) {
  return a + b
}
module.exports = {
  add: add,
  basicNum: basicNum,
}

• 引用自定义的模块

var math=require('./math')
math.add(2,5)
//引用核心模块时，不需要带路径
var http=require('http')
http.createService(...).listen(3000)

commonJS 用同步的方式加载模块。在服务端，模块文件都存在本地磁盘，读取非常快，所以这样做不会有问题。但是在浏览器端，限制于网络原因，更合理的方案是使用异步加载。

2.AMD 和 require.js

AMD 规范采用异步方式加载模块，模块的加载不影响它后面语句的运行。所有依赖这个模块的语句，都定义在一个回调函数中，等加载完成之后，这个回调函数才会运行。这里介绍用 require.js 实现 AMD 规范的模块化：用require.config()指定引用路径等，用define()定义模块，用require()加载模块。

首先我们需要引入 require.js 文件和一个入口文件 main.js。main.js 中配置require.config()并规定项目中用到的基础模块。

//网页中引入require.js及main.js
;<script src="js/require.js" data-main="ja/main"></script>
//main.js入口文件/主模块
//首先用config()指定各模块路径和引用名
require.config({
  baseUrl: "js/lib",
  path: {
    jquery: "jquery.min",
    underscore: "underscroe.min",
  },
})
//执行基本操作
require(["jquery", "underscore"], function ($, _) {
  //some code here
})

引用模块的时候，我们将模块名放在[]中作为require()的第一参数；如果我们定义的模块本身也依赖其他模块，那就需要将它们放在[]中作为define()的第一参数

//定义math.js模块
define(function () {
  var basicNum = 0
  var add = function (x, y) {
    return x + y
  }
  return {
    add: add,
    basicNum: basicNum,
  }
})
//定义一个依赖underscore.js的模块
define(["underscore"], function (_) {
  var classfy = function (list) {
    _.countBy(list, function (num) {
      return num > 30 ? "old" : "young"
    })
  }
  return {
    classify: classify,
  }
})
//引用模块，将模块放在[]内
require(["jquery", "math"], function ($, math) {
  var sum = math.add(10, 20)
  $("#sum").html(sum)
})

3.CMD 和 sea.js

require.js 在申明依赖的模块时会在第一之间加载并执行模块内的代码：

define(["a", "b", "c", "d", "e", "f"], function (a, b, c, d, e, f) {
  //等于在最前面声明并初始化了要用到的所有模块
  if (false) {
    b.foo()
  }
})

CMD 是另一种 js 模块化方案，它与 AMD 很类似，不同点在于：AMD 推崇依赖前置，提前执行；CMD 推崇依赖就近，延迟执行。此规范在 sea.js 推广过程中产生的。

4.ES6 Module

ES6 在语言标准的层面上，实现了模块功能，而且实现的相当简单，旨在称为浏览器和服务器通用的解决方案。其模块功能主要由两个命令构成：export和import.export命令用于规定模块的对外接口，import命令用于输入其他模块提供的功能。

//定义模块
var basicNum = 0
var add = function (a, b) {
  return a + b
}
export { basicNum, add }

//引用模块
import { basicNum, add } from "./math"
function test(ele) {
  ele.textContent = add(99 + basicNum)
}

如上例所示，使用import命令的时候，用户需要知道所要加载的变量名或函数名。其实 ES6 还提供了export default命令，为模块指定默认输出，对应的import语句不需要使用大括号.

//定义输出
export default { basicNum, add }
//引入
import math from "./math"
function test(ele) {
  ele.textContent = math.add(99 + math.basicNum)
}

ES6 的模块不是对象，import命令会被 JavaScript 引擎静态分析，在编译时就引入模块代码，而不是扎起代码运行时加载，所以无法实现条件加载。也正因为这个，使得静态分析成为可能。

5.模块间差异

5.1 数据使用方式

CommonJS 输出的是一个值的拷贝，ES6 Module 输出的是值的引用

• CommonJS 模块输出的是值的拷贝，也就是说，一旦输出一个值，模块内部的变化就影响不到这个值。
• ES6 模块的运行机制与 CommonJS 不一样。JS 引擎对脚本静态分析的时候，遇到模块加载命令import就会生成一个只读引用。等到脚本真正执行时，再根据这个只读引用，到被加载的吧、那个模块里面去取值。

5.2 输出时机

CommonJS 是运行时加载，ES6 Module 是编译时输出接口

• 运行时加载 CommonJS 模块就是对象，即在输入时是先加载整个模块，生成

• 一个对象在从这个对象上面读取方法，这种加载称为‘运行时加载’

• 编译时加载：ES6 模块不是对象，而是通过export命令显式指定输出的代码，import静态命令的形式。即在import时可以指定加载某个输出值，而不是加载整个模块，这个称为“编译时加载”

• CommonJS 加载的是一个对象，该对象只有在脚本运行完才会生成。而 ES6 模块不是对象，它的对外接口只是一种静态定义，在代码静态解析阶段就会生成

1.模块化

模块化是指把一个复杂的系统分解到多个模块以方便编码。

1.1 命名空间

开发网页通过命名空间的方式来组织代码

<script src="jquery.js"></script>

• 命名空间冲突，两个库可能使用同一个名称
• 无法合理地管理项目依赖和版本
• 无法方便的控制依赖的加载顺序

1.2 CommonJS

CommonJS是一种使用广泛的JavaScript模块化规范，核心思想是通过require方法来同步加载依赖的其他模块，通过 module.exports 导出需要暴露的接口

1.2.1 用法

采用 CommonJS 导入导出时的代码如下：

// 导入
const someFun = require("./moduleA")
someFun()

// 导出
module.exports = someFunc

1.2.2 原理

a.js

let fs = require("fs")
let path = require("path")
let b = req("./b.js")
function req(mod) {
  let filename = path.join(__dirname, mod)
  let content = fs.readFileSync(filename, "utf8")
  let fn = new Function(
    "exports",
    "require",
    "module",
    "__filename",
    "__dirname",
    content + "\n return modules.exports"
  )
  let module = {
    exports: {},
  }
  return fn(module.exports, req, module, __filename, __dirname)
}

b.js

console.log("bbb")
exports.name = "zfpx"

1.3 AMD

AMD 也是一种 JavaScript 模块化规范，与 CommonJS 最大的不同在于它采用异步的方式去加载依赖的模块。AMD 规范主要是为了解决针对浏览器环境的模块化问题，最具代表性的实现是 requirejs。

AMD 的优点

• 可以在不转换代码的情况下直接在浏览器运行
• 可加载多个依赖
• 代码可运行在浏览器或 node.js 环境下

AMD 的缺点

• JavaScript 运行环境没有原生支持 AMD，需要先导入实现了 AMD 的库后才能正常使用。

1.3.1 用法

// 定义一个模块
define("a", [], function () {
  return "a"
})
define("b", ["a"], function (a) {
  return a + "b"
})
// 导入和使用
require(["b"], function (b) {
  console.log(b)
})

1.3.2 原理

let factories = {}
function define(modName, dependencies, factory) {
  factory.dependencies = dependencies
  factories[modName] = factory
}
function require(modNames, callback) {
  let loadedModNames = modNames.map(function (modName) {
    let factory = factories[modName]
    let dependencies = factory.dependencies
    let exports
    require(dependencies, function (...dependencyMods) {
      exports = factory.apply(null, dependencyMods)
    })
    return exports
  })
  callback.apply(null, loadedModNames)
}

1.4 ES6 模块化

ES6 模块化是 ECMA 提出的 JavaScript 模块化规范，它在语言的层面上实现了模块化。浏览器厂商和 Node.js 都宣布要原生支持该规范。它将逐渐取代 CommonJS 和 AMD`规范，成为浏览器和服务器通用的模块解决方案。 采用 ES6 模块化导入及导出时的代码如下

// 导入
import { name } from "./person.js"
// 导出
export const name = "zfpx"

ES6 模块虽然是终极模块化方案，但它的缺点在于目前无法直接运行在大部分 JavaScript 运行环境下，必须通过工具转换成标准的 ES5 后才能正常运行

2.自动化构建

构建就是做这件事情，把源代码转换成发不到线上的可执行 JavaScript、CSS、HTML 代码，包括如下内容。

• 代码转换：ECMASCRIPT6 编译成 ECMASCRIPT5、LESS 编译成 CSS 等。
• 文件优化：压缩 JavaScript、CSS、HTML 代码，压缩合并图片等。
• 代码分割：提取多个页面的公共代码、提取首屏不需要执行部分的代码让其异步加载。
• 模块合并：在采用模块化的项目里会有很多个模块和文件，需要构建功能把模块分类合并成一个文件。
• 自动刷新：监听本地源代码的变化，自动重新构建、刷新浏览器。
• 代码校验：在代码提交到仓库前需要校验代码是否符合规范，以及单元测试是否通过。
• 自动发布：更新代码后，自动构建出线上发布代码并传输给发布系统。

3.webpack

Webpack 是一个打包模块化 JavaScript 的工具，在 Webpack 里一切文件皆模块，通过 Loader 转换文件，通过 Plugin 注入钩子，最后输出由多个模块组合成的文件。Webpack 专注于构建模块化项目。

一切文件：JavaScript、CSS、SCSS、图片、模板，在 Webpack 眼中都是一个个模块，这样的好处是能清晰的描述出各个模块之间的依赖关系，以方便 Webpack 对模块进行组合和打包。 经过 Webpack 的处理，最终会输出浏览器能使用的静态资源。