Javascript模組化工具requirejs教程

標籤：

轉自：http://www.w3cschool.cc/w3cnote/requirejs-tutorial-1.html, http://www.w3cschool.cc/w3cnote/requirejs-tutorial-2.html

隨著網站功能逐漸豐富，網頁中的js也變得越來越複雜和臃腫，原有通過script標籤來匯入一個個的js檔案這種方式已經不能滿足現在互連網開發模式，我們需要團隊協作、模組複用、單元測試等等一系列複雜的需求。

RequireJS是一個非常小巧的JavaScript模組載入架構，是AMD規範最好的實現者之一。最新版本的RequireJS壓縮後只有14K，堪稱非常輕量。它還同時可以和其他的架構協同工作，使用RequireJS必將使您的前端代碼品質得以提升。

requirejs能帶來什麼好處

官方對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.

大致意思：

在瀏覽器中可以作為js檔案的模組載入器，也可以用在Node和Rhino環境，balabala...。這段話描述了requirejs的準系統"模組化載入"，什麼是模組化載入？我們要從之後的篇幅中一一解釋

先來看一段常見的情境，通過樣本講解如何運用requirejs

正常編寫方式

index.html:

<!DOCTYPE html><html>    <head>        <script type="text/javascript" src="a.js"></script>    </head>    <body>      <span>body</span>    </body></html>

a.js:

function fun1(){  alert("it works");}fun1();

可能你更喜歡這樣寫

(function(){    function fun1(){      alert("it works");    }    fun1();})()

第二種方法使用了塊範圍來申明function防止汙染全域變數，本質還是一樣的，當運行上面兩種例子時不知道你是否注意到，alert執行的時候，html內容是一片空白的，即<span>body</span>並未被顯示，當點擊確定後，才出現，這就是JS阻塞瀏覽器渲染導致的結果。

requirejs寫法

當然首先要到requirejs的網站去下載js -> requirejs.rog
index.html:

<!DOCTYPE html><html>    <head>        <script type="text/javascript" src="require.js"></script>        <script type="text/javascript">            require(["a"]);        </script>    </head>    <body>      <span>body</span>    </body></html>

a.js:

define(function(){    function fun1(){      alert("it works");    }    fun1();})

 

瀏覽器提示了"it works"，說明運行正確，但是有一點不一樣，這次瀏覽器並不是一片空白，body已經出現在頁面中，目前為止可以知道requirejs具有如下優點：

1. 防止js載入阻塞頁面渲染
2. 使用程式調用的方式載入js，防出現如下醜陋的情境

<script type="text/javascript" src="a.js"></script><script type="text/javascript" src="b.js"></script><script type="text/javascript" src="c.js"></script><script type="text/javascript" src="d.js"></script><script type="text/javascript" src="e.js"></script><script type="text/javascript" src="f.js"></script><script type="text/javascript" src="g.js"></script><script type="text/javascript" src="h.js"></script><script type="text/javascript" src="i.js"></script><script type="text/javascript" src="j.js"></script>

 

前一篇：JS模組化工具requirejs教程(一)：初識requirejs 我們以非常簡單的方式引入了requirejs，這一篇將講述一下requirejs中的一些基本知識，包括API使用方式等。

基本API

require會定義三個變數：define,require,requirejs，其中require === requirejs，一般使用require更簡短

• define 從名字就可以看出這個api是用來定義一個模組
• require 載入相依模組，並執行載入完後的回呼函數

前一篇中的a.js：

define(function(){    function fun1(){      alert("it works");    }    fun1();})

通過define函數定義了一個模組，然後再頁面中使用：

require(["js/a"]);

來載入該模組(注意require中的依賴是一個數組，即使只有一個依賴，你也必須使用數組來定義)，requir API的第二個參數是callback，一個function，是用來處理載入完畢後的邏輯，如：

require(["js/a"],function(){    alert("load finished");})

負載檔案

之前的例子中載入模組都是本地js，但是大部分情況下網頁需要載入的JS可能來自本機伺服器、其他網站或CDN，這樣就不能通過這種方式來載入了，我們以載入一個jquery庫為例：

require.config({    paths : {        "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery"]       }})require(["jquery","js/a"],function($){    $(function(){        alert("load finished");      })})

