DIV CSS 佈局教程網

關於JavaScript插件開發的一些心得與思考
編輯:關於JavaScript     

起因

做過前端開發的人應該都有這樣的體會:當頁面需要某種效果或插件時,我們通常有兩種選擇——一是上網找現成的JS插件來學用法,二是自己造輪子開發插件。

尋找現成的插件

第一種做法如果剛好找到符合需求的插件,那是非常幸運的事。但大部分情況下,找到的插件會有以下幾個問題:

(1)UI定制:很多插件提供的UI和我們的專案設計風格完全不搭,甚至得反過來改動既有HTML和CSS去適應插件。

(2)學習成本:較複雜的插件存在學習成本,得先搞懂它怎麼用。

(3)不符合需求:找到的插件未必完全符合專案需求,可能得改它的程式碼來支援。

(4)功能太大而全:假如只需要一個簡單輪播,卻找到一個功能繁多、體積堪比一個JS庫的輪播插件,而自己寫其實幾十行就能搞定,這時引入它是否太過多餘。

當然並非完全不用現成插件,畢竟有些插件經過時間考驗,用起來更有利於專案推進。如果是下面幾種情況,我會考慮使用現成插件:

(1)複雜的功能:比如檔案上傳、批次上傳、進度顯示,或HTML編輯器。

(2)專案工期緊急、對性能要求不高的場景。

(3)插件剛好符合專案需求。

自己造輪子

第二種做法是自己寫插件,主要問題有:

(1)需要時間,可能拖延工期,工期緊急不建議。

(2)自己造的輪子未必比現有的好用,還要考慮隊友是否適用。

(3)需要較高的開發水準。

如果專案不緊急,我會傾向自己造輪子,好處有:

(1)完全符合專案需求,這是最顯而易見的。

(2)知根知底、容易修改,需求變化時能靈活應對。

(3)輕量級,不必應對那麼多種需求,程式碼自然也少。

(4)對個人能力是很大的鍛煉。「不要重複造輪子」這句話廣為流傳,也成為不少人偷懶的藉口,但我們不該以此阻礙自己成長。造過輪子的人應該深有體會:親手造一個輪子,遠比使用別人寫的100個插件收穫還多。我們的輪子可以不在專案中使用,但這是效率極高的學習方式,強烈推薦。

如何開發輕量且適用性強的插件

所謂適用性強,簡單說就是:對UI限制越少越好,最好沒有;不提供太多功能,只給簡單的api,讓使用者易於擴展。

我們以開發一個jQuery分頁插件為例。

確定需求

分頁插件最基本的需求無非就是頁碼顯示與頁碼切換,所以我們圍繞這個核心開始,暫時不考慮其他潛在需求。

確定插件的HTML和CSS

假設基本UI如下:

對開發人員來說,HTML和CSS越簡單越好,最基本的結構無非就是 a 標籤和 span 標籤的組合。有人可能會想用 ul、li,但這反而增加複雜度,得不償失。HTML程式碼如下:

 <div class="pager">
 <span class="flip noPage">上一頁</span>
 <span class="curPage">1</span>
 <a page="1" href="javascript:;">2</a>
 <a page="2" href="javascript:;">3</a>
 <a page="3" href="javascript:;">4</a>
 <span>...</span>
 <a href="javascript:;" page="8">9</a>
 <a page="1" href="javascript:;" class="flip">下一頁</a>
 </div>

