浅谈前端的模块化(一)
XYooo opened this issue · 1 comments
综述:
在互联网应用越来越复杂,不可避免的需要工具来管理我们的前端代码。以前是一个巨大的脚本文件,如今希望可以将文件写入不同的文件模块,并且希望代码可以重用,可以简单地引用和添加各种各样的依赖到我们的项目。
1.简述前端为什么需要模块化开发
如果按照以往的以页面为单位的开发,会导致很多问题,类似依赖管理、命名冲突等等问题。
命名冲突是最常见的问题,描述如下:
//在util.js中
function log(message){
}
//在logger.js中
function log(message){
}
因此如果在页面的script标签同时依赖这两个文件的时候就会产生冲突,导致后面的函数会被覆盖。从而可能产生一些预料之外的结果。
传统的解决方案是使用命名空间:
//在util.js中
function util.log(message){
}
//在logger.js中
function logger.log(message){
}
这样带来的显而易见的问题是:所有的代码会变得冗余并且编写困难
如果使用模块化编写方案,如使用CMD(Common Module Definition),代码依赖就会变得格外简单。
先简单介绍一下CMD,一个模块用define关键词来定义,即define(factory)
factory可以是一个函数也可以是其他的变量;如果factory是一个函数的话,那它三个参数分别是:require,exports,module即可以用来定义一个模块的内容:
define(function(require, exports, module) {
// The module code goes here });
引用模块用require关键词,接受一个模块名作为参数,返回模块暴漏的API作为返回结果。若不成功则返回null。示例如下:
紧接上面继续:
// util.js
var log = function(message) {
}
module.exports = log
// logger.js
var log = function(message) {
}
module.exports = log
// app.js using util.js log for logging
var log =require("util.js")
log("Hello Module Definition")
此时,util.js与logger.js不会相互冲突,它们会被工具包装为CMD下的定义方式。然后通过依赖的方式来解决冲突。
2.细说前端模块化
在Javascript发展初期就是为了实现简单的页面交互逻辑,寥寥数句即可;如今,很多页面的逻辑迁移到客户端(表单验证等),随着web2.0时代的到来,Ajax技术得到广泛的应用,Jquery等前端库层出不穷,前端代码日益膨胀。
而javascript,甚至没有类的概念,更不用说模块(module)了。
2.1 模块(Java)
这里首先借鉴一下其他语言是如何处理大规模程序设计的,在Java中有一个重要的概念——package
即:逻辑上相关的代码组织到同一个包内,包内是一个相对独立的王国,不用担心命名冲突什么的,
在外面直接使用import
对应的package即可,如:
import java.uti.ArrayList
2.2 模块(Javascript)
Javascript在设计时定位的原因,没有提供类似的功能,开发者需要模拟出类似的功能,来隔离、组织复杂的Javascript代码,我们称为模块化。
有了模块,我们就可以更方便的使用别人的代码。
模块开发需要遵循一定的规范,各行其是就都乱套了。规范形成的过程是痛苦的,发展到现在初具规模。
2.2.1 函数封装
JavaScript的作用域就是基于函数的,所以把函数作为模块化的第一步是很自然的事情,在一个文件里面编写几个相关函数就是最开始的模块了
function fn1(){
statement
}
function fn2(){
statement
}
缺点:污染了全局变量,无法保证不与其他模块发生变量名冲突,而且模块成员之间没什么关系。
2.2.2对象
为了解决上面的问题,对象的写法应运而生,可以把所有的模块成员****封装在一个对象中
var myModule = {
var1: 1,
var2: 2,
fn1: function(){
},
fn2: function(){
}
}
这样我们在希望调用模块的时候引用对应文件,然后
myModule.fn2();
这样避免了变量污染,只要保证模块名唯一即可,同时同一模块内的成员也有了关系
看似不错的解决方案,但是也有缺陷,外部可以随意修改内部成员
myModel.var1 = 100;
这样就会产生意外的安全问题
2.2.3立即执行函数
可以通过立即执行函数,来达到隐藏细节的目的
var myModule = (function(){
var var1 = 1;
var var2 = 2;
function fn1(){
}
function fn2(){
}
return {
fn1: fn1,
fn2: fn2
};
})();
这样在模块外部无法修改我们没有暴露出来的变量、函数
上述做法就是我们模块化的基础,目前,通行的JavaScript模块规范主要有两种:CommonJS和AMD
3.Javascript的模块规范(CommonJS、AMD、CMD)
3.1CommonJS
我们先从CommonJS谈起,因为在网页端没有模块化编程(虽然页面JavaScript逻辑复杂,但也可以工作下去),在服务器端却一定要有模块,所以第一个流行的模块化规范由服务器端的JavaScript应用带来,CommonJS规范是由NodeJS发扬光大,这标志着JavaScript模块化编程正式登上舞台。
(1)定义模块:
根据CommonJS规范,一个单独的文件就是一个模块。每一个模块都是一个单独的作用域,也就是说,在该模块内部定义的变量,无法被其他模块读取,除非定义为global对象的属性
(2)模块输出:
模块只有一个出口,module.exports对象,我们需要把模块希望输出的内容放入该对象
(3)加载模块:
加载模块使用require方法,该方法读取一个文件并执行,返回文件内部的module.exports对象
看个例子
//模块定义 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时的路径有不同要求,一般情况可以省略js
拓展名,可以使用相对路径,也可以使用绝对路径,甚至可以省略路径直接使用模块名(前提是该模块是系统内置模块)
(4)尴尬的浏览器
上面的代码,require
是同步的。模块系统需要同步读取模块文件内容,并编译执行以得到模块的接口,但是这在浏览器端实现却会遇到很多问题。
浏览器端,加载JavaScript最佳、最容易的方式是在document中插入script
标签。但脚本标签天生异步,传统CommonJS模块在浏览器环境中无法正常加载。
解决思路之一是,开发一个服务器端组件,对模块代码作静态分析,将模块与它的依赖列表一起返回给浏览器端。 这很好使,但需要服务器安装额外的组件,并因此要调整一系列底层架构。
另一种解决思路是,用一套标准模板来封装模块定义,但是对于模块应该怎么定义和怎么加载,又产生的分歧。
3.2AMD
AMD即Asynchromous Module Defination
,中文是异步模块定义的意思,他就是浏览器端模块化开发的规范。
由于不是JavaScript原生支持,使用AMD规范进行页面开发需要用到对应的库函数,也就是大名鼎鼎RequireJS,实际上现有RequireJS再有的AMD。
requireJS主要解决两个问题
(1)多个js文件可能有依赖关系,被依赖的文件需要早于依赖它的文件加载到浏览器
(2)js加载的时候浏览器会停止页面渲染,加载文件越多,页面失去响应时间越长
看一个使用requireJS的例子
// 定义模块 myModule.js
define(['dependency'], function(){
var name = 'Byron';
function printName(){
console.log(name);
}
return {
printName: printName
};
});
// 加载模块
require(['myModule'], function (my){
my.printName();
});
3.2.1语法
requireJS定义了一个函数 define,它是全局变量,用来定义模块。
(1)define,它是全局变量,用来定义模块
define(id?, dependencies?, factory);
1)id:可选参数,用来定义模块的标识,如果没有提供该参数,脚本文件名(去掉拓展名)
2)dependencies:是一个当前模块依赖的模块名称数组
3)factory:工厂方法,模块初始化要执行的函数或对象。如果为函数,它应该只被执行一次。如果是对象,此对象应该为模块的输出值
(2)在页面上使用require函数加载模块
require([dependencies], function(){});
require()函数接受两个参数
1)第一个参数是一个数组,表示所依赖的模块
2)第二个参数是一个回调函数,当前面指定的模块都加载成功后,它将被调用。加载的模块会以参数形式传入该函数,从而在回调函数内部就可以使用这些模块
require()函数在加载依赖的函数的时候是异步加载的,这样浏览器不会失去响应,它指定的回调函数,只有前面的模块都加载成功后,才会运行,解决了依赖性的问题。
3.3CMD
CMD即Common Module Definition
,通过模块定义。AMD有个RequireJS,CMD有个浏览器实现的SeaJS,SeaJS要解决的问题和RequireJS一样,只不过在模块定义方式和模块加载(可以说运行、解析)时机上有所不同。
3.3.1语法
Sea.js 推崇一个模块一个文件,遵循统一的写法
(1)define
define(id?, deps?, factory)
CMD推崇
1)一个文件一个模块,所以经常就用文件名作为模块id
2)CMD推崇依赖就近,所以一般不在define的参数中写依赖,在factory中写。
(2)factory有三个参数
function(require, exports, module)
1)require
require是factory函数的第一个参数
require(id)
require是一个方法,接受模块标识作为唯一的参数,用来获取其他模块提供的接口
2)exports
exports是一个对象,用来向外提供模块的接口
3)module
module是一个对象,上面存储了与当前模块相关联的属性和方法
看一个使用CMD的例子
// 定义模块 myModule.js
define(function(require, exports, module) {
var $ = require('jquery.js')
$('div').addClass('active');
});
// 加载模块
seajs.use(['myModule.js'], function(my){
});
4.AMD与CMD区别
关于这两个的区别网上可以搜出一堆文章,简单总结一下
最明显的区别就是在模块定义时对依赖的处理不同
(1)AMD推崇依赖前置,在定义模块的时候就要声明其依赖的模块
(2)CMD推崇就近依赖,只有在用到某个模块的时候再去require
这种区别各有优劣,只是语法上的差距,而且requireJS和SeaJS都支持对方的写法
AMD和CMD最大的区别是对依赖模块的执行时机处理不同,注意不是加载的时机或者方式不同
很多人说requireJS是异步加载模块,SeaJS是同步加载模块,这么理解实际上是不准确的,其实加载模块都是异步的,只不过AMD依赖前置,js可以方便知道依赖模块是谁,立即加载,而CMD就近依赖,需要使用把模块变为字符串解析一遍才知道依赖了那些模块,这也是很多人诟病CMD的一点,牺牲性能来带来开发的便利性,实际上解析模块用的时间短到可以忽略
为什么我们说两个的区别是依赖模块执行时机不同,为什么很多人认为ADM是异步的,CMD是同步的(除了名字的原因。。。)
同样都是异步加载模块,AMD在加载模块完成后就会执行改模块,所有模块都加载执行完后会进入require的回调函数,执行主逻辑,这样的效果就是依赖模块的执行顺序和书写顺序不一定一致,看网络速度,哪个先下载下来,哪个先执行,但是主逻辑一定在所有依赖加载完成后才执行
CMD加载完某个依赖模块后并不执行,只是下载而已,在所有依赖模块加载完成后进入主逻辑,遇到require语句的时候才执行对应的模块,这样模块的执行顺序和书写顺序是完全一致的
这也是很多人说AMD用户体验好,因为没有延迟,依赖模块提前执行了,CMD性能好,因为只有用户需要的时候才执行的原因
写的好,赞一个