模块化编程

Table of Contents

i.e. Modular Programming

每一个领域的内容,都要有先问一下 – 是什么?为什么?做什么?怎么做?

简介

模块化编程 (模块化程序设计),是指在进行程序设计时将一个大程序 按照功能划分 为若干小程序模块,每个小程序模块完成一个确定的功能,并在这些模块之间 建立必要的联系 ,通过模块的互相协作完成整个功能的程序设计方法。

大程序 → (功能)小程序模块( → 子过程) → 模块联系、协作

随着程序规模的扩大,无论是项目本身(编写、扩展、测试、维护),还是经济上的考虑(效率、收支),分工协作都是不可避免的。

在模块化的过程中可能会产生什么问题呢? 命名冲突 ,本质在于作用域。

实际项目中,模块化开发几乎不会是一个人开发所有模块,那就很难避免命名冲突(小甲和小乙都使用了同一个变量名、函数名),项目越大,越难控制。

下面我们就以 JavaScript 为例来看一下其模块化的发展。

为什么选用 JavaScript 呢?因为 JavaScript 最初的设计是没有模块化考虑的,而是随着其应用场景和范围的变化,逐渐通过各种方式实现了模块化,如此,我们可以看一下其模块化的全貌和历程。

JavaScript 的模块化1

1991年8月6日 (农历六月廿六),世界上第一个网页诞生。世界上的第一个网页是这样的 http://info.cern.ch/ ,只用来作为文本的展示和极其简单的交互。

万维网的发明者,互联网之父蒂姆·伯纳斯·李

检查一下网页源码的话,你会发现,它只是纯 HTML 文本,没有 CSS ,更没有 JavaScript 。

哈坤·利于 1994 年在芝加哥的一次会议上第一次展示了 CSS 的建议;JavaScript 是 1995 年由 Netscape公司的 Brendan Eich,在网景导航者浏览器上首次设计实现而成。

随着网页越来越像桌面程序,需要一个团队分工协作、进度管理、单元测试等等……开发者不得不使用软件工程的方法,管理网页的业务逻辑。JavaScript 的模块化编程,已经成为一个迫切的需求。

前面我们已经知道,JavaScript 最初设计的时候就没有考虑到模块化,那么我们要怎么实现它的模块化呢?

模块化编程是将一个大程序按照功能划分为若干小程序模块,那么,我们我们首先要解决的就是 划分模块

原始划分

我们可以认为模块就是实现特定功能的一组方法(以及记录状态),只要把不同函数简单地放在一起,就算是一个模块。

1: // 这就是一个模块
2: function m1() { /* ... */ }
3: function m2() { /* ... */ }
4: // ...

上面的代码中,函数 m1()m2() ,组成一个模块,使用的时候,直接调用就行了。这样做有以下缺点:

- 污染了全局变量,无法保证不与其他模块发生变量名冲突;
- 模块成员之间看不出直接关系。

对象划分

为了解决上面的缺点,可以把模块写成一个对象,所有的模块成员都放到这个对象里面。

1: var module1 = new Object({
2:     _count: 0,
3:     m1: function() { /* ... */ },
4:     m2: function() { /* ... */ }
5: })

上边的函数 m1()m2() ,都封装在 module1 对象里(现在它们有关系了,都属于一个对象嘛),使用的时候,就是调用这个对象的属性,如 module1.m1() 。但是,这样的写法会暴露所有模块成员,内部状态可以被外部改写,如 module1._count = 5

很显然,这样的封装是不安全的。

立即执行函数划分

如何不暴露私有成员的目的,自然是做到外界不能直接访问原始对象内部,只能访问我们想让他访问的对象。使用“立即执行函数(Immediately-Invoked Function Expression, IIFE)”,可以砍到不暴露私有成员的目的。

 1: var module1 = (function() {
 2:     var _count = 0
 3:     var m1 = function() { /* ... */ }
 4:     var m2 = function() { /* ... */ }
 5: 
 6:     // 这个就是我们想让外界访问到的对象了
 7:     return {
 8:         m1: m1,
 9:         m2: m2
10:     }
11: })();

