最近我打算把之前做項目寫的一些工具集成到一個js庫中,但是庫既要在普通環境正常運行,又要在AMD環境下不暴露全局變量。一時間挺頭疼的。隨即我參考了一些現在流行的庫的源碼。學着寫了一下,感覺還不錯。
既然要支持AMD,那么我們需要選擇一款AMD的模塊加載器,這里我使用requireJS。
至於庫我使用的是我最近寫的一個小工具庫 mTools, gitHub地址: https://github.com/grARM/mTools 。那我們開始吧。
一、判斷環境
我要實現的效果是在一般環境暴露一個全局變量,在AMD下可作為模塊加載。既然要區別對待,就要先判斷出不同的環境。那么AMD環境有什么特點呢?
使用過requireJS的盆友,一定很熟悉define(),我們就是用define()來定義一個模塊的,所以我們有了第一個條件:
typeof define === "function"
但是僅僅因為define是個函數,是不是不夠嚴密呢,萬一我也定義了一個同名的全局函數怎么辦。我們創建一個requireJS的項目,在控制台輸入 define.amd ,控制台會返回一個對象,其實他是define方法的一個屬性,查了一下requireJS的官網,發現這個屬性就是用來說明當前的模塊加載器是AMD協議的,比如在我們的require工程中控制台輸入define.cmd就會返回 undefined 也就是說我們得到了第二個判斷條件:
if ( typeof define === "function" && define.amd ){ }
二、分別處理
我的工具模塊,可以理解為一個函數,這個函數的最后會把需要被外界訪問的部分屬性return 出去。那么被return的這個對象,就是普通模塊中暴露在全局的變量,同時他也是AMD中的模塊返回值。換句話說,我只要根據上面的條件處理返回值(或模塊函數)就實現了我們的目的。那么怎么處理呢?
對於一般環境,我們直接將模塊函數運行后端的返回值賦值給一個window下的變量就可以了。
對於AMD環境下,剛才我們說過要用define來定義函數。所以對於這兩種情況我們可以這樣處理:
1 ;(function (factory){ 2 if ( typeof define === "function" && define.amd ) { 3 4 // AMD. Register as an anonymous module. 5 define(factory); 6 } else { 7 8 // Browser globals 9 // 以我的庫為例 返回mTools 10 window.mTools = factory(); 11 } 12 })(function(){ 13 我們的js庫 14 return { 15 //模塊返回值 16 } 17 18 });
注意,我們將js庫函數作為立即執行函數的參數傳入我們的分析函數,即為factory(未執行),如果AMD環境,就定義為AMD模塊;如果是一般環境,就直接運行將返回值賦值給 window.mTools
隨即我測試了一下,確實在一般環境暴露一個全局變量,在AMD下可作為模塊加載(沒有暴露全局)。