1.模塊的寫法 模塊化編程一般都有這麼幾個過渡過程,如下描述。 原始方法 上面的函數m1()和m2(),組成一個模塊。使用的時候,直接調用就行了。 這種做法的缺點很明顯:"污染"了全局變數,無法保證不與其他模塊發生變數名衝突,而且模塊成員之間看不出直接關係。 對象寫法 為瞭解決上面的缺點,可以把模塊 ...
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文件。
參考地址:
Javascript模塊化編程(三):require.js的用法