ZhangYang's Blog

模块化基础

发表于 | 分类于

模块化的写法

  • 一个模块就是实现特定功能的文件，有了模块，我们就可以更方便地使用别人的代码，想要什么功能，就加载什么模块

原始写法

  • 只要把不同的函数（以及记录状态的变量）简单地放在一起，就算是一个模块
  • 缺点很明显：污染了全局变量，无法保证不与其他模块发生变量名冲突，而且模块成员之间没什么关系
1
2
3
4
5
6
7
8
// 函数m1()和m2()，组成一个模块。使用的时候，直接调用就行了
function fn1(){
  statement
}
function fn2(){
  statement
}

对象写法

  • 为了解决上面的缺点，可以把模块写成一个对象，所有的模块成员都放到这个对象里面
  • 这样避免了变量污染，只要保证模块名唯一即可，同时同一模块内的成员也有了关系
  • 缺点:外部可以随意修改内部成员,例如myModel.var1 = 100;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// 函数m1()和m2(），都封装在myModule对象里。使用的时候，就是调用这个对象的属性
var myModule = {
  var1: 1,
  var2: 2,
  fn1: function(){
  },
  fn2: function(){
  }
}
// 使用的时候，就是调用这个对象的属性
myModule.fn2();

立即执行函数写法

  • 使用”立即执行函数”（Immediately-Invoked Function Expression，IIFE），可以达到不暴露私有成员的目的
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// 这样在模块外部无法修改我们没有暴露出来的变量、函数
var myModule = (function(){
  var var1 = 1;
  var var2 = 2;
  function fn1(){
  }
  function fn2(){
  }
  return {
    fn1: fn1,
    fn2: fn2
  };
})();
  • 上述做法就是我们模块化的基础，目前，通行的JavaScript模块规范主要有两种：CommonJS和AMD

放大模式

  • 如果一个模块很大，必须分成几个部分，或者一个模块需要继承另一个模块，这时就有必要采用”放大模式”（augmentation）
1
2
3
4
5
6
7
// module1模块添加了一个新方法m3()，然后返回新的module1模块
var module1 = (function (mod){
　mod.m3 = function () {
　　//...
　};
　return mod;
})(module1);

宽放大模式

  • 在浏览器环境中，模块的各个部分通常都是从网上获取的，有时无法知道哪个部分会先加载
  • 如果采用上一节的写法，第一个执行的部分有可能加载一个不存在空对象，这时就要采用”宽放大模式”
1
2
3
4
5
// 与"放大模式"相比，＂宽放大模式＂就是"立即执行函数"的参数可以是空对象
var module1 = ( function (mod){
　//...
　return mod;
})(window.module1 || {});

输入全局变量

  • 独立性是模块的重要特点，模块内部最好不与程序的其他部分直接交互
  • 为了在模块内部调用全局变量，必须显式地将其他变量输入模块
1
2
3
4
5
- module1模块需要使用jQuery库和YUI库，就把这两个库（其实是两个模块）当作参数输入module1
- 这样做除了保证模块的独立性，还使得模块之间的依赖关系变得明显
var module1 = (function ($, YAHOO) {
　//...
})(jQuery, YAHOO);

模块的规范

  • 因为有了模块，我们就可以更方便地使用别人的代码，想要什么功能，就加载什么模块;
  • 这样做有一个前提，那就是大家必须以同样的方式编写模块
  • 通行的Javascript模块规范共有两种：CommonJS和AMD

