RequireJS模塊化編程詳解
1.模塊的寫法
模塊化編程一般都有這么幾個(gè)過渡過程，如下描述。
原始方法
- function m1(){
- //...
- }
- function m2(){
- //...
- }
上面的函數(shù)m1()和m2()，組成一個(gè)模塊。使用的時(shí)候，直接調(diào)用就行了。
這種做法的缺點(diǎn)很明顯："污染"了全局變量，無法保證不與其他模塊發(fā)生變量名沖突，而且模塊成員之間看不出直接關(guān)系。
對象寫法
為了解決上面的缺點(diǎn)，可以把模塊寫成一個(gè)對象，所有的模塊成員都放到這個(gè)對象里面。
- var module1 = new Object({
- _count : 0,
- m1 : function (){
- //...
- },
- m2 : function (){
- //...
- }
- });
上面的函數(shù)m1()和m2()，都封裝在module1對象里。使用的時(shí)候，就是調(diào)用這個(gè)對象的屬性。
- module1.m1();
但是，這樣的寫法會(huì)暴露所有模塊成員，內(nèi)部狀態(tài)可以被外部改寫。比如，外部代碼可以直接改變內(nèi)部計(jì)數(shù)器的值。
- module1._count = 5;
立即執(zhí)行函數(shù)寫法
使用"立即執(zhí)行函數(shù)"(Immediately-Invoked Function Expression，IIFE)，可以達(dá)到不暴露私有成員的目的。
- var module1 = (function(){
- var _count = 0;
- var m1 = function(){
- //...
- };
- var m2 = function(){
- //...
- };
- return {
- m1 : m1,
- m2 : m2
- };
- })();
使用上面的寫法，外部代碼無法讀取內(nèi)部的_count變量。
- console.info(module1._count); //undefined
module1就是Javascript模塊的基本寫法。下面，再對這種寫法進(jìn)行加工。
放大模式
如果一個(gè)模塊很大，必須分成幾個(gè)部分，或者一個(gè)模塊需要繼承另一個(gè)模塊，這時(shí)就有必要采用"放大模式"(augmentation)。
- var module1 = (function (mod){
- mod.m3 = function () {
- //...
- };
- return mod;
- })(module1);
上面的代碼為module1模塊添加了一個(gè)新方法m3()，然后返回新的module1模塊。
寬放大模式(Loose augmentation)
在瀏覽器環(huán)境中，模塊的各個(gè)部分通常都是從網(wǎng)上獲取的，有時(shí)無法知道哪個(gè)部分會(huì)先加載。如果采用上一節(jié)的寫法，***個(gè)執(zhí)行的部分有可能加載一個(gè)不存在空對象，這時(shí)就要采用"寬放大模式"。
- var module1 = ( function (mod){
- //...
- return mod;
- })(window.module1 || {});
與"放大模式"相比，"寬放大模式"就是"立即執(zhí)行函數(shù)"的參數(shù)可以是空對象。
輸入全局變量
獨(dú)立性是模塊的重要特點(diǎn)，模塊內(nèi)部***不與程序的其他部分直接交互。
為了在模塊內(nèi)部調(diào)用全局變量，必須顯式地將其他變量輸入模塊。
- var module1 = (function ($, YAHOO) {
- //...
- })(jQuery, YAHOO);
上面的module1模塊需要使用jQuery庫和YUI庫，就把這兩個(gè)庫(其實(shí)是兩個(gè)模塊)當(dāng)作參數(shù)輸入module1。這樣做除了保證模塊的獨(dú)立性，還使得模塊之間的依賴關(guān)系變得明顯。
2.AMD規(guī)范
2009年，美國程序員Ryan Dahl創(chuàng)造了node.js項(xiàng)目，將javascript語言用于服務(wù)器端編程。
這標(biāo)志"Javascript模塊化編程"正式誕生。因?yàn)槔蠈?shí)說，在瀏覽器環(huán)境下，沒有模塊也不是特別大的問題，畢竟網(wǎng)頁程序的復(fù)雜性有限;但是在服務(wù)器端，一定要有模塊，與操作系統(tǒng)和其他應(yīng)用程序互動(dòng)，否則根本沒法編程。
node.js的模塊系統(tǒng)，就是參照CommonJS規(guī)范實(shí)現(xiàn)的。在CommonJS中，有一個(gè)全局性方法require()，用于加載模塊。假定有一個(gè)數(shù)學(xué)模塊math.js，就可以像下面這樣加載。
- var math = require('math');
然后，就可以調(diào)用模塊提供的方法：
- var math = require('math');
- math.add(2,3); // 5
因?yàn)檫@個(gè)系列主要針對瀏覽器編程，不涉及node.js，所以對CommonJS就不多做介紹了。我們在這里只要知道，require()用于加載模塊就行了。
有了服務(wù)器端模塊以后，很自然地，大家就想要客戶端模塊。而且***兩者能夠兼容，一個(gè)模塊不用修改，在服務(wù)器和瀏覽器都可以運(yùn)行。
但是，由于一個(gè)重大的局限，使得CommonJS規(guī)范不適用于瀏覽器環(huán)境。還是上一節(jié)的代碼，如果在瀏覽器中運(yùn)行，會(huì)有一個(gè)很大的問題，你能看出來嗎?
- var math = require('math');
- math.add(2, 3);
第二行math.add(2, 3)，在***行require('math')之后運(yùn)行，因此必須等math.js加載完成。也就是說，如果加載時(shí)間很長，整個(gè)應(yīng)用就會(huì)停在那里等。
這對服務(wù)器端不是一個(gè)問題，因?yàn)樗械哪K都存放在本地硬盤，可以同步加載完成，等待時(shí)間就是硬盤的讀取時(shí)間。但是，對于瀏覽器，這卻是一個(gè)大問題，因?yàn)槟K都放在服務(wù)器端，等待時(shí)間取決于網(wǎng)速的快慢，可能要等很長時(shí)間，瀏覽器處于"假死"狀態(tài)。
因此，瀏覽器端的模塊，不能采用"同步加載"(synchronous)，只能采用"異步加載"(asynchronous)。這就是AMD規(guī)范誕生的背景。
AMD是"Asynchronous Module Definition"的縮寫，意思就是"異步模塊定義"。它采用異步方式加載模塊，模塊的加載不影響它后面語句的運(yùn)行。所有依賴這個(gè)模塊的語句，都定義在一個(gè)回調(diào)函數(shù)中，等到加載完成之后，這個(gè)回調(diào)函數(shù)才會(huì)運(yùn)行。
AMD也采用require()語句加載模塊，但是不同于CommonJS，它要求兩個(gè)參數(shù)：
- require([module], callback);
***個(gè)參數(shù)[module]，是一個(gè)數(shù)組，里面的成員就是要加載的模塊;第二個(gè)參數(shù)callback，則是加載成功之后的回調(diào)函數(shù)。如果將前面的代碼改寫成AMD形式，就是下面這樣：
- require(['math'], function (math) {
- math.add(2, 3);
- });
math.add()與math模塊加載不是同步的，瀏覽器不會(huì)發(fā)生假死。所以很顯然，AMD比較適合瀏覽器環(huán)境。
3.require.js的加載
- <script src="js/require.js"></script>
有人可能會(huì)想到，加載這個(gè)文件，也可能造成網(wǎng)頁失去響應(yīng)。解決辦法有兩個(gè)，一個(gè)是把它放在網(wǎng)頁底部加載，另一個(gè)是寫成下面這樣：
- <script src="js/require.js" defer async="true" ></script>
async屬性表明這個(gè)文件需要異步加載，避免網(wǎng)頁失去響應(yīng)。IE不支持這個(gè)屬性，只支持defer，所以把defer也寫上。
加載require.js以后，下一步就要加載我們自己的代碼了。假定我們自己的代碼文件是main.js，也放在js目錄下面。那么，只需要寫成下面這樣就行了：
- <script src="js/require.js" data-main="js/main"></script>
data-main屬性的作用是，指定網(wǎng)頁程序的主模塊。在上例中，就是js目錄下面的main.js，這個(gè)文件會(huì)***個(gè)被require.js加載。由于require.js默認(rèn)的文件后綴名是js，所以可以把main.js簡寫成main。
require.config()的配置
使用require.config()方法，我們可以對模塊的加載行為進(jìn)行自定義。require.config()就寫在主模塊(main.js)的頭部。參數(shù)就是一個(gè)對象，這個(gè)對象的paths屬性指定各個(gè)模塊的加載路徑。
- require.config({
- baseUrl: "js/lib",
- paths: {
- "jquery": "jquery.min",
- "underscore": "underscore.min",
- "backbone": "backbone.min"
- }
- });
AMD模塊的寫法
模塊必須采用特定的define()函數(shù)來定義。如果一個(gè)模塊不依賴其他模塊，那么可以直接定義在define()函數(shù)之中。
假定現(xiàn)在有一個(gè)math.js文件，它定義了一個(gè)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));
- });
如果這個(gè)模塊還依賴其他模塊，那么define()函數(shù)的***個(gè)參數(shù)，必須是一個(gè)數(shù)組，指明該模塊的依賴性。
- define(['myLib'], function(myLib){
- function foo(){
- myLib.doSomething();
- }
- return {
- foo : foo
- };
- });
當(dāng)require()函數(shù)加載上面這個(gè)模塊的時(shí)候，就會(huì)先加載myLib.js文件。
define()的完整定義：
- define('sample3' ,['sample','sample1'],function (sample,sample1) {
- var sample4 = require('sample4');
- return function(){
- alert(sample.name+':'+sample.sayhell());
- }
- });
關(guān)于define函數(shù)的name和require函數(shù)的依賴名稱之間的關(guān)系
1)define(name，[] , callback); 這個(gè)name可以省掉，默認(rèn)是文件名稱;當(dāng)然也可以自定義，一旦我們定義了name，根據(jù)源代碼我們可以發(fā)現(xiàn)define函數(shù)內(nèi)部其實(shí)就是把這個(gè)name以及依賴模塊、回調(diào)函數(shù)作為一個(gè)對象存儲(chǔ)在全局的數(shù)組當(dāng)中，也就是 defQueue.push([name,deps,callback]);那么這個(gè)name就是這個(gè)組件注冊的的ID!
2)require([name , name2],callback); 系統(tǒng)首先會(huì)在全文檢索path中是否對應(yīng)的路徑，如果沒有自然把他作為路徑拼接在baseUrl上去異步加載這個(gè)js文件，加載時(shí)從源代碼中可以看到 ,var data = getScriptData(evt);返回的 data.id 其實(shí)就是name，然后執(zhí)行contex.completeLoad(node.id)，其內(nèi)部就很清楚了，把define中注冊的name和這里得到的name進(jìn)行比較如果相等就執(zhí)行，所以道理就是：require 和 define 的 name 必須保證一致!
標(biāo)簽加載完成之后，獲取標(biāo)簽的唯一標(biāo)識name
加載非規(guī)范的模塊
舉例來說，underscore和backbone這兩個(gè)庫，都沒有采用AMD規(guī)范編寫。如果要加載它們的話，必須先定義它們的特征。
- require.config({
- shim: {
- 'underscore':{
- exports: '_'
- },
- 'backbone': {
- deps: ['underscore', 'jquery'],
- exports: 'Backbone'
- }
- }
- });
require.config()接受一個(gè)配置對象，這個(gè)對象除了有前面說過的paths屬性之外，還有一個(gè)shim屬性，專門用來配置不兼容的模塊。具體來說，每個(gè)模塊要定義(1)exports值(輸出的變量名)，表明這個(gè)模塊外部調(diào)用時(shí)的名稱;(2)deps數(shù)組，表明該模塊的依賴性。
比如，jQuery的插件可以這樣定義：
- shim: {
- 'jquery.scroll': {
- deps: ['jquery'],
- exports: 'jQuery.fn.scroll'
- }
- }
require.js插件
require.js還提供一系列插件，實(shí)現(xiàn)一些特定的功能。
domready插件，可以讓回調(diào)函數(shù)在頁面DOM結(jié)構(gòu)加載完成后再運(yùn)行。
- 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文件。
參考地址：
