前端模块化工具require.js的使用

来源:互联网 发布:方正幼圆字体下载 mac 编辑:程序博客网 时间:2024/05/22 05:04

一、为什么我们要用require.js?


远古时代,所有Javascript代码都写在一个文件里面,只要加载这一个文件就够了。后来,代码越来越多,一个文件不好使了,就分成多个文件,依次加载。下面的例子,相信很多人都见过:
<script src="1.js"></script><script src="2.js"></script><script src="3.js"></script><script src="4.js"></script>

这段代码依次加载多个js文件。
然而这样的写法有很大的缺点:首先,加载的时候,浏览器会停止网页渲染,加载文件越多,网页失去响应的时间就会越长;其次,由于js文件之间存在依赖关系,因此必须严格保证加载顺序(比如上例的1.js要在2.js的前面),依赖性最大的模块一定要放到最后加载,当依赖关系很复杂的时候,代码的编写和维护都会变得困难。
require.js的诞生,就是为了解决这两个问题:

(1)实现js文件的异步加载,避免网页长时间失去响应;

(2)管理模块之间的依赖性,便于代码的编写和维护。

二、require.js使用
使用require.js的第一步,是先去官网下载最新版本。
下载后,假定把它放在js子目录下面,就可以加载了。
<script src="js/require.js"></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。

这里的main.js,我把它称为"主模块",意思是这个网页所有js代码的入口。它有点像C语言的main()函数,所有代码都从这儿开始运行。
下面就来看,怎么写main.js。
如果我们的代码不依赖任何其他模块,那么可以直接写入javascript代码。
// main.js
alert("hello require.js!");

如果只是这样的话,就没必要使用require.js了。实际使用的情况是,主模块依赖于其他模块,这时就要使用AMD规范定义的的require()函数。

// main.js  require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){    // code here  });

require()函数接受两个参数。第一个参数是一个数组,表示所依赖的模块,上例就是['moduleA', 'moduleB', 'moduleC'],即主模块依赖这三个模块;第二个参数是一个回调函数,当前面指定的模块都加载成功后,它将被调用。加载的模块会以参数形式传入该函数,从而在回调函数内部就可以使用这些模块。
require()异步加载moduleA,moduleB和moduleC,浏览器不会失去响应;它指定的回调函数,只有前面的模块都加载成功后,才会运行,解决了依赖性的问题。

下面,我们看一个实际的demo:
假定主模块依赖jquery、underscore和template这三个模块,main.js就可以这样写:

require(['jquery', 'underscore', 'template'], function ($, _, template){    // some code here  });

require.js会先加载jQuery、underscore和template,然后再运行回调函数。主模块的代码就写在回调函数中,这里说下,第二个参数function中的参数是可写可不写的,它只是一个别名,用来调用该模块中的方法的,如果你用的是某个jquery插件,比如jquery.qrcode.min.js,那你的参数可以写成qrcode,然后按照原来的用法就行了。

三、模块的加载
上面的示例中,主模块的依赖模块是['jquery', 'underscore', 'template']。默认情况下,require.js假定这三个模块与main.js在同一个目录,文件名分别为jquery.js,underscore.js和template.js,然后自动加载。
使用require.config()方法,我们可以对模块的加载行为进行自定义。require.config()就写在主模块(main.js)的头部。参数就是一个对象,这个对象的paths属性指定各个模块的加载路径,如下。

require.config({    paths: {      "jquery": "jquery.min",      "underscore": "underscore.min",      "template": "template.min"    }  });

上面的代码给出了三个模块的文件名,路径默认与main.js在同一个目录(js子目录)。如果这些模块在其他目录,比如js/lib目录,则有两种写法。一种是逐一指定路径。

require.config({    paths: {      "jquery": "lib/jquery.min",      "underscore": "lib/underscore.min",      "template": "lib/template.min"    }  });

另一种则是直接改变基础目录(baseUrl)。

require.config({    baseUrl: "js/lib",    paths: {      "jquery": "jquery.min",      "underscore": "underscore.min",      "template": "template.min"    }  });

加入你用的是cdn上的静态资源文件,比如:

require.config({    paths: {      "jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"    }  });

四、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,2));  });

如果这个模块还依赖其他模块,那么define()函数的第一个参数,必须是一个数组,指明该模块的依赖性。
  define(['myLib'], function(myLib){    myLib.doSomething();  });
当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 0