模块化开发
什么是模块化
将一个复杂的程序依据一定的规则(规范)封装成几个块(文件), 并进行组合在一起
块的内部数据与实现是私有的, 只是向外部暴露一些接口(方法)与外部其它模块通信
为什么需要模块化
- 应用越大那么代码也越复杂
- 模块化利于解耦,降低复杂性和提高可维护性
- 应用部署可以优化代码,减少 http 请求(避免多模块文件造成的多请求)。
- 代码量比较大,可能会有几个人同时写一个页面,同样写在一个文件里面,可能会有冲突,模块化可以解决代码的冲突(匿名函数调用,自己调用自己,就是立即执行函数)
团队的分工更加的明确
先看一组模块化最基础实现思路:
立即执行函数:
// 定义module
var myModule = (function(){
var var1 = 1;
var var2 = 2;
function fn1(){}
function fn2(){}
return {
fn1,
fn2
};
})();
// 调用module
myModule.fn1()
myModule.fn2()
想必大家经常写函数封装,和对象。函数名会污染,对象里面的属性会被外界修改。所以立即执行函数是模块化的基础,大家看过jquery源码的话,可能会有一定的思考。
CommonJS
最基础的规范是CommonJS和AMD,CommonJS经node.js应运而生。我们介绍它的规范。
1、定义模块:根据CommonJS规范,一个单独的文件就是一个模块。每一个模块都是一个单独的作用域,也就是说,在该模块内部定义的变量,无法被其他模块读取,除非定义为global对象的属性
2、模块输出:模块只有一个出口,module.exports对象,我们需要把模块希望输出的内容放入该对象
3、加载模块:加载模块使用require方法,该方法读取一个文件并执行,返回文件内部的module.exports对象
demo:
//模块定义 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();
尴尬的浏览器
仔细看上面的代码,会发现require是同步的。模块系统需要同步读取模块文件内容,并编译执行以得到模块接口。
这在服务器端实现很简单,也很自然,然而, 想在浏览器端实现问题却很多。
浏览器端,加载JavaScript最佳、最容易的方式是在document中插入script 标签。但脚本标签天生异步,传统CommonJS模块在浏览器环境中无法正常加载。
解决思路之一是,开发一个服务器端组件,对模块代码作静态分析,将模块与它的依赖列表一起返回给浏览器端。 这很好使,但需要服务器安装额外的组件,并因此要调整一系列底层架构。
另一种解决思路是,用一套标准模板来封装模块定义,但是对于模块应该怎么定义和怎么加载,又产生的分歧:
AMD(Asynchronous Module Definition)
见名知意,就是异步模块定义,当然是为了解决上述同步加载问题。
AMD对应的就是很有名的RequireJS。
requireJS主要解决两个问题
- 多个js文件可能有依赖关系,被依赖的文件需要早于依赖它的文件加载到浏览器
- js加载的时候浏览器会停止页面渲染,加载文件越多,页面失去响应时间越长
// 定义模块 myModule.js
define(['dependency'], function(){
var name = 'Byron';
function printName(){
console.log(name);
}
return {
printName: printName
};
});
// 加载模块
require(['myModule'], function (my){
my.printName();
});
语法
requireJS定义了一个函数 define,它是全局变量,用来定义模块
define(id?, dependencies?, factory);
id:可选参数,用来定义模块的标识,如果没有提供该参数,脚本文件名(去掉拓展名)
dependencies:是一个当前模块依赖的模块名称数组
factory:工厂方法,模块初始化要执行的函数或对象。如果为函数,它应该只被执行一次。如果是对象,此对象应该为模块的输出值
在页面上使用require函数加载模块
require([dependencies], function(){});
require()函数接受两个参数*
第一个参数是一个数组,表示所依赖的模块
第二个参数是一个回调函数,当前面指定的模块都加载成功后,它将被调用。加载的模块会以参数形式传入该函数,从而在回调函数内部就可以使用这些模块
require()函数在加载依赖的函数的时候是异步加载的,这样浏览器不会失去响应,它指定的回调函数,只有前面的模块都加载成功后,才会运行,解决了依赖性的问题。
CMD(Common Module Definition)
即通用模块定义,对应SeaJS,是阿里玉伯团队首先提出的概念和设计。跟requireJS解决同样问题,只是运行机制不同。
demo:
// 定义模块 myModule.js
define(function(require, exports, module) {
var $ = require('jquery.js')
$('div').addClass('active');
});
// 加载模块
seajs.use(['myModule.js'], function(my){
});
语法
Sea.js 推崇一个模块一个文件,遵循统一的写法。
define(id?, deps?, factory)
因为CMD推崇一个文件一个模块,所以经常就用文件名作为模块id
CMD推崇依赖就近,所以一般不在define的参数中写依赖,在factory中写
factory有三个参数
function(require, exports, module)
require
require 是 factory 函数的第一个参数
require(id)
require 是一个方法,接受 模块标识 作为唯一参数,用来获取其他模块提供的接口
exports
exports 是一个对象,用来向外提供模块接口
module
module 是一个对象,上面存储了与当前模块相关联的一些属性和方法
AMD与CMD区别
最明显的区别就是在模块定义时对依赖的处理不同
- AMD推崇依赖前置,在定义模块的时候就要声明其依赖的模块
- CMD推崇就近依赖,只有在用到某个模块的时候再去require
看到很多网站说AMD是异步加载,CMD是同步加载,肯定是不准确的,他们的都是异步加载模块。
通俗来说:
- AMD在加载完成定义(define)好的模块就会立即执行,所有执行完成后,遇到require才会执行主逻辑。(提前加载)
- CMD在加载完成定义(define)好的模块,仅仅是下载不执行,在遇到require才会执行对应的模块。(按需加载)
- AMD用户体验好,因为没有延迟,CMD性能好,因为只有用户需要的时候才执行。
- CMD为什么会出现,因为对node.js的书写者友好,因为符合写法习惯,就像为何vue会受人欢迎的一个道理。
不过es6 moudle结合了commonjs和AMD的优点,因为其简约的api已经可以完全取代它们了。
本文摘自:
作者:沐雨芝录
https://www.jianshu.com/p/890c83fbcf50