天天看點

RequireJS子產品化程式設計詳解

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){ 

})(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'); 

然後,就可以調用子產品提供的方法:

math.add(2,3); // 5  

因為這個系列主要針對浏覽器程式設計,不涉及node.js,是以對commonjs就不多做介紹了。我們在這裡隻要知道,require()用于加載子產品就行了。

有了伺服器端子產品以後,很自然地,大家就想要用戶端子產品。而且最好兩者能夠相容,一個子產品不用修改,在伺服器和浏覽器都可以運作。

但是,由于一個重大的局限,使得commonjs規範不适用于浏覽器環境。還是上一節的代碼,如果在浏覽器中運作,會有一個很大的問題,你能看出來嗎?

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; 

add: add 

加載方法如下:

// main.js 

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

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

如果這個子產品還依賴其他子產品,那麼define()函數的第一個參數,必須是一個數組,指明該子產品的依賴性。

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

function foo(){ 

mylib.dosomething(); 

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規範編寫。如果要加載它們的話,必須先定義它們的特征。

shim: { 

'underscore':{ 

exports: '_' 

'backbone': { 

deps: ['underscore', 'jquery'], 

exports: 'backbone' 

require.config()接受一個配置對象,這個對象除了有前面說過的paths屬性之外,還有一個shim屬性,專門用來配置不相容的子產品。具體來說,每個子產品要定義(1)exports值(輸出的變量名),表明這個子產品外部調用時的名稱;(2)deps數組,表明該子產品的依賴性。

比如,jquery的插件可以這樣定義:

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

作者:風雨後見彩虹

來源:51cto

繼續閱讀