RequireJS 模組化程式設計詳解

1.模組的寫法

模組化程式設計一般都有這麼幾個過渡過程，如下描述。

原始方法

function m1(){
　　//...
}
function m2(){
　　//...
}

上面的函式m1()和m2()，組成一個模組。使用的時候，直接呼叫就行了。

這種做法的缺點很明顯：”汙染”了全域性變數，無法保證不與其他模組發生變數名衝突，而且模組成員之間看不出直接關係。

物件寫法

為了解決上面的缺點，可以把模組寫成一個物件，所有的模組成員都放到這個物件裡面。

var module1 = new Object({
　　　　_count : 0,
　　　　m1 : function (){
　　　　　　//...
　　　　},
　　　　m2 : function (){
　　　　　　//...
　　　　}
　　});

上面的函式m1()和m2(），都封裝在module1物件裡。使用的時候，就是呼叫這個物件的屬性。

module1.m1();

但是，這樣的寫法會暴露所有模組成員，內部狀態可以被外部改寫。比如，外部程式碼可以直接改變內部計數器的值。

module1._count = 5;

立即執行函式寫法

使用”立即執行函式”（Immediately-Invoked Function Expression，IIFE），可以達到不暴露私有成員的目的。

var module1 = (function(){
　　　　var _count = 0;
　　　　var m1 = function(){
　　　　　　//...
　　　　};
　　　　var m2 = function(){
　　　　　　//...
　　　　};
　　　　return {
　　　　　　m1 : m1,
　　　　　　m2 : m2
　　　　};
　　})();

使用上面的寫法，外部程式碼無法讀取內部的_count變數。

console.info(module1._count); //undefined

module1就是Javascript模組的基本寫法。下面，再對這種寫法進行加工。

放大模式

如果一個模組很大，必須分成幾個部分，或者一個模組需要繼承另一個模組，這時就有必要採用”放大模式”（augmentation）。

var module1 = (function (mod){
　　　　mod.m3 = function () {
　　　　　　//...
　　　　};
　　　　return mod;
　　})(module1);

上面的程式碼為module1模組新增了一個新方法m3()，然後返回新的module1模組。

寬放大模式（Loose augmentation）

在瀏覽器環境中，模組的各個部分通常都是從網上獲取的，有時無法知道哪個部分會先載入。如果採用上一節的寫法，第一個執行的部分有可能載入一個不存在空物件，這時就要採用”寬放大模式”。

var module1 = ( function (mod){
　　　　//...
　　　　return mod;
　　})(window.module1 || {});

與”放大模式”相比，＂寬放大模式＂就是”立即執行函式”的引數可以是空物件。

輸入全域性變數

獨立性是模組的重要特點，模組內部最好不與程式的其他部分直接互動。

為了在模組內部呼叫全域性變數，必須顯式地將其他變數輸入模組。

var module1 = (function ($, YAHOO) {
　　　　//...
　　})(jQuery, YAHOO);

上面的module1模組需要使用jQuery庫和YUI庫，就把這兩個庫（其實是兩個模組）當作引數輸入module1。這樣做除了保證模組的獨立性，還使得模組之間的依賴關係變得明顯。

2.AMD規範

2009年，美國程式設計師Ryan Dahl創造了node.js專案，將javascript語言用於伺服器端程式設計。

這標誌”JavaScript模組化程式設計”正式誕生。因為老實說，在瀏覽器環境下，沒有模組也不是特別大的問題，畢竟網頁程式的複雜性有限；但是在伺服器端，一定要有模組，與作業系統和其他應用程式互動，否則根本沒法程式設計。

node.js的模組系統，就是參照CommonJS規範實現的。在CommonJS中，有一個全域性性方法require()，用於載入模組。假定有一個數學模組math.js，就可以像下面這樣載入。

var math = require('math');

然後，就可以呼叫模組提供的方法：

var math = require('math');
　　math.add(2,3); // 5

因為這個系列主要針對瀏覽器程式設計，不涉及node.js，所以對CommonJS就不多做介紹了。我們在這裡只要知道，require()用於載入模組就行了。

有了伺服器端模組以後，很自然地，大家就想要客戶端模組。而且最好兩者能夠相容，一個模組不用修改，在伺服器和瀏覽器都可以執行。

但是，由於一個重大的侷限，使得CommonJS規範不適用於瀏覽器環境。還是上一節的程式碼，如果在瀏覽器中執行，會有一個很大的問題，你能看出來嗎？

var math = require('math');
　　math.add(2, 3);

第二行math.add(2, 3)，在第一行require(‘math’)之後執行，因此必須等math.js載入完成。也就是說，如果載入時間很長，整個應用就會停在那裡等。

這對伺服器端不是一個問題，因為所有的模組都存放在本地硬碟，可以同步載入完成，等待時間就是硬碟的讀取時間。但是，對於瀏覽器，這卻是一個大問題，因為模組都放在伺服器端，等待時間取決於網速的快慢，可能要等很長時間，瀏覽器處於”假死”狀態。

因此，瀏覽器端的模組，不能採用”同步載入”（synchronous），只能採用”非同步載入”（asynchronous）。這就是AMD規範誕生的背景。

AMD是”Asynchronous Module Definition”的縮寫，意思就是”非同步模組定義”。它採用非同步方式載入模組，模組的載入不影響它後面語句的執行。所有依賴這個模組的語句，都定義在一個回撥函式中，等到載入完成之後，這個回撥函式才會執行。

AMD也採用require()語句載入模組，但是不同於CommonJS，它要求兩個引數：

require([module], callback);

第一個引數[module]，是一個陣列，裡面的成員就是要載入的模組；第二個引數callback，則是載入成功之後的回撥函式。如果將前面的程式碼改寫成AMD形式，就是下面這樣：

require(['math'], function (math) {
　　　　math.add(2, 3);
　　});

math.add()與math模組載入不是同步的，瀏覽器不會發生假死。所以很顯然，AMD比較適合瀏覽器環境。

3.require.js的載入

<script 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。

require.config()的配置

使用require.config()方法，我們可以對模組的載入行為進行自定義。require.config()就寫在主模組（main.js）的頭部。引數就是一個物件，這個物件的paths屬性指定各個模組的載入路徑。

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

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檔案。

define()的完整定義：

define('sample3' ,['sample','sample1'],function (sample,sample1) {
    var sample4 = require('sample4');
    return function(){
        alert(sample.name+':'+sample.sayhell());
    }
});

關於define函式的name和require函式的依賴名稱之間的關係

1）define(name，[] , callback); 這個name可以省掉，預設是檔名稱；當然也可以自定義，一旦我們定義了name，根據原始碼我們可以發現define函式內部其實就是把這個name以及依賴模組、回撥函式作為一個物件儲存在全域性的陣列當中，也就是 defQueue.push([name,deps,callback])；那麼這個name就是這個元件註冊的的ID！

2）require（[name , name2],callback）; 系統首先會在全文檢索path中是否對應的路徑，如果沒有自然把他作為路徑拼接在baseUrl上去非同步載入這個js檔案，載入時從原始碼中可以看到 ,var data = getScriptData(evt)；返回的 data.id 其實就是name，然後執行contex.completeLoad(node.id)，其內部就很清楚了，把define中註冊的name和這裡得到的name進行比較如果相等就執行，所以道理就是：require 和 define 的 name 必須保證一致！

標籤載入完成之後，獲取標籤的唯一標識name

載入非規範的模組

舉例來說，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檔案。