requirejs的⽤法(⼆)
这个系列的和,介绍了Javascript模块原型和理论概念,今天介绍如何将它们⽤于实战。
我采⽤的是⼀个⾮常流⾏的库。
⼀、为什么要⽤require.js?
最早的时候,所有Javascript代码都写在⼀个⽂件⾥⾯,只要加载这⼀个⽂件就够了。后来,代码越来越多,⼀个⽂件不够了,必须分成多个⽂件,依次加载。下⾯的⽹页代码,相信很多⼈都见过。
<script src="1.js"></script>
<script src="2.js"></script>
<script src="3.js"></script>
<script src="4.js"></script>
<script src="5.js"></script>
<script src="6.js"></script>
这段代码依次加载多个js⽂件。
这样的写法有很⼤的缺点。⾸先,加载的时候,浏览器会停⽌⽹页渲染,加载⽂件越多,⽹页失去响应的时间就会越长;其次,由于js⽂件之间存在依赖关系,因此必须严格保证加载顺序(⽐如上例的1.js要在2.js的前⾯),依赖性最⼤的模块⼀定要放到最后加载,当依赖关系很复杂的时候,代码的编写和维护都会变得困难。
require.js的诞⽣,就是为了解决这两个问题:
(1)实现js⽂件的异步加载,避免⽹页失去响应;
(2)管理模块之间的依赖性,便于代码的编写和维护。
⼆、require.js的加载
使⽤require.js的第⼀步,是先去官⽅⽹站最新版本。
下载后,假定把它放在js⼦⽬录下⾯,就可以加载了。
<script src="js/require.js"></script>
有⼈可能会想到,加载这个⽂件,也可能造成⽹页失去响应。解决办法有两个,⼀个是把它放在⽹页底部加载,另⼀个是写成下⾯这样:
<script src="js/require.js" defer async="true" ></script>
async属性表明这个⽂件需要异步加载,避免⽹页失去响应。IE不⽀持这个属性,只⽀持defer,所以把defer也写上。
加载require.js以后,下⼀步就要加载我们⾃⼰的代码了。假定我们⾃⼰的代码⽂件是main.js,也放在js⽬录下⾯。那么,只需要写成下⾯这样就⾏了:
<script src="js/require.js" data-main="js/main"></script>
data-main属性的作⽤是,指定⽹页程序的主模块。在上例中,就是js⽬录下⾯的main.js,这个⽂件会第⼀个被require.js加载。由于require.js默认的⽂件后缀名是js,所以可以把main.js简写成main。
三、主模块的写法
上⼀节的main.js,我把它称为"主模块",意思是整个⽹页的⼊⼝代码。它有点像C语⾔的main()函数,所有代码都从这⼉开始运⾏。
下⾯就来看,怎么写main.js。
如果我们的代码不依赖任何其他模块,那么可以直接写⼊javascript代码。
// main.js
alert("加载成功!");
但这样的话,就没必要使⽤require.js了。真正常见的情况是,主模块依赖于其他模块,这时就要使⽤AMD规范定义的的require()函数。
// main.js
require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){
varsity // some code here
});
海上钢琴师下载require()函数接受两个参数。第⼀个参数是⼀个数组,表⽰所依赖的模块,上例就是['moduleA', 'moduleB', 'moduleC'],即主模块依赖这三个模块;第⼆个参数是⼀个回调函数,当前⾯指定的模块都
加载成功后,它将被调⽤。加载的模块会以参数形式传⼊该函数,从⽽在回调函数内部就可以使⽤这些模块。
require()异步加载moduleA,moduleB和moduleC,浏览器不会失去响应;它指定的回调函数,只有前⾯的模块都加载成功后,才会运⾏,解决了依赖性的问题。
下⾯,我们看⼀个实际的例⼦。
假定主模块依赖jquery、underscore和backbone这三个模块,main.js就可以这样写:
require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){
游戏设计学校 // some code here
});
require.js会先加载jQuery、underscore和backbone,然后再运⾏回调函数。主模块的代码就写在回调函数中。
四、模块的加载
bingo儿歌
上⼀节最后的⽰例中,主模块的依赖模块是['jquery', 'underscore', 'backbone']。默认情况下,require.js假定这三个模块与main.js在同⼀个⽬录,⽂件名分别为jquery.js,underscore.js和backbone.js,然后⾃动加载。
使⽤fig()⽅法,我们可以对模块的加载⾏为进⾏⾃定义。fig()就写在主模块(main.js)的头部。参数就是⼀个对象,这个对象的paths属性指定各个模块的加载路径。
fig({
paths: {
qite "jquery": "jquery.min",
"underscore": "underscore.min",
"backbone": "backbone.min"
}
});
上⾯的代码给出了三个模块的⽂件名,路径默认与main.js在同⼀个⽬录(js⼦⽬录)。如果这些模块在其他⽬录,⽐如js/lib⽬录,则有两种写法。⼀种是逐⼀指定路径。
fig({
paths: {
"jquery": "lib/jquery.min",
"underscore": "lib/underscore.min",
"backbone": "lib/backbone.min"
}
});
另⼀种则是直接改变基⽬录(baUrl)。
fig({
baUrl: "js/lib",
paths: {
"jquery": "jquery.min",
"underscore": "underscore.min",
"backbone": "backbone.min"
}
});
如果某个模块在另⼀台主机上,也可以直接指定它的⽹址,⽐如:
fig({
paths: {
"jquery": "/ajax/libs/jquery/1.7.2/jquery.min"
}
});
require.js要求,每个模块是⼀个单独的js⽂件。这样的话,如果加载多个模块,就会发出多次HTTP请求,会影响⽹页的加载速度。因此,require.js提供了⼀个,当模块部署完毕以后,可以⽤这个⼯具将多个模块合并在⼀个⽂件中,减少HTTP请求数。
五、AMD模块的写法
require.js加载的模块,采⽤AMD规范。也就是说,模块必须按照AMD的规定来写。
具体来说,就是模块必须采⽤特定的define()函数来定义。如果⼀个模块不依赖其他模块,那么可以直接定义在define()函数之中。
假定现在有⼀个math.js⽂件,它定义了⼀个math模块。那么,math.js就要这样写:
// math.js
define(function (){
var add = function (x,y){
return x+y;
};
return {
add: add
气球英语 };
});
加载⽅法如下:
// main.js
require(['math'], function (math){
alert(math.add(1,1));
});
如果这个模块还依赖其他模块,那么define()函数的第⼀个参数,必须是⼀个数组,指明该模块的依赖性。
bacteria
define(['myLib'], function(myLib){
function foo(){
indispensable myLib.doSomething();
}
return {
foo : foo
};
});
当require()函数加载上⾯这个模块的时候,就会先加载myLib.js⽂件。
六、加载⾮规范的模块
理论上,require.js加载的模块,必须是按照AMD规范、⽤define()函数定义的模块。但是实际上,虽然已经有⼀部分流⾏的函数库(⽐如jQuery)符合AMD规范,更多的库并不符合。那么,require.js是否能够加载⾮规范的模块呢?
回答是可以的。
这样的模块在⽤require()加载之前,要先⽤fig()⽅法,定义它们的⼀些特征。
举例来说,underscore和backbone这两个库,都没有采⽤AMD规范编写。如果要加载它们的话,必须先定义它们的特征。
fig({
shim: {
'underscore':{
exports: '_'
},
takecareof
'backbone': {
deps: ['underscore', 'jquery'],
exports: 'Backbone'
}
}
});
⽐如,jQuery的插件可以这样定义:
shim: {
'jquery.scroll': {
deps: ['jquery'],
exports: 'jQuery.fn.scroll'
}
}
七、require.js插件
require.js还提供⼀系列,实现⼀些特定的功能。
姐姐妹妹站起来英文domready插件,可以让回调函数在页⾯DOM结构加载完成后再运⾏。
require(['domready!'], function (doc){
// called once the DOM is ready
});
text和image插件,则是允许require.js加载⽂本和图⽚⽂件。
define([
'',
'image!cat.jpg'
],
function(review,cat){
console.log(review);
document.body.appendChild(cat);
}
);
类似的插件还有json和mdown,⽤于加载json⽂件和markdown⽂件。