引入require.js,可以解决的问题:
(1)实现js文件的异步加载,避免网页失去响应;
(2)管理模板之间的依赖性,便于代码的编写和维护。
它的模块管理遵循AMD规范(Asynchronous Module Definition - 异步加载模块规范);所谓AMD规范,就是为了解决模块化编程带来的代码加载先后顺序问题,以及常规为解决该阻塞问题方式带来的各种附加问题。
核心是通过define方法将无序混乱代码分割为有序的模块,通过require方法实现代码的模块加载。
一、require.js的加载
把从官网下载的文件放在js目录下,按如下方式引用:
<script src="js/require.js"></script>
加载这个文件,也可能造成网页失去响应。解决办法有两个,一个是把它放在网页底部加载,另一个是写成下面这样:
<script src="js/require.js" defer async="true" ></script>
加载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。
二、定义模块的define方法
2.1 独立模块
define({ create : function (){}, update : function (){}, read : function (){}, delete : function (){} });
这是一个定义了拥有CURD4个方法的独立新模块,还可以这样写:
define(function (){ return{ create : function (){}, update : function (){}, read : function (){}, delete : function (){} }; });
第二种方法更自由,还可以初始化一些代码;对象变成了函数,函数的返回值即模块。
2.2 非独立模块
define([‘image‘, ‘text‘], function (img, txt){ return{ get : function (){ img.geturl(); txt.getext(); } }; });
参数以数组形式定义了一个依赖image模块和text模块的新模块,image和text分别代表同样被定义为模块的image.js文件和text.js文件,回调中的参数则分别对应加载的模块。新模块中get方法调用了image模块的geturl方法和text模块的getext方法。
三、加载模块的require写法
3.1 异步加载
主模块依赖其他模块,则主模块的写法如下:
// main.js require([‘moduleA‘, ‘moduleB‘, ‘moduleC‘], function (moduleA, moduleB, moduleC){ // 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,然后再运行回调函数。主模块的代码就写在回调函数中。
3.2 动态加载
define(function (require){ var status = false; require([‘image‘, ‘text‘], function (img, txt){ status = true; }); return status; });
这是一个新的独立模块,定义模块的define方法内部动态加载了2个模块,加载完成后设置了一个状态值并返回。
define([‘html‘], function (html){ var hm = new html(); require([‘image‘, ‘text‘], function (img, txt){ hm.set({ img : img, txt : txt }); }; return hm.send(); });
这是一个新的非独立模块,加载了一个依赖模块html,定义模块的define方法内部动态加载了2个模块,加载完成后改变html模块的set对象并返回html模块的send对象。
3.3 第三参数
require([‘image‘, ‘text‘], function (img, txt){ return true; }, function (err){ return false; });
回调用于处理错误,参数为接受到的error对象。
三、模块的加载
上一节最后的示例中,主模块的依赖模块是[‘jquery‘, ‘underscore‘, ‘backbone‘]。默认情况下,require.js假定这三个模块与main.js在同一个目录,文件名分别为jquery.js,underscore.js和backbone.js,然后自动加载。
使用require.config()方法,我们可以对模块的加载行为进行自定义。require.config()就写在主模块(main.js)的头部。参数就是一个对象,这个对象的paths属性指定各个模块的加载路径。
require.config({ paths: { "jquery": "jquery.min", "underscore": "underscore.min", "backbone": "backbone.min" } });
上面的代码给出了三个模块的文件名,路径默认与main.js在同一个目录(js子目录)。如果这些模块在其他目录,比如js/lib目录,则有两种写法。一种是逐一指定路径。
require.config({ paths: { "jquery": "lib/jquery.min", "underscore": "lib/underscore.min", "backbone": "lib/backbone.min" } });
另一种则是直接改变基目录(baseUrl)。相对于require.js的路径
require.config({ baseUrl: "js/lib", paths: { "jquery": "jquery.min", "underscore": "underscore.min", "backbone": "backbone.min" } });
如果某个模块在另一台主机上,也可以直接指定它的网址,比如:
require.config({ paths: { "jquery": "https://ajax.googleapis.com/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()函数的第一个参数,必须是一个数组,指明该模块的依赖性。
define([‘myLib‘], function(myLib){ function foo(){ myLib.doSomething(); } return { foo : foo }; });
当require()函数加载上面这个模块的时候,就会先加载myLib.js文件。
五、加载非规范的模块
理论上,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的插件可以这样定义:
shim: { ‘jquery.scroll‘: { deps: [‘jquery‘], exports: ‘jQuery.fn.scroll‘ } }
六、参考
【1】初步认识了解require与AMD模式 http://segmentfault.com/a/1190000002515305
【2】Javascript模块化编程(三):require.js的用法 http://www.ruanyifeng.com/blog/2012/11/require_js.html