這邊涉及了require.config，require.config是用來配置模組載入位置，簡單點說就是給模組起一個更短更好記的名字，比如將百度的jquery庫地址標記為jquery，這樣在require時只需要寫["jquery"]就可以載入該js，本地的js我們也可以這樣配置：

require.config({    paths : {        "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery"],        "a" : "js/a"       }})require(["jquery","a"],function($){    $(function(){        alert("load finished");      })})

通過paths的配置會使我們的模組名字更精鍊，paths還有一個重要的功能，就是可以配置多個路徑，如果遠程cdn庫沒有載入成功，可以載入本地的庫，如：

require.config({    paths : {        "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"],        "a" : "js/a"       }})require(["jquery","a"],function($){    $(function(){        alert("load finished");      })})

這樣配置後，當百度的jquery沒有載入成功後，會載入本地js目錄下的jquery

1. 在使用requirejs時，載入模組時不用寫.js尾碼的，當然也是不能寫尾碼
2. 上面例子中的callback函數中發現有$參數，這個就是依賴的jquery模組的輸出變數，如果你依賴多個模組，可以依次寫入多個參數來使用：

require(["jquery","underscore"],function($, _){    $(function(){        _.each([1,2,3],alert);    })})

如果某個模組不輸出變數值，則沒有，所以盡量將輸出的模組寫在前面，防止位置錯亂引發誤解

全域配置

上面的例子中重複出現了require.config配置，如果每個頁面中都加入配置，必然顯得十分不雅，requirejs提供了一種叫"主要資料"的功能，我們首先建立一個main.js：

require.config({    paths : {        "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"],        "a" : "js/a"       }})

然後再頁面中使用下面的方式來使用requirejs：

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

解釋一下，載入requirejs指令碼的script標籤加入了data-main屬性，這個屬性指定的js將在載入完reuqire.js後處理，我們把require.config的配置加入到data-main後，就可以使每一個頁面都使用這個配置，然後頁面中就可以直接使用require來載入所有的短模組名

data-main還有一個重要的功能，當script標籤指定data-main屬性時，require會預設的將data-main指定的js為根路徑，是什麼意思呢？如上面的data-main="js/main"設定後，我們在使用require([‘jquery‘])後(不配置jquery的paths)，require會自動載入js/jquery.js這個檔案，而不是jquery.js，相當於預設配置了：

require.config({    baseUrl : "js"})

第三方模組

通過require載入的模組一般都需要符合AMD規範即使用define來申明模組，但是部分時候需要載入非AMD規範的js，這時候就需要用到另一個功能：shim，shim解釋起來也比較難理解，shim直接翻譯為"墊"，其實也是有這層意思的，目前我主要用在兩個地方
1. 非AMD模組輸出，將非標準的AMD模組"墊"成可用的模組，例如：在老版本的jquery中，是沒有繼承AMD規範的，所以不能直接require["jquery"],這時候就需要shim，比如我要是用underscore類庫，但是他並沒有實現AMD規範，那我們可以這樣配置

require.config({    shim: {        "underscore" : {            exports : "_";        }    }})

這樣配置後，我們就可以在其他模組中引用underscore模組：

require(["underscore"], function(_){    _.each([1,2,3], alert);})

外掛程式形式的非AMD模組，我們經常會用到jquery外掛程式，而且這些外掛程式基本都不符合AMD規範，比如jquery.form外掛程式，這時候就需要將form外掛程式"墊"到jquery中：

require.config({    shim: {        "underscore" : {            exports : "_";        },        "jquery.form" : {            deps : ["jquery"]        }    }})

也可以簡寫為：

require.config({    shim: {        "underscore" : {            exports : "_";        },        "jquery.form" : ["jquery"]    }})

這樣配置之後我們就可以使用載入外掛程式後的jquery了

require.config(["jquery", "jquery.form"], function($){    $(function(){        $("#form").ajaxSubmit({...});    })})

好了，requirejs的基本配置大致就是這麼多，還有一些擴充的功能會在之後的篇幅中提到

文章來源：https://github.com/liuxey/blog/issues/2

 

Javascript模組化工具requirejs教程