requirejs初體驗

1.初識

因爲工作的需要,現在開始使用requirejs來做前端模塊的管理開發。在這之前都沒有使用過這類工具的我,看到這個很懵逼啊有木有。但是沒辦法,還是要啃下來。
在真的開發之前,先看requirejs官網。竟然是英文的,沒辦法,勉強看。
我們首先來看下,什麼是requirejs。這個很重要,要弄懂自己使用的工具到底是什麼,有什麼作用。

1.1 什麼事requirejs

RequireJS is a JavaScript file and module loader. It is optimized for
in-browser use, but it can be used in other JavaScript environments,
like Rhino and Node. Using a modular script loader like RequireJS will
improve the speed and quality of your code.

這段是官網的原話。翻譯後就是:

RequireJS是一個JavaScript文件和模塊加載器。
它針對瀏覽器內的使用進行了優化,但可用於其他JavaScript環境,如Rhino和Node。
使用像RequireJS這樣的模塊化腳本加載器可以提高代碼的速度和質量。

我的個人理解是,requirejs是一個把你的文件整理加載的工具,可以提高代碼的利用率和不重複。減少http請求。

1.2 requirejs下載和安裝

在簡單的瞭解了requirejs後,已經迫不及待的想要使用這個先進的方式來重新編碼我的頁面了。那我們先做的就是下載requirejs

2.使用

現在完成後,將requirejs放在我們的js文件下。
創建一個html,在頁面中使用:

<script type="text/javascript"  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。

3. 主模塊的寫法

上一節的main.js,我把它稱爲”主模塊”,意思是整個網頁的入口代碼。它有點像C語言的main()函數,所有代碼都從這兒開始運行。
下面就來看,怎麼寫main.js。
如果我們的代碼不依賴任何其他模塊,那麼可以直接寫入javascript代碼。

// main.js
  alert("加載成功!");

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

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

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

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

下面,我們看一個實際的例子。
假定主模塊依賴jquery、jquery-ui和jquery-slide這三個模塊,main.js就可以這樣寫:

require(['jquery', 'jquery-ui', 'jquery-slide'], function ($){
    // some code here
  });

require.js會先加載jQuery、jquery-ui’和jquery-slide,然後再運行回調函數。主模塊的代碼就寫在回調函數中。

4. 模塊的加載

上一節最後的示例中,主模塊的依賴模塊是[‘jquery’, ‘jquery-ui”, ‘jquery-slide’]。默認情況下,require.js假定這三個模塊與main.js在同一個目錄,文件名分別爲jquery.js,jquery-slide.js和jquery-ui.js,然後自動加載。
使用require.config()方法,我們可以對模塊的加載行爲進行自定義。require.config()就寫在主模塊(main.js)的頭部。參數就是一個對象,這個對象的paths屬性指定各個模塊的加載路徑。

require.config({
    paths: {
      "jquery": "jquery.min",
      "jquery-ui": "jquery-ui.min",
      "jquery-slide": "jquery-slide.min"
    }
  });

上面的代碼給出了三個模塊的文件名,路徑默認與main.js在同一個目錄(js子目錄)。如果這些模塊在其他目錄,比如js/lib目錄,則有兩種寫法。一種是逐一指定路徑。

require.config({
    paths: {
      "jquery": "lib/jquery.min",
      "jquery-ui": "lib/jquery-ui.min",
      "jquery-slide": "lib/jquery-slide.min"
    }
  });

另一種則是直接改變基目錄(baseUrl)

require.config({
    baseUrl: "js/lib",
    paths: {
      "jquery": "jquery.min",
      "jquery-ui": "jquery-ui.min",
      "jquery-slide": "jquery-slide.min"
    }
  });

如果某個模塊在另一臺主機上,也可以直接指定它的網址,比如:

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

require.js要求,每個模塊是一個單獨的js文件。這樣的話,如果加載多個模塊,就會發出多次HTTP請求,會影響網頁的加載速度。因此,require.js提供了一個優化工具,當模塊部署完畢以後,可以用這個工具將多個模塊合併在一個文件中,減少HTTP請求數。

5. 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(['my'], function(my){
    function foo(){
      my.doSomething();
    }
    return {
      foo : foo
    };
  });

當require()函數加載上面這個模塊的時候,就會先加載my.js文件。

6. 加載非規範的模塊

理論上,require.js加載的模塊,必須是按照AMD規範、用define()函數定義的模塊。但是實際上,雖然已經有一部分流行的函數庫(比如jQuery)符合AMD規範,更多的庫並不符合。那麼,require.js是否能夠加載非規範的模塊呢?
回答是可以的。
這樣的模塊在用require()加載之前,要先用require.config()方法,定義它們的一些特徵。
舉例來說,jquery-ui和jquery-slide這兩個庫,都沒有采用AMD規範編寫。如果要加載它們的話,必須先定義它們的特徵。

shim: {
    'jquery.scroll': {
      deps: ['jquery']
    }
  }

7. 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文件。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章