04-Node.js模块化规范：CommonJS

前言

网站越来越复杂，js代码、js文件也越来越多，会遇到一些问题：

  • 文件依赖

  • 全局污染、命名冲突

程序模块化包括：

  • 日期模块

  • 数学计算模块

  • 日志模块

  • 登陆认证模块

  • 报表展示模块等。

所有这些模块共同组成了程序软件系统。

一次编写，多次使用，才是提高效率的核心。

模块化的理解

什么是模块化

概念：将一个复杂的程序依据一定的规则（规范）封装成几个块（文件），并组合在一起。

模块的内部数据、实现是私有的, 只是向外部暴露一些接口(方法)与外部其它模块通信。

最早的时候，我们会把所有的代码都写在一个js文件里，那么，耦合性会很高（关联性强），不利于维护；而且会造成全局污染，很容易命名冲突。

模块化的好处

  • 避免命名冲突，减少命名空间污染

  • 降低耦合性；更好地分离、按需加载

  • 高复用性：代码方便重用，别人开发的模块直接拿过来就可以使用，不需要重复开发类似的功能。

  • 高可维护性：软件的声明周期中最长的阶段其实并不是开发阶段，而是维护阶段，需求变更比较频繁。使用模块化的开发，方式更容易维护。

  • 部署方便

模块化规范

模块化规范的引入

假设我们引入模块化，首先可能会想到的思路是：在一个文件中引入多个js文件。如下：

  1. <body>
  2.     <script src="zepto.js"></script>
  3.     <script src="fastClick.js"></script>
  4.     <script src="util/login.js"></script>
  5.     <script src="util/base.js"></script>
  6.     <script src="util/city.js"></script>
  7. </body>

但是这样做会带来很多问题：

  • 请求过多：引入十个js文件，就有十次http请求。

  • 依赖模糊：不同的js文件可能会相互依赖，如果改其中的一个文件，另外一个文件可能会报错。

以上两点，最终导致：难以维护。

于是，这就引入了模块化规范。

模块化的概念解读

模块化起源于 Node.js。Node.js 中把很多 js 打包成 package，需要的时候直接通过 require 的方式进行调用（CommonJS），这就是模块化的方式。

那如何把这种模块化思维应用到前端来呢？这就产生了两种伟大的 js：RequireJS 和 SeaJS。

模块化规范

服务器端规范：

CommonJS 就是一套约定标准，不是技术。用于约定我们的代码应该是怎样的一种结构。

浏览器端规范：

  1. - 异步加载模块；
  3. - 依赖前置、提前执行：require([`foo`,`bar`],function(foo,bar){});   //也就是说把所有的包都 require 成功，再继续执行代码。
  5. - define 定义模块：define([`require`,`foo`],function(){return});
  • CMD规范：是 SeaJS 在推广过程中对模块化定义的规范化产出。淘宝团队开发。
  2.   同步加载模块；
  4.   依赖就近，延迟执行：require(./a) 直接引入。或者Require.async 异步引入。   //依赖就近：执行到这一部分的时候，再去加载对应的文件。
  6.   define 定义模块， export 导出：define(function(require, export, module){});

PS：面试时，经常会问AMD 和 CMD 的区别。

另外，还有ES6规范：import & export。

这篇文章，我们来讲一下CommonJS，它是 Node.js 使用的模块化规范。

CommonJS 的基本语法

CommonJS 的介绍

CommonJS：是 Node.js 使用的模块化规范。也就是说，Node.js 就是基于 CommonJS 这种模块化规范来编写的。

CommonJS 规范规定：每个模块内部，module 变量代表当前模块。这个变量是一个对象，它的 exports 属性（即 module.exports）是对外的接口对象。加载某个模块，其实是加载该模块的 module.exports 对象。

在 CommonJS 中，每个文件都可以当作一个模块：

  • 在服务器端：模块的加载是运行时同步加载的。

  • 在浏览器端: 模块需要提前编译打包处理。首先，既然同步的，很容易引起阻塞；其次，浏览器不认识require语法，因此，需要提前编译打包。

模块的暴露和引入

Node.js 中只有模块级作用域，两个模块之间的变量、方法，默认是互不冲突，互不影响，这样就导致一个问题：模块 A 要怎样使用模块B中的变量&方法呢？这就需要通过 exports 关键字来实现。