CommonJS

  • 美国程序员RyanDahl创造了node.js项目，将javascript语言用于服务器端编程;node.js的模块系统，就是参照CommonJS规范实现的
  • 定义模块 根据CommonJS规范，一个单独的文件就是一个模块。每一个模块都是一个单独的作用域，也就是说，在该模块内部定义的变量，无法被其他模块读取，除非定义为global对象的属性
  • 模块输出： 模块只有一个出口，module.exports对象，我们需要把模块希望输出的内容放入该对象
  • 加载模块： 加载模块使用require方法，该方法读取一个文件并执行，返回文件内部的module.exports对象
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
//模块定义 myModel.js
var name = 'Byron';
function printName(){
    console.log(name);
}
function printFullName(firstName){
    console.log(firstName + name);
}
module.exports = {
    printName: printName,
    printFullName: printFullName
}
//加载模块
var nameModule = require('./myModel.js');
nameModule.printName();
实例二:
// math.js
exports.add = function() {
    var sum = 0, i = 0, args = arguments, l = args.length;
    while (i < l) {
        sum += args[i++];
    }
    return sum;
};
// increment.js
var add = require('math').add;
exports.increment = function(val) {
    return add(val, 1);
};
// program.js
var inc = require('increment').increment;
var a = 1;
inc(a); 
// 2
  • 不同的实现对require时的路径有不同要求，一般情况可以省略js拓展名，可以使用相对路径，也可以使用绝对路径，甚至可以省略路径直接使用模块名（前提是该模块是系统内置模块）

浏览器环境

  • require是同步的,模块系统需要同步读取模块文件内容,并编译执行以得到模块接口,这在服务器端实现很简单，但想在浏览器端实现问题却很多
  • 浏览器端，加载JavaScript最佳、最容易的方式是在document中插入script标签。但脚本标签天生异步，传统CommonJS模块在浏览器环境中无法正常加载

解决思路

  • 开发一个服务器端组件，对模块代码作静态分析，将模块与它的依赖列表一起返回给浏览器端。但需要服务器安装额外的组件，并因此要调整一系列底层架构
  • 用一套标准模板来封装模块定义，但是对于模块应该怎么定义和怎么加载，又产生的分歧:AMD和CMD

AMD

  • AMD 即Asynchronous Module Definition，中文名是异步模块定义的意思。它是一个在浏览器端模块化开发的规范
  • 用AMD规范进行页面开发需要用到对应的库函数RequireJS，实际上AMD 是 RequireJS 在推广过程中对模块定义的规范化的产出
  • requireJS主要解决两个问题:
  • 多个js文件可能有依赖关系，被依赖的文件需要早于依赖它的文件加载到浏览器
  • js加载的时候浏览器会停止页面渲染，加载文件越多，页面失去响应时间越长
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// 定义模块 myModule.js
define(['dependency'], function(){
    var name = 'Byron';
    function printName(){
        console.log(name);
    }
    return {
        printName: printName
    };
});
// 加载模块
require(['myModule'], function (my){
　 my.printName(); 
});
// 示例二:假如依赖jQuery、dialog库,需要将他们的全局变量$,Dialog传入
define('modal', ['jQuery', 'dialog'], function($, Dialog){
    $('.modal').show();
    Dialog.open();
});

AMD语法

  • requireJS定义了一个函数 define，它是全局变量，用来定义模块
  • 在页面上使用require函数加载模块

define

  • define(id?, dependencies?, factory)
  • id：可选参数，用来定义模块的标识，如果没有提供该参数，脚本文件名（去掉拓展名）
  • dependencies：可选参数,是一个当前模块依赖的模块名称数组
  • factory：工厂方法，模块初始化要执行的函数或对象。如果为函数，它应该只被执行一次。如果是对象，此对象应该为模块的输出值

require

  • require([dependencies], function(){})
  • 第一个参数是一个数组，表示所依赖的模块
  • 第二个参数是一个回调函数，当前面指定的模块都加载成功后，它将被调用。加载的模块会以参数形式传入该函数，从而在回调函数内部就可以使用这些模块
  • require()函数在加载依赖的函数的时候是异步加载的，这样浏览器不会失去响应，它指定的回调函数，只有前面的模块都加载成功后，才会运行，解决了依赖性的问题

