require.js使用简介
在web刚开始发展的蛮荒时代,一个页面中只需要加载一个或少量的js文件,不存在模块,也不存在冲突之类的问题,但随着web项目的发展,它越来越大,js文件动辄几十个,怎么加载就成为了一个问题,要为浏览器的性能考虑,还有各个js文件(模块)的依赖关系。require.js的出现就是为了解决这样的问题。
1、实现js文件的异步加载,避免网页失去响应。
2、管理模块之间的依赖性,便于代码的编写和维护。
require.js加载
使用require.js的第一步,是先去官方网站下载最新版本。
下载后,假定把它放在js子目录下面,就可以加载了。
<script type="text/javascript" src="require.js"></script>
加载require.js以后,下一步就要加载我们自己的代码了。假定我们自己的代码文件是main.js,也放在js目录下面。那么,只需要写成下面这样就行了:
<script type="text/javascript" src="require.js" data-main="main.js"></script>
data-main属性的作用是,指定网页程序的主模块。在上例中,就是js目录下面的main.js,这个文件会第一个被require.js加载。由于require.js默认的文件后缀名是js,所以可以把main.js简写成main。
主模块(main.js)的写法
所有代码都从这儿开始运行。下面就来看,怎么写main.js。如果我们的代码不依赖任何其他模块,那么可以直接写入javascript代码。
// main.js
require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){
// some code here
});
requier()函数接受两个参数。第一个参数是一个数组,表示所依赖的模块,就像上面例子中的[‘moduleA’, ‘moduleB’, ‘moduleC’];第二个参数是一个回调函数,当前面模块加载成功,依赖的模块会以参数的形式传入该函数,从而在回调函数内部就可以使用依赖模块的方法了。
require()异步加载mouduleA,mouduleB,mouduleC,浏览器都不会失去响应,它指定的回调函数只有在模块加载完成后才会运行,解决了依赖性的问题。
下面上一个实际一点的例子
假设主模块依赖jquery,和backbone这两个模块,main.js就应该这么写。
1 require(["jquery","backbone"],function($,backbone)
2 {
3 //code
4 })
require会先加载jquery和backbone,然后在运行回调函数,回调函数中的参数是该函数使用依赖模块的假名。
模块加载
在上面的例子汇总,主模块依赖模块是jquery和backbone默认的情况下,require.js嘉定这两个模块与main.js在同一个目录,文件名分别为jquery.js和backbone.js,然后你自动加载。
使用require.config()方法,我们可以对模块的加载行为进行自定义。require.config()就写在主模块的头部,参数就是一个对象,这个对象的paths属性指定各个模块的加载路径。
require.config(
{
path:{
"jquery":"jquert.min",
"backbone":"backbone.min"
}
})
如果其他模块与主函数不在一个路径下,这些模块在js/assest目录,则会有两种写法,一种是逐一指定路径。
require.config({
path:{
"jquery":"assest/jquery.min",
"backbone":"assest/backbone.min"
}
})
另一种是直接改变基目录(baseUrl)
require.config({
baseUrl:"js/assest",
path:{
"jquery":"jquert.min",
"backbone":"backbone.min"
}
})
如果使用的cdn服务
require.config(
{
path:{
"jquery":"https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"
}
})
AMD模块的写法
require.js加载的模块,采用AMD规范。所以自己写的模块必须按照AMD的规定来写。
模块在熟悉的时候必须采用特定的define()函数来定义。
假设现在有一个math.js文件,它是一个math模块,那么math.js就应该如下这么写。
//math.js
define(functio()
{
var add = function (x,y)
{
return x+y;
};
return{
add:add
}
})
使用该模块的方式
require(["math"],funciton(math)
{
consolo.log(math.add(2,3))
})
如果这个模块还依赖其他模块。
define(["myLib"],function(myLib)
{
function foo(){
myLib.do();
}
return{
foo:foo
}
})
require()函数加载上面这个模块的时候就会先加在myLib.js文件。
加载非AMD规范的模块
理论上,require.js加载的模块,必须是按照AMD规范、用define()函数定义的模块。但是实际上,虽然已经有一部分流行的函数库(比如jQuery)符合AMD规范,更多的库并不符合。那么,require.js是否能够加载非规范的模块呢?回答是可以的。这样的模块在用require()加载之前,要先用require.config()方法,定义它们的一些特征。举例来说,underscore和backbone这两个库,都没有采用AMD规范编写。如果要加载它们的话,必须先定义它们的特征。
require.config({
shim:{
'underscore':{
exports:"_"
},
backbone:{
deps:["underscore","jquery"],
exports:"Backbone"
}
}
}
})
require.config()接受一个配置对象,这个对象除了有前面说过的paths属性之外,还有一个shim属性,专门用来配置不兼容的模块。具体来说,每个模块要定义(1)exports值(输出的变量名),表明这个模块外部调用时的名称;(2)deps数组,表明该模块的依赖性。
比如,jQuery的插件可以这样定义:
require.config({
shim:{
Jquery.scroll:{
deps:["jquery"],
exports: 'jQuery.fn.scroll'
}
}
})