Node.js中，每个模块都有一个 exports 接口对象，我们可以把公共的变量、方法挂载到这个接口对象中，其他的模块才可以使用。

接下来详细讲一讲模块的暴露、模块的引入。

暴露模块的方式一： exports

exports对象用来导出当前模块的公共方法或属性。别的模块通过 require 函数调用当前模块时，得到的就是当前模块的 exports 对象。

语法格式：

  1. // 相当于是：给 exports 对象添加属性
  2. exports.xxx = value

这个 value 可以是任意的数据类型。

注意：暴露的关键词是exports，不是export。其实，这里的 exports 类似于 ES6 中的 export 的用法，都是用来导出一个指定名字的对象。

代码举例：

  1. const name = 'qianguyihao';
  3. const foo = function (value) {
  4.     return value * 2;
  5. };
  7. exports.name = name;
  8. exports.foo = foo;

暴露模块的方式二： module.exports

module.exports用来导出一个默认对象，没有指定对象名。

语法格式：

  1. // 方式一：导出整个 exports 对象
  2. module.exports = value;
  4. // 方式二：给 exports 对象添加属性
  5. module.exports.xxx = value;

这个 value 可以是任意的数据类型。

代码举例：

  1. // 方式1
  2. module.exports = {
  3.     name: '我是 module1',
  4.     foo(){
  5.         console.log(this.name);
  6.     }
  7. }
  9. // 我们不能再继续写 module.exports = value2。因为重新赋值，会把 exports 对象 之前的赋值覆盖掉。
  11. // 方式2
  12. const age = 28;
  13. module.exports.age = age;

module.exports 还可以修改模块的原始导出对象。比如当前模块原本导出的是一个对象，我们可以通过 module.exports 修改为导出一个函数。如下：

  1. module.exports = function () {
  2.     console.log('hello world')
  3. }

exports 和 module.exports 的区别

最重要的区别：

  • 使用exports时，只能单个设置属性 exports.a = a;

  • 使用module.exports时，既单个设置属性 module.exports.a，也可以整个赋值 module.exports = obj。

其他要点：

  • Node中每个模块的最后，都会执行 return: module.exports。

  • Node中每个模块都会把 module.exports指向的对象赋值给一个变量 exports，也就是说 exports = module.exports。

  • module.exports = XXX，表示当前模块导出一个单一成员，结果就是XXX。

  • 如果需要导出多个成员，则必须使用 exports.add = XXX; exports.foo = XXX。或者使用 module.exports.add = XXX; module.export.foo = XXX。

问题: 暴露的模块到底是谁？

答案：暴露的本质是exports对象。【重要】

比如，方式一的 exports.a = a 可以理解成是，给 exports 对象添加属性。方式二的 module.exports = a可以理解成是给整个 exports 对象赋值。方式二的 module.exports.c = c可以理解成是给 exports 对象添加属性。

Node.js 中每个模块都有一个 module 对象，module 对象中的有一个 exports 属性称之为接口对象。我们需要把模块之间公共的方法或属性挂载在这个接口对象中，方便其他的模块使用。

引入模块的方式：require

require函数用来在一个模块中引入另外一个模块。传入模块名，返回模块导出对象。

语法格式：

  1. const module1 = require('模块名');

解释：

  • 内置模块：require的是包名。

  • 下载的第三方模块：require的是包名。

  • 自定义模块：require的是文件路径。文件路径既可以用绝对路径，也可以用相对路径。后缀名.js可以省略。

代码举例：

  1. const module1 = require('./main.js');
  3. const module2 = require('./main');
  5. const module3 = require('Demo/src/main.js');

require()函数的两个作用：

  • 执行导入的模块中的代码。

  • 返回导入模块中的接口对象。

主模块

主模块是整个程序执行的入口，可以调度其他模块。

  1. # 运行main.js启动程序。此时，main.js就是主模块
  2. $ node main.js

模块的初始化

一个模块中的 JS 代码仅在模块第一次被使用时执行一次，并且在使用的过程中进行初始化，然后会被缓存起来，便于后续继续使用。

代码举例：