CMD

  • CMD 即Common Module Definition通用模块定义，CMD规范是国内发展出来的，CMD有个浏览器的实现SeaJS，SeaJS要解决的问题和requireJS一样，只不过在模块定义方式和模块加载（可以说运行、解析）时机上有所不同
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
28
29
30
31
32
33
34
35
36
37
// 定义模块  myModule.js
define(function(require, exports, module) {
  var $ = require('jquery.js')
  $('div').addClass('active');
});
// 加载模块
seajs.use(['myModule.js'], function(my){
});
实例二
// math.js
define(function(require, exports, module) {
  exports.add = function() {
    var sum = 0, i = 0, args = arguments, l = args.length;
    while (i < l) {
      sum += args[i++];
    }
    return sum;
  };
});
// increment.js
define(function(require, exports, module) {
  var add = require('math').add;
  exports.increment = function(val) {
    return add(val, 1);
  };
});
// program.js
define(function(require, exports, module) {
  var inc = require('increment').increment;
  var a = 1;
  inc(a); // 2
  module.id == "program";
});

CMD语法

  • Sea.js 推崇一个模块一个文件，遵循统一的写法
  • requireJS定义了一个函数 define，它是全局变量，用来定义模块
  • 在页面上seajs.use加载模块
  • exports 是一个对象，用来向外提供模块接口
  • module 是一个对象，上面存储了与当前模块相关联的一些属性和方法

define

  • define(id?, deps?, factory)
  • 一个文件一个模块，所以经常就用文件名作为模块id(省略)
  • CMD推崇依赖就近，所以一般不在define的参数中写依赖(省略)
  • 在factory中写factory有三个参数:function(require, exports, module)

require

  • require 是 factory 函数的第一个参数
  • require(id):require 是一个方法，接受 模块标识 作为唯一参数，用来获取其他模块提供的接口
  • AMD推崇依赖前置，在定义模块的时候就要声明其依赖的模块
  • CMD推崇就近依赖，只有在用到某个模块的时候再去require

require.js

  • requireJS 遵循 AMD 规范，用于解决命名冲突和文件依赖的问题

require.js的加载

1
2
3
4
5
6
7
8
9
10
11
// 加载这个文件，也可能造成网页失去响应
<script src="js/require.js"></script>
// 解决办法有两个，一个是把它放在网页底部加载，另一个是写成下面这样
// async属性表明这个文件需要异步加载，避免网页失去响应。IE不支持这个属性，只支持defer，所以把defer也写上
<script src="js/require.js" defer async="true" ></script>
// 加载require.js以后，下一步就要加载我们自己的代码
// data-main属性的作用是，指定网页程序的主模块
// require.js默认的文件后缀名是js，所以可以把main.js简写成main
<script src="js/require.js" data-main="js/main"></script>

主模块的写法

  • main.js，我把它称为”主模块”，意思是整个网页的入口代码,所有代码就从这里运行
  • 主模块依赖于其他模块，这时就要使用AMD规范定义的的require()函数
  • 第一个参数是一个数组，表示所依赖的模块，即[‘moduleA’, ‘moduleB’, ‘moduleC’]，即主模块依赖这三个模块
  • 第二个参数是一个回调函数，当前面指定的模块都加载成功后，它将被调用。加载的模块会以参数形式传入该函数，从而在回调函数内部就可以使用这些模块
1
2
3
4
// 假定主模块依赖jquery、underscore和backbone这三个模块，main.js就可以这样写
require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){
	// some code here
});

