開發一個完整的JavaScript組件

時間 2020-05-28

原文原文鏈接

做爲一名開發者，你們應該都知道在瀏覽器中存在一些內置的控件：Alert，Confirm等，可是這些控件一般根據瀏覽器產商的不一樣而形態萬千，視覺效果每每達不到UI設計師的要求。更重要的是，這類內置控件的風格很難與形形色色的各類風格迥異的互聯網產品的設計風格統一。所以，優秀的前端開發者們各自開發本身的個性化控件來替代瀏覽器內置的這些控件。固然，這類組件在網絡上已經有不可勝數至關優秀的，寫這篇文章的目的不是爲了說明我開發的這個組件有多優秀，也不是爲了炫耀什麼，只是但願經過這種方式，與更多的開發者互相交流，互相學習，共同進步。好，廢話很少說，言歸正傳。html

功能介紹

取代瀏覽器自帶的Alert、Confirm控件
自定義界面樣式
使用方式與內置控件基本保持一致

效果預覽

一、Alert控件前端

二、Confirm控件瀏覽器

三、完整代碼，在線預覽（見底部，提供壓縮包下載）緩存

開發過程

1. 組件結構設計

首先，咱們來看下內置組件的基本使用方法：網絡

1 alert("內置Alert控件");
2 if (confirm("關閉內置Confirm控件？")) {
3     alert("True");
4 } else {
5     alert("False");
6 }

爲了保證咱們的組件使用方式和內置控件保持一致，因此咱們必須考慮覆蓋內置控件。考慮到組件開發的風格統一，易用，易維護，以及面向對象等特性，我計劃將自定義的alert和confirm方法做爲一個類（Winpop）的實例方法，最後用實例方法去覆蓋系統內置控件的方法。爲了達到目的，個人基本作法以下：app

1 var obj = new Winpop(); // 建立一個Winpop的實例對象
2 // 覆蓋alert控件
3 window.alert = function(str) {
4     obj.alert.call(obj, str);
5 };
6 // 覆蓋confirm控件
7 window.confirm = function(str, cb) {
8     obj.confirm.call(obj, str, cb);
9 };

須要注意的是，因爲瀏覽器內置的控件能夠阻止瀏覽器的其餘行爲，而咱們自定義的組件並不能具有這種能力，爲了儘量的作到統一，正如預覽圖上看到的，咱們在彈出自定義組件的時候使用了一個全屏半透明遮罩層。也正是因爲上述緣由，confirm組件的使用方式也作了一些細微的調整，由內置返回布爾值的方式，改成使用回調函數的方式，以確保能夠正確的添加「肯定」和「取消」的邏輯。所以，自定義組件的使用方式就變成了下面這種形式：ide

1 alert("自定義Alert組件");
2 confirm("關閉自定義Confirm組件？", function(flag){
3     if (flag) {
4         alert("True");
5     } else {
6         alert("False");
7     }
8 });

2. 組件代碼設計

在正式介紹Winpop組件的代碼以前，咱們先來看一下一個Javascript組件的基本結構：函數

 1 (function(window, undefined) {
 2     function JsClassName(cfg) {
 3         var config = cfg || {};
 4         this.get = function(n) {
 5             return config[n];
 6         }
 7         this.set = function(n, v) {
 8             config[n] = v;
 9         }
10         this.init();
11     }
12     JsClassName.prototype = {
13         init: function(){},
14         otherMethod: function(){}
15     };
16     window.JsClassName = window.JsClassName || JsClassName;
17 })(window);

使用一個自執行的匿名函數將咱們的組件代碼包裹起來，儘量的減小全局污染，最後再將咱們的類附到全局window對象上，這是一種比較推薦的作法。學習

構造函數中的get、set方法不是必須的，只是筆者的我的習慣而已，以爲這樣寫能夠將配置參數和其餘組件內部全局變量緩存和讀取的調用方式統一，彷佛也更具備面向對象的型。歡迎讀者們說說各自的想法，說說這樣寫到底好很差。this