（1）calModule.js:

  1. var a = 1;
  3. function add () {
  4.   return ++a;
  5. }
  7. exports.add = add;

（2）main.js：（在 main.js 中引入 hello.js 模块）

  1. var addModule1 = require('./calModule')
  2. var addModule2 = require('./calModule')
  4. console.log(addModule1.add());
  5. console.log(addModule2.add());

在命令行执行 node main.js 运行程序，打印结果：

  1. 2
  2. 3

从打印结果中可以看出，calModule.js这个模块虽然被引用了两次，但只初始化了一次。

CommonJS 在服务器端的实现举例

1、初始化项目

在工程文件中新建如下目录和文件：

  1. modules
  2.     | module1.js
  3.     | module2.js
  4.     | module3.js
  6. app.js

然后在根目录下新建如下命令：

  1.   npm init

然后根据提示，依次输入如下内容：

  • 包名：可以自己起包名，也可以用默认的包名。注意，包名里不能有中文，不能有大写。

  • 版本：可以用默认的版本 1.0.0，也可以自己修改包名。

其他的参数，一路回车即可。效果如下：

04-Node.js模块化规范：CommonJS - 图1

于是，根目录下会自动生成package.json这个文件。点进去看一下：

  1. {
  2.   "name": "commonjs_node",
  3.   "version": "1.0.0",
  4.   "description": "",
  5.   "main": "app.js",
  6.   "scripts": {
  7.     "test": "echo \"Error: no test specified\" && exit 1"
  8.   },
  9.   "author": "smyhvae",
  10.   "license": "ISC"
  11. }

2、导入第三方包

uniq这个第三方包的作用是保证唯一性（我们拿它来举例）。我们在当前工程目录下，输入如下命令进行安装：

  1.   npm install uniq

安装成功后，根目录下会自动生成相应的文件：

04-Node.js模块化规范：CommonJS - 图2

需要说明的是，我的node版本是 v8.10.0（v8以上），对应的 npm 版本是 v5.6.0，版本比较高，因此，当我输入完npm install uniq之后，package.json中就会自动添加uniq包的依赖：

04-Node.js模块化规范：CommonJS - 图3

如果有些童鞋的npm版本较低，就需要手动去添加依赖；另一种方式是，可以使用npm install uniq --save命令，这个多出来的--save就可以自动添加依赖。

我们去官网看一下uniq的用法：

  1.   let uniq = require('uniq');
  3.   let arr = [1, 1, 2, 2, 3, 5];
  4.   uniq(arr);
  5.   console.log(arr);  //输出结果：[ 1, 2, 3, 5 ]

可以看出，这个包可以起到数组去重的作用。

3、自定义模块

（1）module1.js：

  1. //暴露方式一：module.exports = value
  3. //暴露一个对象出去
  4. module.exports = {
  5.     name: '我是 module1',
  6.     foo(){
  7.         console.log(this.name);
  8.     }
  9. }
  11. //我们不能再继续写 module.exports = xxx。因为重新赋值，会把之前的赋值覆盖掉。

（2）module2.js：

  1. //暴露方式一：module.exports = value
  3. //暴露一个函数出去
  4. module.exports = function(){
  5.     console.log('我是 module2');
  6. }

注意，此时暴露出去的 exports 对象 等价于整个函数。

（3）module3.js：

  1. //暴露方式二：exports.xxx = value
  3. //可以往 export 对象中不断地添加属性，进行暴露
  5. exports.foo1 = function(){
  6.     console.log('module3 中的 foo1 方法');
  7. }
  9. exports.foo2 = function(){
  10.     console.log('module3 中的 foo2 方法');
  11. }
  13. exports.arr = [1,1,2,2,3,5,11];

（4）app.js：（将其他模块汇集到主模块）

  1. //将其他模块汇集到主模块
  3. let uniq = require('uniq'); //引入时，第三方模块要放在自定义模块的上面
  5. let module1 = require('./modules/module1');
  6. let module2 = require('./modules/module2');
  7. let module3 = require('./modules/module3');
  9. //调用module1对象的方法
  10. module1.foo();
  12. //调用module2的函数
  13. module2();  //注意，在定义时，module2对象等价于整个函数function。所以，module2()的意思是，直接调用了函数。
  15. //调用module3中的属性
  16. module3.foo1();
  17. module3.foo2();
  19. uniq(module3.arr); //将module3中的数组进行去重操作
  20. console.log(module3.arr); //打印数组去重后的结果