如此,在 { m1: m1, m2: m2 } 中根本没有 _count 变量,外界自然是访问不到的喽。

至此,我们解决了 JavaScript 中如何模块化的问题 – 使用 IIFE 来实现模块分离(避免命名冲突、封装不够等问题)。

模块依赖

我们在前面已经讲述了 如何分离模块的问题 ,那么,另一个问题也就随之而来了 – 假如在一个程序中,模块 A 调用了 B ,B 又调用了 C、D ,我们如何处理 模块之间的依赖关系 呢?

什么是依赖?聚焦在模块本身无非就是两点:

  1. 如何导入一个模块?
  2. 如何导出模块中你想暴露的?

我们来了解一下比较成熟的模块实现方式,如 CommonJS、AMD、CMD、UMD 和 ES Module 等。后续的章节中,我们重点来认识一下 CommonJS 和 ES Module 两种模块规范,其他在实际项目中已经应用不多。

CommonJS2

在 Node 环境中,一个 .js 文件就称之为一个模块(module),它们遵循 CommonJS 模块规范。

我们来看一个具体的例子,假如我们遵循 CommonJS 规范编写 hello.js 文件,如下:

 1: // hello.js 文件就是名为 hello 的模块
 2: var s = 'Hello'
 3: 
 4: function greet(name) {
 5:     console.log(s + ', ' + name + '!')
 6: }
 7: 
 8: // 导出模块
 9: // 把函数 greet 作为模块的输出暴露出去
10: module.exports = greet

在同一目录下,再来编写 main.js 文件,来调用 hello 模块的 greet 函数,如下:

1: // 引入模块
2: // 使用 Node 提供的 `require` 函数引入模块 `hello`
3: var greet = require('./hello')
4: 
5: var s = 'Michael'
6: greet(s)                        // → Hello, Michael!