這是最基本的HTML結構,包含容器 div.pager、當前頁 span.curPage、其他頁碼 a 標籤,以及上一頁、下一頁按鈕。接著是CSS:

 .pager { display: inline-block; font: 12 px/21px "宋體"; margin-top: 20px; }
 .pager a, .pager .flip, .pager .curPage {
 border: 1px solid #e3e3e3;
 display: inline-block;
 height: 22px;
 line-height: 22px;
 text-align: center;
 }
 .pager a { background: none repeat scroll 0 0 #fff; color: #010101; text-decoration: none; width: 26px; }
 .pager a:hover { background: none repeat scroll 0 0 #f1f1f1; }
 .pager .noPage { color: #a4a4a4; }
 .pager .curPage { background: none repeat scroll 0 0 #49abde; color: #ffffff; width: 26px; }
 .pager .flip { width: 56px; }

編寫js程式碼

先搭建好jQuery插件開發的基本形式:

 ; (function ($, window, document, undefined) {
 "use strict";
 var defaults = {
 pageIndex: 0,
 pageSize: 6,
 itemCount: 50,
 maxButtonCount: 7,
 prevText: "上一頁",
 nextText: "下一頁",
 buildPageUrl: null,
 onPageChanged: null
 };
 $.fn.pager = function (options) {
 options = $.extend(defaults, options || {});
 }
 })(jQuery, window, document);

這裡提供了可選參數的預設值,比如頁碼預設為 0、每頁 6 條等。接著考慮分頁思路:

1. 設置當前頁碼為 0,表示第一頁。

2. 生成分頁插件的HTML程式碼。

3. 修改頁碼,再重新生成HTML。

 ; (function ($, window, document, undefined) {
 "use strict";
 var defaults = {
 pageIndex: 0,
 pageSize: 6,
 itemCount: 50,
 maxButtonCount: 7,
 prevText: "上一頁",
 nextText: "下一頁",
 buildPageUrl: null,
 onPageChanged: null
 };
 function Pager($ele, options) {
 this.$ele = $ele;
 this.options = options = $.extend(defaults, options || {});
 this.init();
 }
 Pager.prototype = {
 constructor: Pager,
 init: function () {
 this.renderHtml();
 this.bindEvent();
 },
 renderHtml: function () {
 var options = this.options;
 options.pageCount = Math.ceil(options.itemCount / options.pageSize);
 var html = [];
 //生成上一頁的按鈕
 if (options.pageIndex > 0) {
 html.push('<a page="' + (options.pageIndex - 1) + '" href="' + this.buildPageUrl(options.pageIndex + 1) + '" class="flip">' + options.prevText + '</a>');
 } else {
 html.push('<span class="flip noPage">' + options.prevText + '</span>');
 }
 //這裡是關鍵
 //臨時的起始頁碼中間頁碼,當頁碼數量大於顯示的最大按鈕數時使用
 var tempStartIndex = options.pageIndex - Math.floor(options.maxButtonCount / 2) + 1;
 //計算終止頁碼
 var endIndex = Math.min(options.pageCount, Math.max(0, tempStartIndex) + options.maxButtonCount) - 1;
 var startIndex = Math.max(0, endIndex - options.maxButtonCount + 1);
 // 第一頁
 if (startIndex > 0) {
 html.push("<a href='" + this.buildPageUrl(0) + "' page='" + 0 + "'>1</a> ");
 html.push("<span>...</span>");
 }
 //生成頁碼按鈕
 for (var i = startIndex; i <= endIndex; i++) {
 if (options.pageIndex == i) {
 html.push('<span class="curPage">' + (i + 1) + '</span>');
 } else {
 html.push('<a page="' + i + '" href="' + this.buildPageUrl(options.pageIndex + 1) + '">' + (i + 1) + '</a>');
 }
 }
 // 最後一頁
 if (endIndex < options.pageCount - 1) {
 html.push("<span>...</span> ");
 html.push("<a href='" + this.buildPageUrl(options.pageCount - 1) + "' page='" + (options.pageCount - 1) + "'>" + options.pageCount + "</a> ");
 }
 //生成下一頁的按鈕
 if (options.pageIndex < options.pageCount - 1) {
 html.push('<a page="' + (options.pageIndex + 1) + '" href="' + this.buildPageUrl(options.pageIndex + 1) + '" class="flip">' + options.nextText + '</a>');
 } else {
 html.push('<span class="flip noPage">' + options.nextText + '</span>');
 }
 this.$ele.html(html.join(""));
 },
 bindEvent: function () {
 var that = this;
 that.$ele.on("click", "a", function () {
 that.options.pageIndex = parseInt($(this).attr("page"), 10);
 that.renderHtml();
 that.options.onPageChanged && that.options.onPageChange(that.options.pageIndex);
 })
 },
 buildPageUrl: function () {
 if ($.isFunction(this.options.buildPageUrl)) {
 return this.options.buildPageUrl(pageIndex);
 }
 return "javascript:;";
 }
 };
 $.fn.pager = function (options) {
 options = $.extend(defaults, options || {});
 return new Pager($(this), options);
 }
 })(jQuery, window, document);

這段程式碼有兩個關鍵點:

(1)HTML程式碼的生成:頁碼可能太多,需要隱藏部分頁碼,於是用省略號表示被隱藏的頁碼,透過 maxButtonCount 控制最多的頁碼按鈕數。

(2)事件綁定:每次頁碼改變都會重新生成HTML,採用事件代理的方式,既提升效能又不用重複綁定事件。

為潛在需求提供api

那樣夠了嗎?假如需要支援輸入頁碼直接跳轉呢?我的方案是:提供簡單的api,不提供UI,完全由使用者自定義。新增三個api:getPageIndex、setPageIndex 和 setItemCount:

 getPageIndex: function () {
 return this.options.pageIndex;
 },
 setPageIndex: function (pageIndex) {
 this.options.pageIndex = pageIndex;
 this.renderHtml();
 },
 setItemCount: function (itemCount) {
 this.options.pageIndex = 0;
 this.options.itemCount = itemCount;
 this.renderHtml();
 }

有了這三個api,使用者若需要跳轉頁碼功能,直接呼叫 setPageIndex 即可,UI完全自定義,插件本身只專注基本功能。

總結

最後整理一下我開發JS插件的思路:

1. 專注最基本的需求本身,暫時不考慮潛在需求。

2. 盡量不提供或少提供UI,減少對使用者的限制。

3. 針對潛在需求提供api,交由使用者自定義。

這是我在編寫JS插件時,思考如何輕量化並保持高適用性的一些心得,歡迎大家交流!

本文地址:https://luopq.com/2016/02/04/think-js-plugin/,轉載請註明

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved