# 关键字`require`

前言

模块化的开发方式可以提高代码复用率，方便进行代码的管理。通常一个文件就是一个模块，有自己的作用域，只向外暴露特定的变量和函数。目前流行的 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,
}

1
2
3
4
5
6
7
8

引用自定义的模块

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

1
2
3
4
5

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
})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

引用模块的时候，我们将模块名放在[]中作为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)
})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# 3.CMD 和 sea.js

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

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

1
2
3
4
5
6

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)
}

1
2
3
4
5
6
7
8
9
10
11
12

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

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

1
2
3
4
5
6
7

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 模块不是对象，它的对外接口只是一种静态定义，在代码静态解析阶段就会生成

← 七.调试方法七.对象 →