require.js的用法

爲何要用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文件之間存在依賴關係，所以必須嚴格保證加載順序，依賴性最大的模塊必定要放到最後加載，當依賴關係很複雜的時候，代碼的編寫和維護都會變得困難。

reuqire.js的誕生，就是爲了解決這兩個問題：

實現js文件的異步加載，避免網頁失去響應

管理模塊之間的易依賴性，便於代碼的編寫和維護

reuqire.js的加載

使用require.js的第一步，是先下載require.js

下載後，假定把它放在js的子目錄下面，就能夠加載了。

<script src='js/require.js'></script>

有人可能會想到，加載這個文件，也可能形成網頁失去響應。解決辦法有兩個，一個是把它放在網頁底部加載，另外一個是寫成下面這樣：

<script src='js/require.js' defer async='true'></script>

async屬性代表這個文件須要異步加載，避免網頁失去響應。IE不支持這個屬性，只支持，因此把defer也寫上。

加載require.js以後，下一步就要加載咱們本身的代碼了。假定咱們本身的代碼文件是main.js，也就是放在js目錄下面。那麼，只須要寫成下面這樣就好了

<script src="require.js" data-main='js/main'></script>

data-main 屬性的做用是，指定網頁程序的‘主模塊’，意思是整個網頁的入口代碼。它就像c語言的main()函數，全部代碼都從這兒開始運行。若是咱們的代碼不依賴任何其餘模塊，那麼能夠直接寫入javascript代碼

alert('加載成功！')

但這樣的話，就沒有必要使用require.js了。真正常見的狀況是，主模塊依賴於其餘模塊，這是就是使用AMD規範定義的require()函數

//main.js

require(['modelA','modelB'],function(){

　　//some code here

});

require()函數接受兩個參數。第一個參數是一個數組，表示所依賴的模塊，上例就是['modelA','modelB'],即主模塊依賴着兩個模塊，第二個參數是一個回調函數，當前面的模塊都加載成功後，它將會被調用。加載的模塊會以參數形式傳入該函數，從而在回調函數內部就可使用這些模塊。

require()異步加載moduleA，moduleB和moduleC，瀏覽器不會失去響應；它指定的回調函數，只有前面的模塊都加載成功後，纔會運行，解決了依賴性的問題。

demo：

假定主模塊依賴jquery、underscore和backbone這三個模塊，main.js就能夠這樣寫：

　　require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){

　　　　// some code here

　　});

require.js會先加載jQuery、underscore和backbone，而後再運行回調函數。主模塊的代碼就寫在回調函數中。

模塊的加載

使用require.config()方法，咱們能夠對模塊的加載行爲進行自定義。require.config()就寫在主模板(main.js)的頭部。參數就是一個對象，這個對象的paths屬性指定哥哥模塊的加載路徑。

require.config({

　　paths:{

　　　　'jquery':'jquery.js',

　　　　'underscore':'underscore.js',

　　　　'backbone':'backbone.js',

　　}

})

上面的代碼給出了三個模塊的文件名，路徑默認與main.js在同一個目錄（js子目錄）。若是這些模塊在其餘目錄，好比js/lib目錄，則有兩種寫法。一種是逐一指定路徑。

　　require.config({

　　　　paths: {

　　　　　　"jquery": "lib/jquery.min",
　　　　　　"underscore": "lib/underscore.min",
　　　　　　"backbone": "lib/backbone.min"

　　　　}

　　});

另外一種則是直接改變基目錄（baseUrl）

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文件。這樣的h話，若是加載多個模塊，就會發出屢次HTTP請求，會影響網頁的加載速度。所以，require.js提供了一個優化工具（http://requirejs.org/docs/optimization.html），當模塊部署完以後，能夠用這個工具將多個模塊合併在一個文件中，減小HTTP請求數。

AMD 模塊的寫法

require.js加載的模塊，採用AMD規範。這就是說，模塊必須按照AMD的規定來寫。

具體來講，就是模塊必須採用特定的define()函數來定義。若是一個模塊不依賴其餘模塊，那麼能夠直接定義在define()函數之中。

假定如今有一個math.js，它定義了一個math模塊，那麼，math.js就是這樣寫：

define(functin(){

　　var add=function(x,y){

　　　　return x+y;
}

return{

　　add:add

}

});

加載方法以下：

//main.js

require(['math'],function(math){

　　alert(math.add(1,1));

});

 

若是這個模塊還依賴其餘的模塊，那麼define()函數的第一個參數，必須是一個數組，指明該模塊的依賴性。

define(['modelA'],function(){

　　function add(x,y){

　　　　return x+y;

　　　　};

　　　function foo(){

　　　　　　modelA.doSomething();

　　　　　　}



return {

　　add:add,

　　 foo:foo

}

});

當require()函數加載上面的這個模塊的時候，就會先加載modelA文件。

 加載非規範的模塊

理論上require.js 加載的模塊，必須是按照AMD規範，用define()函數定義的模塊。可是實際上，雖然有一部分流行的函數庫符合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'

　　　　}

　　}

require.js插件

require.js還提供一系列插件，實現一些特定的功能。

domready插件，可讓回調函數在頁面DOM結構加載完成後再運行。

　　require(['domready!'], function (doc){

　　　　// called once the DOM is ready

　　});

text和image插件，則是容許require.js加載文本和圖片文件。

　　define([

　　　　'text!review.txt',

　　　　'image!cat.jpg'

　　　　],

　　　　function(review,cat){

　　　　　　console.log(review);

　　　　　　document.body.appendChild(cat);

　　　　}

　　);

相似的插件還有json和mdown，用於加載json文件和markdown文件。

 

 

 

 

原文出處：http://www.ruanyifeng.com/blog/2012/11/require_js.html