如何編寫一個JS庫

編寫js/jQuery插件有一些約定俗成的套路枪萄,根據(jù)這些套路依葫蘆畫瓢脏答,代碼的結(jié)構(gòu)上就不會出現(xiàn)太大的問題了,特別推薦這個叫 javascript-patterns 的項目,一些demo讓我收獲良多局嘁。

基本結(jié)構(gòu)

普通的庫

用最基本的匿名函數(shù)實現(xiàn)即可

(function(){
    var root = this;
    root.YOURLIB = function(){
        FUNC1 : function(){},
        FUNC2 : function(){}
    }
}())

也可以使用call而不是使用閉包涯肩,此時兩種寫法等效贺奠,undersocre.js用的是call寫法

(function(){
    var root = this;
    root.YOURLIB = function(){
        FUNC1 : function(){},
        FUNC2 : function(){}
    }
}.call(this))

jQuery 插件###

通過一下方法可以使的插件可以 跨CMD/AMD/Browser

(function (factory) {
    if (typeof define === 'function' && define.amd) {
        // AMD
        define(['jquery'], factory);
    } else if (typeof exports === 'object') {
        // CommonJS
        factory(require('jquery'));
    } else {
        // Browser globals
        factory(jQuery);
    }
}(function ($) {

    $.fn.render = function() {}
    $.render2 = function() {}
}))

當然,如果不考慮Seajs,RequireJS的話,最方便的還是使用匿名函數(shù)竣稽,然后把window.jQuery當成參數(shù)傳進去

內(nèi)部組織

我們以 bootstrap-select v1.6.3,smooth-scroll這倆項目來進行分析撩穿,

初始化###

一般的Library都會提供一套defaults配置文件试吁,然后使用的時候和用戶自定義的settings進行extend, smooth-scroll中的那種

settings = extend(defaults, options ||{})); 寫法就相當贊棺棵,可以以一種十分簡單的方式防止空指針異常

剩下的就是根據(jù)業(yè)務劃分業(yè)務的funciton了熄捍,對于如何劃分烛恤,只有多加練習了。

另外余耽,在注釋里像寫上 privatepublic 來區(qū)分對外接口和對內(nèi)接口是個不錯的習慣缚柏。

i18n與配置管理###

i18n是吧那些國際話的字符全都放到defautls,比較優(yōu)雅的做法是defaults定義一個對象碟贾,這樣國際化文件
便能和原有的庫文件進行分離币喧,具體參考 bootstrap-datapicker

THE END

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市缕陕,隨后出現(xiàn)的幾起案子粱锐,更是在濱河造成了極大的恐慌,老刑警劉巖扛邑,帶你破解...
    沈念sama閱讀 212,686評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件怜浅,死亡現(xiàn)場離奇詭異,居然都是意外死亡蔬崩,警方通過查閱死者的電腦和手機恶座,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,668評論 3 385
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來沥阳,“玉大人跨琳,你說我怎么就攤上這事⊥┖保” “怎么了脉让?”我有些...
    開封第一講書人閱讀 158,160評論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長功炮。 經(jīng)常有香客問我溅潜,道長,這世上最難降的妖魔是什么薪伏? 我笑而不...
    開封第一講書人閱讀 56,736評論 1 284
  • 正文 為了忘掉前任滚澜,我火速辦了婚禮,結(jié)果婚禮上嫁怀,老公的妹妹穿的比我還像新娘设捐。我一直安慰自己借浊,他們只是感情好,可當我...
    茶點故事閱讀 65,847評論 6 386
  • 文/花漫 我一把揭開白布萝招。 她就那樣靜靜地躺著蚂斤,像睡著了一般。 火紅的嫁衣襯著肌膚如雪即寒。 梳的紋絲不亂的頭發(fā)上橡淆,一...
    開封第一講書人閱讀 50,043評論 1 291
  • 那天,我揣著相機與錄音母赵,去河邊找鬼逸爵。 笑死,一個胖子當著我的面吹牛凹嘲,可吹牛的內(nèi)容都是我干的师倔。 我是一名探鬼主播,決...
    沈念sama閱讀 39,129評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼周蹭,長吁一口氣:“原來是場噩夢啊……” “哼趋艘!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起凶朗,我...
    開封第一講書人閱讀 37,872評論 0 268
  • 序言:老撾萬榮一對情侶失蹤瓷胧,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后棚愤,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體搓萧,經(jīng)...
    沈念sama閱讀 44,318評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,645評論 2 327
  • 正文 我和宋清朗相戀三年宛畦,在試婚紗的時候發(fā)現(xiàn)自己被綠了瘸洛。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,777評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡次和,死狀恐怖反肋,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情踏施,我是刑警寧澤石蔗,帶...
    沈念sama閱讀 34,470評論 4 333
  • 正文 年R本政府宣布,位于F島的核電站畅形,受9級特大地震影響抓督,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜束亏,卻給世界環(huán)境...
    茶點故事閱讀 40,126評論 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望阵具。 院中可真熱鬧碍遍,春花似錦定铜、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,861評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至东跪,卻和暖如春畸陡,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背虽填。 一陣腳步聲響...
    開封第一講書人閱讀 32,095評論 1 267
  • 我被黑心中介騙來泰國打工丁恭, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人斋日。 一個月前我還...
    沈念sama閱讀 46,589評論 2 362
  • 正文 我出身青樓牲览,卻偏偏與公主長得像,于是被迫代替她去往敵國和親恶守。 傳聞我的和親對象是個殘疾皇子第献,可洞房花燭夜當晚...
    茶點故事閱讀 43,687評論 2 351

推薦閱讀更多精彩內(nèi)容