requirejs是一個JavaScript檔案和模組載入器。 requireJS允許你把你的javascript程式碼獨立成檔案和模組,同時管理每個模組間的依賴關係。
RequireJS的目標是鼓勵程式碼的模組化,它使用了不同於傳統"script"標籤的腳本載入步驟。使用RequireJS載入模組化腳本將提高程式碼的載入速度和品質。
一、為什麼要用require.js?
最早的時候,所有Javascript程式碼都寫在一個檔案裡面,只要載入這份檔案就夠了。後來,程式碼越來越多,一個文件不夠了,必須分成多個文件,依序載入。下面的網頁程式碼,相信很多人都看過:
<script src="1.js"></script> <script src="2.js"></script> <script src="3.js"></script> <script src="4.js"></script> <script src="5.js"></script> <script src="6.js"></script>
這段程式碼依序載入多個js檔案。
這樣的寫法有很大的缺點。
首先,載入的時候,瀏覽器會停止網頁渲染,載入檔案越多,網頁失去回應的時間就會越長
由於js檔案之間存在依賴關係,因此必須嚴格保證載入順序(例如上例的1.js要在2.js的前面),依賴性最大的模組一定要放到最後加載,當依賴關係很複雜的時候,程式碼的編寫和維護都會變得困難。
require.js的誕生,就是為了解決這兩個問題:
實作js檔案的非同步加載,避免網頁失去回應;
管理模組之間的依賴性,便於程式碼的編寫和維護。
二、require.js的載入
使用require.js的第一步,是先去官方網站下載最新版本。
下載後,假定把它放在js子目錄下面,就可以載入了。
有人可能會想到,載入這個文件,也可能造成網頁失去回應。解決方法有兩個:
一個是把它放在網頁底部加載,另一個是寫成下面這樣:
async屬性顯示這個檔案需要非同步加載,避免網頁失去回應。 IE不支援這個屬性,只支援defer,所以把defer也寫上。
載入require.js以後,下一步就要載入我們自己的程式碼了。假定我們自己的程式碼檔案是main.js,也放在js目錄下面。那麼,只要寫成下面這樣就行了:
data-main屬性的作用是,指定網頁程式的主模組。
在上例中,就是js目錄下面的main.js,這個檔案會第一個被require.js載入。由於require.js預設的檔案後綴名是js,所以可以把main.js簡寫成main。
三、主模組的寫法
上一節的main.js,我稱它為"主模組",意思是整個網頁的入口程式碼。它有點像C語言的main()函數,所有程式碼都從這裡開始運作。
下面就來看,怎麼寫main.js。
如果我們的程式碼不依賴任何其他模組,那麼可以直接寫入javascript程式碼。
// main.js alert("加载成功!"); 但这样的话,就没必要使用require.js了。真正常见的情况是,主模块依赖于其他模块,这时就要使用AMD规范定义的的require()函数。 // main.js require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){ // some code here });
require()函數接受兩個參數。第一個參數:
一個數組,表示所依賴的模組,上例就是['moduleA', 'moduleB', 'moduleC'],即主模組依賴這三個模組;
一個回調函數,當前面指定的模組都載入成功後,它將被呼叫。載入的模組會以參數形式傳入該函數,從而在回呼函數內部就可以使用這些模組。
require()非同步載入moduleA,moduleB和moduleC,瀏覽器不會失去回應;它指定的回呼函數,只有前面的模組都載入成功後,才會運行,解決了依賴性的問題。
下面,我們來看一個實際的例子。
假定主模組依賴jquery、underscore和backbone這三個模組,main.js就可以這樣寫:
require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){ // some code here });
require.js會先載入jQuery、underscore和backbone,然後再執行回呼函數。主模組的程式碼就寫在回調函數中。
四、模組的載入
上一節最後的範例中,主模組的依賴模組是['jquery', 'underscore', 'backbone']。預設情況下,require.js假定這三個模組與main.js在同一個目錄,檔案名稱分別為jquery.js,underscore.js和backbone.js,然後自動載入。
使用require.config()方法,我們可以對模組的載入行為進行自訂。 require.config()就寫在主模組(main.js)的頭部。參數就是一個對象,這個對象的paths屬性指定各個模組的載入路徑。
require.config({ paths: { "jquery": "jquery.min", "underscore": "underscore.min", "backbone": "backbone.min" } });
上面的程式碼給了三個模組的檔名,路徑預設與main.js在同一個目錄(js子目錄)。如果這些模組在其他目錄,例如js/lib目錄,則有兩種寫入方法。
一種是逐一指定路徑。
require.config({ baseUrl: "js/lib", paths: {"jquery": "jquery.min", "underscore": "underscore.min", "backbone": "backbone.min"} });
另一種則是直接改變基底目錄(baseUrl)。
require.config({ baseUrl: "js/lib", paths: { "jquery": "jquery.min", "underscore": "underscore.min", "backbone": "backbone.min" } });
如果某個模組在另一台主機上,也可以直接指定它的網址,例如:
require.config({ paths: { "jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min" } });
require.js要求:
每个模块是一个单独的js文件。这样的话,如果加载多个模块,就会发出多次HTTP请求,会影响网页的加载速度。因此,require.js提供了一个优化工具,当模块部署完毕以后,可以用这个工具将多个模块合并在一个文件中,减少HTTP请求数。
五、AMD模块的写法
require.js加载的模块,采用AMD规范。也就是说,模块必须按照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文件。
六、加载非规范的模块
理论上,require.js加载的模块,必须是按照AMD规范、用define()函数定义的模块。但是实际上,虽然已经有一部分流行的函数库(比如jQuery)符合AMD规范,更多的库并不符合。那么,require.js是否能够加载非规范的模块呢?
回答是可以的。
这样的模块在用require()加载之前,要先用require.config()方法,定义它们的一些特征。
举例来说,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文件。
以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,同时也希望多多支持PHP中文网!
更多浅析js的模块化编写 require.js相关文章请关注PHP中文网!