開發一個完整的JavaScript元件

碼無痕發表於2015-02-11
JavaScript元件

作為一名開發者，大家應該都知道在瀏覽器中存在一些內建的控制元件：Alert，Confirm等，但是這些控制元件通常根據瀏覽器產商的不同而形態各異，視覺效果往往達不到UI設計師的要求。更重要的是，這類內建控制元件的風格很難與形形色色的各種風格迥異的網際網路產品的設計風格統一。因此，優秀的前端開發者們各自開發自己的個性化控制元件來替代瀏覽器內建的這些控制元件。當然，這類元件在網路上已經有不計其數相當優秀的，寫這篇文章的目的不是為了說明我開發的這個元件有多優秀，也不是為了炫耀什麼，只是希望通過這種方式，與更多的開發者互相交流，互相學習，共同進步。好，廢話不多說，言歸正傳。

功能介紹

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

效果預覽

1、Alert控制元件

2、Confirm控制元件

3、完整程式碼，線上預覽（見底部，提供壓縮包下載）

開發過程

1. 元件結構設計

首先，我們來看下內建元件的基本使用方法：

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

為了保證我們的元件使用方式和內建控制元件保持一致，所以我們必須考慮覆蓋內建控制元件。考慮到元件開發的風格統一，易用，易維護，以及物件導向等特性，我計劃將自定義的alert和confirm方法作為一個類（Winpop）的例項方法，最後用例項方法去覆蓋系統內建控制元件的方法。為了達到目的，我的基本做法如下：

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元件的使用方式也做了一些細微的調整，由內建返回布林值的方式，改為使用回撥函式的方式，以確保可以正確的新增“確定”和“取消”的邏輯。因此，自定義元件的使用方式就變成了下面這種形式：

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方法不是必須的，只是筆者的個人習慣而已，覺得這樣寫可以將配置引數和其他元件內部全域性變數快取和讀取的呼叫方式統一，似乎也更具有物件導向的型。歡迎讀者們說說各自的想法，說說這樣寫到底好不好。

接下來我們一起看下Winpop元件的完整程式碼：

  1 (function(window, jQuery, undefined) {
  2 
  3     var HTMLS = {
  4         ovl: '<div id="J_WinpopMask"></div>' + '<div id="J_WinpopBox">' + '<div></div>' + '<div></div>' + '</div>',
  5         alert: '<input type="button" value="確定">',
  6         confirm: '<input type="button" value="取消">' + '<input type="button" 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壓縮包，有興趣的讀者朋友，歡迎傳播。

相關文章