javascript中UMD規(guī)范的代碼推演
1. UMD規(guī)范
地址:https://github.com/umdjs/umd
UMD規(guī)范,就是所有規(guī)范里長(zhǎng)得最丑的那個(gè),沒(méi)有之一?。?!它是為了讓模塊同時(shí)兼容AMD和CommonJs規(guī)范而出現(xiàn)的,多被一些需要同時(shí)支持瀏覽器端和服務(wù)端引用的第三方庫(kù)所使用。UMD是一個(gè)時(shí)代的產(chǎn)物,當(dāng)各種環(huán)境最終實(shí)現(xiàn)ES harmony的統(tǒng)一的規(guī)范后,它也將退出歷史舞臺(tái)。
UMD規(guī)范的結(jié)構(gòu)乍一看非常復(fù)雜,主要是因?yàn)橄胍炊@段范式需要一些javascript基礎(chǔ)知識(shí),它的基本結(jié)構(gòu)是這樣的:
(function (root, factory) { if (typeof define === 'function' && define.amd) { // AMD define(['jquery', 'underscore'], factory); } else if (typeof exports === 'object') { // Node, CommonJS之類(lèi)的 module.exports = factory(require('jquery'), require('underscore')); } else { // 瀏覽器全局變量(root 即 window) root.returnExports = factory(root.jQuery, root._); } }(this, function ($, _) { // 方法 function a(){}; // 私有方法,因?yàn)樗鼪](méi)被返回 (見(jiàn)下面) function b(){}; // 公共方法,因?yàn)楸环祷亓? function c(){}; // 公共方法,因?yàn)楸环祷亓? // 暴露公共方法 return { b: b, c: c } }));
2. 源碼范式推演
2.1 基本結(jié)構(gòu)
先來(lái)看最外層的結(jié)構(gòu):
(function (){}());
非常簡(jiǎn)單,就是一個(gè)自執(zhí)行函數(shù)。既然它是一個(gè)模塊化的標(biāo)準(zhǔn),也就意味著這個(gè)自執(zhí)行函數(shù)最終可以導(dǎo)出一個(gè)模塊,那么從代碼的角度來(lái)講實(shí)際上有兩種常見(jiàn)的實(shí)現(xiàn)方式:
- return返回一個(gè)模塊;
- 實(shí)參傳入一個(gè)對(duì)象,把函數(shù)內(nèi)部生成好的需要導(dǎo)出的東西掛在這個(gè)對(duì)象的屬性上;
可以看到上面的函數(shù)體內(nèi)部是沒(méi)有return語(yǔ)句的,那么可以猜測(cè)UMD在實(shí)現(xiàn)時(shí)是采用了第二種方式。既然UMD是一種模塊化的規(guī)范,那么它的功能就是根據(jù)使用要求生產(chǎn)模塊,也就是說(shuō)它的職責(zé)定位叫做模塊工廠,我們可以定義一個(gè)factory方法,每當(dāng)執(zhí)行該方法時(shí),就回返回一個(gè)模塊,所以它的基本結(jié)構(gòu)就變成了如下的樣子:
(function (factory){ //假設(shè)沒(méi)有使用任何模塊化方案,那么將工廠函數(shù)執(zhí)行后返回的內(nèi)容直接掛載到全局 window.Some_Attr = factory(); }(function(){ //自定義模塊主體的內(nèi)容 /* var a,b,c function a1(){} function b1(){} function c1(){} return { a:a1, b:b1 } */ }))
也就是說(shuō)我們自定義一個(gè)匿名函數(shù),然后把它當(dāng)做實(shí)參傳給了自執(zhí)行函數(shù),然后在自執(zhí)行函數(shù)內(nèi)部通過(guò)形參來(lái)訪問(wèn)這個(gè)工廠方法(或者你會(huì)更熟悉回調(diào)函數(shù)或callback這樣的叫法),把它簡(jiǎn)單地掛在到全局對(duì)象上,這樣就完成了基本的模塊導(dǎo)出。
有的時(shí)候我們也希望可以將模塊掛載到非全局的環(huán)境,將掛載對(duì)象動(dòng)態(tài)傳入可以讓代碼變得更靈活,此處涉及到一個(gè)基礎(chǔ)知識(shí),就是瀏覽器環(huán)境中的全局對(duì)象擁有parent,top,self三個(gè)屬性來(lái)追蹤頁(yè)面中嵌入<iframe>后引入的新的Window對(duì)象的,單頁(yè)面Window.self是指向自己的,代碼中常通過(guò)是否包含self屬性來(lái)鑒別全局對(duì)象,所以此處的寫(xiě)法可以改進(jìn)為兼容:
(function(root,factory){ root.Some_Attr = factory(); }(self !== undefined ? self : this, function(){ }));
2.2 適配AMD
接著我們先來(lái)加入AMD的規(guī)范的適配,規(guī)范地址:AMD規(guī)范github地址:https://github.com/amdjs/amdjs-api/blob/master/AMD.md
/* * AMD規(guī)范的模塊定義格式是define(id?, dependencies?, factory),factory就是實(shí)際的模塊內(nèi)容 */ (function (factory){ //判斷全局環(huán)境是否支持AMD標(biāo)準(zhǔn) if(typeof define === 'function' && define.amd){ //定義一個(gè)AMD模塊 define([/*denpendencies*/],factory); } }(function(/*formal parameters*/){ //自定義模塊主體的內(nèi)容 /* var a,b,c function a1(){} function b1(){} function c1(){} return { a:a1, b:b1 } */ }))
2.3 適配CommonJs
接著我們先來(lái)加入CommonJs的規(guī)范的適配:
/* * CommonJs規(guī)范使用require('moduleName')的格式來(lái)引用模塊,使用module.exports對(duì)象輸出模塊,所以只要把模塊的輸出內(nèi)容掛載到module.exports上就完成了模塊定義。 */ (function (factory){ //判斷全局環(huán)境是否支持CommonJs標(biāo)準(zhǔn) if(typeof exports === 'object' && typeof define !== 'function'){ module.exports = factory(/*require(moduleA), require(moduleB)*/); } }(function(/*formal parameters*/){ //自定義模塊主體的內(nèi)容 /* var a,b,c function a1(){} function b1(){} function c1(){} return { a:a1, b:b1 } */ }))
加入對(duì)CommonJs的適配后,函數(shù)主體中return的內(nèi)容(一般是一個(gè)對(duì)象)就被掛載到了module.exports上,如果你編寫(xiě)過(guò)node.js代碼,對(duì)此一定不會(huì)陌生。
把上面的片段揉到一塊,你也就看懂UMD的樣子了。
3. 更具針對(duì)性的UMD范式
UMD在其github主頁(yè)上提供了更具針對(duì)性的范式,適用于不同的場(chǎng)景,感興趣的讀者可以自行查看(地址在第一節(jié)已經(jīng)給出)。
在此貼一個(gè)可能對(duì)大多數(shù)開(kāi)發(fā)者比較有用的jqueryPlugin的開(kāi)發(fā)范式,如果看懂了上面的分析,那么下面的代碼應(yīng)該不難看懂:
// Uses CommonJS, AMD or browser globals to create a jQuery plugin. (function (factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. define(['jquery'], factory); } else if (typeof module === 'object' && module.exports) { // Node/CommonJS module.exports = function( root, jQuery ) { if ( jQuery === undefined ) { // require('jQuery') returns a factory that requires window to // build a jQuery instance, we normalize how we use modules // that require this pattern but the window provided is a noop // if it's defined (how jquery works) if ( typeof window !== 'undefined' ) { jQuery = require('jquery'); } else { jQuery = require('jquery')(root); } } factory(jQuery); return jQuery; }; } else { // Browser globals factory(jQuery); } }(function ($) { $.fn.jqueryPlugin = function () { return true; }; }));
4. 模塊化開(kāi)發(fā)
前端模塊化本身是一個(gè)稍顯混亂的話題,筆者自己最初也是require( )和require.js傻傻分不清楚,但模塊化是前端開(kāi)發(fā)中非常重要的課題,如果你不想一輩子只是在一個(gè)頁(yè)面內(nèi)寫(xiě)代碼,這一關(guān)是一定要過(guò)的,感興趣的讀者可以按照下面的基本類(lèi)別劃分分塊進(jìn)行學(xué)習(xí)。
相關(guān)文章
JS實(shí)現(xiàn)電腦虛擬鍵盤(pán)打字測(cè)試
這篇文章主要為大家詳細(xì)介紹了JS實(shí)現(xiàn)電腦虛擬鍵盤(pán)打字測(cè)試,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2020-06-06用JS實(shí)現(xiàn)一個(gè)簡(jiǎn)單的打磚塊游戲
這篇文章主要介紹了用JS實(shí)現(xiàn)一個(gè)簡(jiǎn)單的打磚塊游戲,代碼分為html+css+js三部分,具體實(shí)例代碼感興趣的朋友跟隨小編一起看看吧2019-12-12使用requestAnimationFrame實(shí)現(xiàn)js動(dòng)畫(huà)性能好
requestAnimationFrame優(yōu)于setTimeout/setInterval的地方在于它是由瀏覽器專(zhuān)門(mén)為動(dòng)畫(huà)提供的API,在運(yùn)行時(shí)瀏覽器會(huì)自動(dòng)優(yōu)化方法的調(diào)用,并且如果頁(yè)面不是激活狀態(tài)下的話,動(dòng)畫(huà)會(huì)自動(dòng)暫停,有效節(jié)省了CPU開(kāi)銷(xiāo),這篇文章給大家詳細(xì)介紹使用requestAnimationFrame實(shí)現(xiàn)js動(dòng)畫(huà)2015-08-08