综上可知,CommonJS 规范,使用

  • module.exports 暴露模块,如 module.exports = variable ,其中 variable 可以是任意对象、函数、数组等;
  • require 函数导入模块,如 var ref = require('module_name) ,引入的对象具体是什么,取决于所引入模块输出的对象。

CommonJS 模块原理

我们知道,JavaScript 语言本身并没有一种模块机制来保证不同模块可以使用相同的变量名。

那么,NodeJS 是如何实现这一点的呢?

1. 模块隔离

其实要实现“模块”这个功能,并不需要语法层面的支持,NodeJS 也没有增加任何新的 JavaScript 语法。实现“模块”功能的奥妙就在于 JavaScript 是一种函数式编程语言, 它运行闭包!闭包!闭包! ,如我们上面说到是 IIFE 。我们只需要把一段 JavaScript 代码用一个函数包装起来,这段代码的所有“全局”变量就变成了函数内部的局部变量。

看,我们使用函数的作用域作了隔离,如此,就避免了不同模块内部变量、函数名的命名冲突。

下面,我们来看看 NodeJS 具体为我们做了什么?

我们编写的 hello.js 代码是这样的:

1: var name = 'world';
2: 
3: console.log('Hello, ' + name + '!');

NodeJS 加载了 hello.js 之后,把代码包装了一下,变成了这样执行 ↓ :

1: (function() {
2:     // 读取 hello.js 代码
3:     var name = 'world';
4: 
5:     console.log('Hello, ' + name + '!');
6:     // hello.js 代码读取结束
7: })()

如此, name 就变成了函数内部的局部变量,如果 NodeJS 继续加载其他模块,这些模块中定义的 name 也互不干扰。

2. 模块输出

NodeJS 利用 JavaScript 的函数式编程特性 – 闭包,轻松实现了模块的隔离。

但是,模块的输出 module.exports 是怎么实现的呢?

这个也容易,原来 NodeJS 先准备了一个对象 module ,如下:

 1: // NodeJS 准备一个 module 对象
 2: var module = {
 3:     id: 'hello',
 4:     exports: {}
 5: }
 6: 
 7: var load = function(module) {
 8:     // 读取的 hello.js 代码
 9:     function greet(name) {
10:         console.log('Hello, ' + name + '!')
11:     }
12: 
13:     module.exports = greet
14:     // hello.js 代码读取结束
15: 
16:     return module.exports;
17: }
18: 
19: var exported = load(module)
20: // 保存 module
21: save(module, exported)

可见,变量 module 是 NodeJS 在加载 .js 文件之前准备的一个变量,并将其传入加载函数,我们在 hello.js 中可以直接使用变量 module 原因就在于它实际上是加载函数的一个参数。

通过把参数 module 传递给 load() 函数, hello.js 就顺利地把一个变量传递给了 Node 执行环境,Node 会把 module 变量保存到某个地方。

由于 Node 保存了所有导入的 module ,当我们用 require() 获取模块时,Node 找到对应的 module ,把这个 moduleexports 属性返回,如此,另一个模块就拿到了模块的输出。

module.exports VS exports

我们只需要知道, module.exports 是 NodeJS 为我们准备的用于模块输入的唯一真正的对象, exports 不过是对 module.exports 的引用罢了。这也就决定了,如下使用方式的对错:

1: module.exports = { desc: '一个引用类型对象' } // 
2: module.exports.var1 = variable             // 
3: exports.var1 = variable                    // ✔ 并有改变 `exports` 的引用
4: exports = { desc: '一个引用类型对象'}         // ✘ 已改变了 `exports` 的引用
5: // 你改变了 `exports` 的指向,它就不再指向 `module.exports` 了,
6: // 自然也就不是模块的输出对象了,
7: // 记住,模块的输出对象只有一个

*注:强烈建议只使用 module.exports 方式来输出模块变量!

ES Module3

在 ES6 之前,社区制定了一些模块加载方案,最主要的有 CommonJS(Node 服务器端) 和 AMD (浏览器端)两种。

有一个好消息,ES6 在语言标准的层面上,实现了模块功能,而且实现得相当简单,完全可以取代 CommonJS 和 AMD 规范,成为浏览器和服务器通用的模块解决方案。

ES Module VS CommonJS

ES Module 模块的设计思想是尽量的 静态化 ,使得编译时就能确定模块的依赖关系,以及输入和输出的变量。CommonJS 和 AMD 模块,都只能在运行时确定这些东东。比如,CommonJS 模块输出的就是 module.exports 对象,输入时必须查找对象属性。

有了 ES6 静态加载,使得静态分析成为可能,就能进一步拓宽 JavaScript 的语法,比如引入宏(macro)和类型系统(type system)。
想一想,为什么 CommonJS 和 AMD 只有在运行时才能确定模块的依赖关系及输入输出变量呢?

因为它们本质上都是“立即执行函数”(IIFE),不执行自然无法得到!

1: let { stat, exists, readfile } = require('fs')
2: 
3: // 等同于
4: let _fs = require('fs')         // 引入了整个 `fs` 模块的整个输出对象
5: let stat = _fs.stat
6: let exists = _fs.exists
7: let readfile = _fs.readfile

上面代码的实质是整体加载 fs 模块(即加载 fs 模块的整个输出对象 module.exports ),生成一个对象 _fs ,然后再从这个对象上读取 3 个方法。

这种加载称为 运行时加载 ,因为只有运行时才能得到这个对象,导致完全没办法在编译时做“静态优化”。

所谓“静态化”,没那么玄乎,不过就是在运行之前,编译阶段就可以确定的一些东东。

与 CommonJS 模块输出的是 module.exports 对象不同的时,ES Module 模块输出的并不是对象,而是 通过 export 命令显式指定输出的代码,再通过 import 命令输入 。如下:

1: // ES Module
2: import { stat, exists, readFile } from 'fs'

其实质是从 fs 模块加载 3 个方法, 其他方法不加载 ,即它无法引用 ES Module 模块本身(因为它不是对象),这种加载称为 编译时加载 (或静态加载)。

export

ES Module 模块功能主要由两个命令构成: exportimport

  • export 命令用于规定模块的对外接口;
  • import 命令用于输入其他模块提供的功能。

export、import 命令可以出现在模块的任何位置,只要处于模块顶层就可以,因为处在代码块中,就没法做静态优化了。

*注: export 命令显式指定输出的代码,对,是代码!代码!代码!

其实,看一下基本的编译原理,就很容易理解这个地方了,`export` 输出的其实是一个动态外链。
1: export var year = 1990          // 
2: 
3: // or
4: var year = 1990
5: export { year }                 // 
6: // 还可以用别名输出
7: export { year as yearAlias1 }   // 
8: export { year as yearAlias2 }   // 

如上, export 导出的都是 var year = 1990 这行代码,而不是 year 这个变量。

如果,你像在下面这样使用,就会报错了,如:

1: export 1                        // 
2: 
3: var m = 1
4: export m                        // 

想一下,为会什么会报错呢?因为它们 不是有意义的代码 呗! 1 只是一个字面量,引用它明显没有什么意义,同样 m 中存的也是 1

同理,对于函数而言,也是一样的,如下:

1: export function f() {}          // 
2: // or
3: function f() {}
4: export { f }                    // 
5: export { f as fn }              // 
6: export f                        // 

export 语句输出的接口,与其对应的值是动态绑定关系。 即通过该接口,可以取到模块内部实时的值。这一点与 CommonJS 规范完全不同,CommonJS 模块输出的是值的缓存,不存在动态更新。

1: export var foo = 'bar'
2: setTimeout(() => foo = 'baz', 500)

上面代码输出变量 foo ,值为 bar ,500 毫秒后变成 baz

import

前面我们讲了输出 export ,这个章节我们来认识一下输入 import

import 命令接受一对大括号,里面指定要从其他模块导入的变量名,该变量名必须与被导入模块对象接口(输出的大括号是的变量啦)名称相同。其用法实例如下:

1: import { year } from './profile.js'             // 
2: import { year as yearAlias} from './profile.js' // 
3: 
4: import 'loadsh'                                 // ✔ 只是执行 loadsh 模块,不输入任何值

除了指定加载某个输出值,还可以使用 整体加载 ,即用星号( * )指定一个对象,所有输出值都加载在这个对象上面。

1: import * as circle from './circle'
2: 
3: circle.area(4)                  // 调用 circle 的 area() 方法计算面积
4: circle.circumference(14)        // 调用 circle 的 circumference() 方法计算周长

export default

前面说过,使用 import 命令的时候,用户需要知道所要加载的变量名或函数名,否则无法加载。为了给用户提供方便,让他们不用阅读文档就能加载模块,就要用到 export default 命令,为模块指定默认输出。

*注: 使用 export default 输出的代码,用 import 命令引入时,不使用大括号。

 1: // export-default.js ///
 2: // 匿名函数
 3: export default function() {}      // 
 4: // 具名函数
 5: export default function foo() {}  // 
 6: // or
 7: function foo() {}
 8: export default foo                // 
 9: 
10: // import-default.js ///
11: import baz from './exort-default' // ✔ `baz` 可以是任何自定义的变量名

但是,对于使用 export 命令时,就不能省略大括号,如下:

1: // export.js ///
2: export function foo() {}          // 
3: function foo() {}
4: export { foo }                    // 
5: 
6: // import.js ///
7: import { foo } from './export.js' // 
8: import foo form './export.js'     // 
9: 

本质上, export default 就是输出一个叫做 default 的变量或方法,然后系统允许你为它取任意名字。

 1: // export.js ///
 2: function add(x, y) {
 3:     return x + y
 4: }
 5: 
 6: export { add as default}        // 
 7: // 等同于
 8: // export default add           // ✔
 9: 
10: // import.js ///
11: import { default as foo } from './export.js' // 
12: // 等同于
13: // import foo from './export.js'             // ✔

同样,因为 export default 命令其实只是输出一个叫做 default 的变量,所以它后面不能跟变量声明语句。

1: export var a = 1                // 
2: 
3: var a = 1
4: export default a                // 
5: 
6: export default var a = 1        // 

export 与 import 的复合写法

如果在一个模块之中,先输入后输出同一个模块, import 语句可以与 export 语句写在一起。

1: export { foo, bar } from 'my_module';
2: 
3: // 等价于
4: import { foo, bar } from 'my_module';
5: export { foo, bar };

上面代码中, exportimport 语句可以结合在一起,写成一行。

但需要注意的是,写成一行以后, foobar 实际上 并没有被导入当前模块,只是相当于对外转发 了这两个接口,导致当前模块不能直接使用 foobar

模块的接口改名和整体输出,也可以采用这种写法。

 1: // 接口改名
 2: export { foo as myFoo } from 'my_module';
 3: 
 4: // 整体输出
 5: export * from 'my_module';
 6: export * as ns from "mod";
 7: 
 8: // 默认接口的写法
 9: export { default } from 'foo';
10: 
11: // 具名接口改为默认接口的写法
12: export { es6 as default } from './someModule';
13: // 等同于
14: import { es6 } from './someModule';
15: export default es6;
16: 
17: // 默认接口也可以改名为具名接口
18: export { default as es6 } from './someModule';

import()

前面介绍过, import 命令会被 JavaScript 引擎静态分析,先于模块内的其他语句执行。

这样的设计,固然有利于编译器提高效率,但也导致无法在运行时加载。在语法上,条件加载就不可能实现。如果 import 命令要取代 Node 的 require 方法,就形成了一个障碍。

1: // 报错
2: if (x === 2) {
3:     import MyModule from './myModule' // ✘ `import` 命令不支持动态加载
4: }

ES2020 提案引入了 import() 函数,支持动态加载模块。

import(specifier)               // `specifier` 指定所要加载的模块的位置

import() 函数和 import 命令接受的参数相同,区别在于 import() 可以动态加载,且与所加载的模块并没有静态链接关系, 返回一个 Promise 对象

import() 函数类似于 Node 的 require 方法,区别在于 import() 是异步加载,而 require 是同步加载。

1: if (condition) {
2:     import('moduleA').then( /* ... */ )    // 
3: 
4: } else {
5:     import('moduleB').then( /* ... */ )    // 
6: }

*注: import() 加载模块成功以后,这个模块会作为一个对象,当作 then 方法的参数。

Webpack Module4

在模块化编程中,开发者将程序分解成离散功能块(Discrete Chunks of Funtionality),并称之为模块。

每个模块具有比完整程序更小的接触面,使得校验、调试、测试轻而易举。精心编写的模块提供了可靠的抽象和封装界限,使得应用程序中每个模块都具有条理清楚的设计和明确的目的。

NodeJS 从一开始就支持模块化编程,而 Web 浏览器对于模块化的支持却姗姗来迟。在 Web 存在多种支持 JavaScript 模块化的工具,如 AMD、CMD 等,这些工具各有优势和限制。

Webpack 基于从这些系统获得的经验教训,并将模块的概念应用于项目中的任何文件。

什么是 Webpack 模块呢?

Webpack 模块能够以各种方式表达模块之间的依赖关系,如:

  • ES2015 的 import 语句;
  • CommonJS 的 require() 语句;
  • AMD 的 definerequire 语句;
  • CSS/SASS/LESS 文件中的 @import 语句;
  • 样式 url(...) 或 HTML 文件 <img src=...> 中的图片链接。

Webpack 是怎么做到这一点的呢? loader !

Webpack 通过 loader 可以支持各种语言和预处理器编写模块。loader 描述了 webpack 如何处理非 JavaScript 的模块,并且在 bundle 中引入这些依赖。另外,webpack 社区已经为各种就行语言和语言处理器构建了 loader ,如: CoffeeScript、TypeScript、ESNext(Babel)、Sass、Less 等。

*注:有关完整列表,请参考 loader 列表自己编写

Footnotes:

Date: 2020-12-11 Fri 12:12

Author: Jack Liu

Created: 2021-07-16 Fri 11:16

豫ICP备19900901号