接下來咱們一塊兒看下Winpop組件的完整代碼：

  1 (function(window, jQuery, undefined) {
  2 
  3     var HTMLS = {
  4         ovl: '<div class="J_WinpopMask winpop-mask" id="J_WinpopMask"></div>' + '<div class="J_WinpopBox winpop-box" id="J_WinpopBox">' + '<div class="J_WinpopMain winpop-main"></div>' + '<div class="J_WinpopBtns winpop-btns"></div>' + '</div>',
  5         alert: '<input type="button" class="J_AltBtn pop-btn alert-button" value="肯定">',
  6         confirm: '<input type="button" class="J_CfmFalse pop-btn confirm-false" value="取消">' + '<input type="button" class="J_CfmTrue pop-btn confirm-true" value="肯定">'
  7     }
  8 
  9     function Winpop() {
 10         var config = {};
 11         this.get = function(n) {
 12             return config[n];
 13         }
 14 
 15         this.set = function(n, v) {
 16             config[n] = v;
 17         }
 18         this.init();
 19     }
 20 
 21     Winpop.prototype = {
 22         init: function() {
 23             this.createDom();
 24             this.bindEvent();
 25         },
 26         createDom: function() {
 27             var body = jQuery("body"),
 28                 ovl = jQuery("#J_WinpopBox");
 29 
 30             if (ovl.length === 0) {
 31                 body.append(HTMLS.ovl);
 32             }
 33 
 34             this.set("ovl", jQuery("#J_WinpopBox"));
 35             this.set("mask", jQuery("#J_WinpopMask"));
 36         },
 37         bindEvent: function() {
 38             var _this = this,
 39                 ovl = _this.get("ovl"),
 40                 mask = _this.get("mask");
 41             ovl.on("click", ".J_AltBtn", function(e) {
 42                 _this.hide();
 43             });
 44             ovl.on("click", ".J_CfmTrue", function(e) {
 45                 var cb = _this.get("confirmBack");
 46                 _this.hide();
 47                 cb && cb(true);
 48             });
 49             ovl.on("click", ".J_CfmFalse", function(e) {
 50                 var cb = _this.get("confirmBack");
 51                 _this.hide();
 52                 cb && cb(false);
 53             });
 54             mask.on("click", function(e) {
 55                 _this.hide();
 56             });
 57             jQuery(document).on("keyup", function(e) {
 58                 var kc = e.keyCode,
 59                     cb = _this.get("confirmBack");;
 60                 if (kc === 27) {
 61                     _this.hide();
 62                 } else if (kc === 13) {
 63                     _this.hide();
 64                     if (_this.get("type") === "confirm") {
 65                         cb && cb(true);
 66                     }
 67                 }
 68             });
 69         },
 70         alert: function(str, btnstr) {
 71             var str = typeof str === 'string' ? str : str.toString(),
 72                 ovl = this.get("ovl");
 73             this.set("type", "alert");
 74             ovl.find(".J_WinpopMain").html(str);
 75             if (typeof btnstr == "undefined") {
 76                 ovl.find(".J_WinpopBtns").html(HTMLS.alert);
 77             } else {
 78                 ovl.find(".J_WinpopBtns").html(btnstr);
 79             }
 80             this.show();
 81         },
 82         confirm: function(str, callback) {
 83             var str = typeof str === 'string' ? str : str.toString(),
 84                 ovl = this.get("ovl");
 85             this.set("type", "confirm");
 86             ovl.find(".J_WinpopMain").html(str);
 87             ovl.find(".J_WinpopBtns").html(HTMLS.confirm);
 88             this.set("confirmBack", (callback || function() {}));
 89             this.show();
 90         },
 91         show: function() {
 92             this.get("ovl").show();
 93             this.get("mask").show();
 94         },
 95         hide: function() {
 96             var ovl = this.get("ovl");
 97             ovl.find(".J_WinpopMain").html("");
 98             ovl.find(".J_WinpopBtns").html("");
 99             ovl.hide();
100             this.get("mask").hide();
101         },
102         destory: function() {
103             this.get("ovl").remove();
104             this.get("mask").remove();
105             delete window.alert;
106             delete window.confirm;
107         }
108     };
109 
110     var obj = new Winpop();
111     window.alert = function(str) {
112         obj.alert.call(obj, str);
113     };
114     window.confirm = function(str, cb) {
115         obj.confirm.call(obj, str, cb);
116     };
117 })(window, jQuery);

代碼略多，關鍵作如下幾點說明：

筆者偷了懶，使用了jQuery，使用以前請先保證已經引入了jQuery
自定義組件結構最終是追加到body中的，因此在引入以上js以前，請先確保文檔已經加載完成
組件添加了按ESC、點遮罩層隱藏組件功能
注意：雖然本例中未用到 destory 方法，但讀者朋友能夠注意一下該方法中的 delete window.alert 和 delete window.confirm ，這樣寫的目的是保證在自定義組件銷燬後，將Alert、Confirm控件恢復到瀏覽器內置效果
組件最後若是加上 window.Winpop = Winpop ，就能夠將對象全局化供其餘類調用了

最後

做爲一個前端開發工程師，我的以爲Javascript組件開發是一件頗有意思的事情，其中樂趣只有本身親自動手嘗試了纔會體會獲得。前端組件開發每每須要Javascript、CSS和html相互配合，才能事半功倍，上面提到的Winpop也不例外，這裏給你們提供一個完整的demo壓縮包，有興趣的讀者朋友，歡迎傳播。

做者博客：百碼山莊