这样的话，我们的代码就写完了。

我们在命令行中输入node app.js，就可以把代码跑起来了。打印结果如下：

  1. 我是 module1
  2. 我是 module2
  3. module3 中的 foo1 方法
  4. module3 中的 foo2 方法
  5. [ 1, 11, 2, 3, 5 ]

CommonJS 基于浏览器端的实现举例

1、初始化项目

在工程文件中新建如下目录和文件：

  1. js
  2.     dist //打包生成文件的目录
  3.     src //源码所在的目录
  4.       | module1.js
  5.       | module2.js
  6.       | module3.js
  7.       | app.js //应用主源文件
  8. index.html    //因为CommonJS是基于浏览器端，js文件要跑在浏览器的页面上，所以要有这个html页面

然后在根目录下新建如下命令：

  1.   npm init

然后根据提示，依次输入如下内容：

  • 包名：可以自己起包名，也可以用默认的包名。注意，包名里不能有中文，不能有大写。

  • 版本：可以用默认的版本 1.0.0，也可以自己修改包名。

其他的参数，一路回车即可。

于是，根目录下会自动生成package.json这个文件。点进去看一下：

  1. {
  2.   "name": "commonjs_browser",
  3.   "version": "1.0.0",
  4.   "description": "",
  5.   "main": "index.js",
  6.   "scripts": {
  7.     "test": "echo \"Error: no test specified\" && exit 1"
  8.   },
  9.   "author": "",
  10.   "license": "ISC"
  11. }

2、下载第三方包：Browserify

这里需要用到Browserify这个工具进行编译打包。Browserify 称为 CommonJS 的浏览器端的打包工具。

输入如下命令进行安装：（两个命令都要输入）

  1.     npm install browserify -g          //全局
  2.     npm install browserify --save-dev  //局部。

上面的代码中，-dev表示开发依赖。这里解释一下相关概念：

  • 开发依赖：当前这个包，只在开发环境下使用。

  • 运行依赖：当前这个包，是在生产环境下使用。

3、自定义模块 & 代码运行

（1）module1.js：

  1. //暴露方式一：module.exports = value
  3. //暴露一个对象出去
  4. module.exports = {
  5.     name: '我是 module1',
  6.     foo(){
  7.         console.log(this.name);
  8.     }
  9. }
  11. //我们不能再继续写 module.exports = xxx。因为重新赋值，会把之前的赋值覆盖掉。

（2）module2.js：

  1. //暴露方式一：module.exports = value
  3. //暴露一个函数出去
  4. module.exports = function(){
  5.     console.log('我是 module2');
  6. }

注意，此时暴露出去的 exports 对象 等价于整个函数。

（3）module3.js：

  1. //暴露方式二：exports.xxx = value
  3. //可以往export对象中不断地添加属性，进行暴露
  5. exports.foo1 = function(){
  6.     console.log('module3 中的 foo1 方法');
  7. }
  9. exports.foo2 = function(){
  10.     console.log('module3 中的 foo2 方法');
  11. }

（4）app.js：（将其他模块汇集到主模块）

  1. let module1 = require('./module1');  // ./ 指的是当前路径
  2. let module2 = require('./module2');
  3. let module3 = require('./module3');
  5. module1.foo();
  6. module2();
  7. module3.foo1();
  8. module3.foo2();

引入的路径解释：

  • ./是相对路径，指的是当前路径（app.js的当前路径是src）

到此，我们的主要代码就写完了。

但是，如果我们直接在index.html中，像下面这样写，是不行的：（因为浏览器不认识 require 关键字）

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6.     <meta http-equiv="X-UA-Compatible" content="ie=edge">
  7.     <title>Document</title>
  8. </head>
  9. <body>
  10.     <script src="./js/src/app.js"></script>
  11. </body>
  12. </html>

为了能够让index.html引入app.js，我们需要输入如下命令：

打包处理js:

  1.     browserify js/src/app.js -o js/dist/bundle.js

然后在index.html中引入打包后的文件：

  1.     <script type="text/javascript" src="js/dist/bundle.js"></script>