模块的加载

  • 默认情况下，require.js假定这三个模块与main.js在同一个目录，文件名分别为jquery.js，underscore.js和backbone.js，然后自动加载
  • 使用require.config()方法，我们可以对模块的加载行为进行自定义
  • require.config()就写在主模块（main.js）的头部。参数就是一个对象，这个对象的paths属性指定各个模块的加载路径
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
// 这些模块在其他目录，比如js/lib目录，则有两种写法。一种是逐一指定路径
require.config({
　　paths: {
　　　　"jquery": "lib/jquery",
　　　　"underscore": "lib/underscore",
　　　　"backbone": "lib/backbone"
　　}
});
// 另一种则是直接改变基目录（baseUrl）
require.config({
　　baseUrl: "js/lib",
　　paths: {
　　　　"jquery": "jquery",
　　　　"underscore": "underscore",
　　　　"backbone": "backbone"
　　}
});
// 如果某个模块在另一台主机上，也可以直接指定它的网址
require.config({
　　paths: {
　　　　"jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery"
　　}
});
  • require.js要求，每个模块是一个单独的js文件。这样的话，如果加载多个模块，就会发出多次HTTP请求，会影响网页的加载速度
  • require.js提供了一个优化工具r.js，当模块部署完毕以后，可以用这个工具将多个模块合并在一个文件中，减少HTTP请求数

AMD模块的写法

  • require.js加载的模块，采用AMD规范。也就是说，模块必须按照AMD的规定来写
  • 模块必须采用特定的define()函数来定义
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
// 假定现在有一个math.js文件，它定义了一个math模块
// math.js
define(function (){
　　var add = function (x,y){
　　　　return x+y;
　　};
　　return {
　　　　add: add
　　};
});
// 如果这个模块还依赖其他模块，那么define()函数的第一个参数，必须是一个数组，指明该模块的依赖性
define(['myLib'], function(myLib){
　　function foo(){
　　　　myLib.doSomething();
　　}
　　return {
　　　　foo : foo
　　};
});
// 加载模块
// main.js
require(['math'], function (math){
　　alert(math.add(1,1));
});

加载非规范的模块

  • 理论上，require.js加载的模块，必须是按照AMD规范、用define()函数定义的模块
  • 流行的函数库（比如jQuery）符合AMD规范，更多的库并不符合(underscore和backbone)
  • 如果要加载它们的话，必须先定义它们的特征
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// shim属性，专门用来配置不兼容的模块。具体来说，每个模块要定义
（1）exports值（输出的变量名），表明这个模块外部调用时的名称
（2）deps数组，表明该模块的依赖性
require.config({
　　shim: {
　　　　'underscore':{
　　　　　　exports: '_'
　　　　},
　　　　'backbone': {
　　　　　　deps: ['underscore', 'jquery'],
　　　　　　exports: 'Backbone'
　　　　}
　　}
});
// jQuery的插件可以这样定义
shim: {
　　'jquery.scroll': {
　　　　deps: ['jquery'],
　　　　exports: 'jQuery.fn.scroll'
　　}
}

实战

  • 下载require.js放在lib目录内
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
// index.html
<!DOCTYPE html>
<html>
    <head>
        <script data-main="app" src="lib/require.js"></script>
    </head>
    <body>
        <h1>Hello World</h1>
    </body>
</html>
// app.js
requirejs.config({
    baseUrl: 'lib', //基目录
    paths: {
        app: '../app'
    }
});
// Start loading the main app file. Put all of
// your application logic in there.
requirejs(['app/main']);
// app/main.js
define(["./messages","print"],function (messages,print) {
    return print(messages.getHello());
});
// app/message.js
define(function () {
    return {
        getHello: function () {
            return 'Hello World';
        }
    };
});
// lib/print.js
define(function () {
    return function print(msg) {
        console.log(msg);
    };
});

requie.js路径的解析

>>requie.js路径的解析

r.js工具打包

  • r.js是一个打包工具，主要是与requirejs配合对模块化后的开发进行打包压缩，因为模块化的写法会导致多个http的请求并产生性能影响，因此在发布上线前要进行文件的压缩合并
  • r.js的运行需要node环境和git
  • 下载r.js放在index.html同级目录内
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// 实战接下来打包,设置配置文件，文件名为build.js
// build.js
({
    baseUrl: ".", //当前基路径
    name: "main", // name为需要打包压缩js文件的入口文件名字
    out: "main-built.js" // 出口文件名
})
// index.html
<script data-main="main-built" src="lib/require.js"></script>
// 根据调试各个依赖的路径
// git执行打包
node r.js -o build.js