編寫優秀jQuery插件的10個技巧

来源:https://www.cnblogs.com/kkdn/archive/2018/03/23/8628861.html
-Advertisement-
Play Games

1. 把你的代碼全部放在閉包裡面 這是我用的最多的一條。但是有時候在閉包外面的方法會不能調用。不過你的插件的代碼只為你自己的插件服務,所以不存在這個問題,你可以把所有的代碼都放在閉包裡面。而方法可能應該放在Prototype方法內部。 2. 提供插件的預設選項 你的插件應該會有一些選項是可以讓開發者 ...


1. 把你的代碼全部放在閉包裡面

這是我用的最多的一條。但是有時候在閉包外面的方法會不能調用。
不過你的插件的代碼只為你自己的插件服務,所以不存在這個問題,你可以把所有的代碼都放在閉包裡面。
而方法可能應該放在Prototype方法內部。

(function($)  {
//code here
})(jQuery);

2. 提供插件的預設選項

你的插件應該會有一些選項是可以讓開發者設置的,所以提供恢復預設選項是以有必要的。 你可以通過jQuery的extend功能來設置這些選項:

var defaultSettings = {      mode            : 'Pencil',
lineWidthMin    : '0',
lineWidthMax    : '10',
lineWidth       : '2' };
settings = $.extend({}, defaultSettings, settings || {});

3. 使用返回一個元素

JavaScript/jQuery有一個很好的特點就是可以進行方法級聯,所以我們不應該破壞這個特性,始終在方法中返回一個元素。我在我的每一個jQuery插件中都遵守這一條。

$.fn.wPaint = function(settings)  {
return this.each(function()  {
var elem = $(this);
//run some code here
}
}

4. 一次性代碼放在主迴圈以外

這一條很重要,但是常常被忽略。簡單的講,如果你有一段代碼是一堆預設值,只需要被實例化一次,而不是每次調用你插件功能的時候都實例化,你應該把這段代碼放在插件方法的外面。這樣可以讓你的插件運行的更高效,節省記憶體。

var defaultSettings = {
mode            : 'Pencil',
lineWidthMin    : '0',
lineWidthMax    : '10',
lineWidth       : '2' };
settings = $.extend({}, defaultSettings, settings || {});

$.fn.wPaint = function(settings)  {
return this.each(function()  {
var elem = $(this);
//run some code here
}
}

你可以註意到,上面代碼中的“defaultSettings”是完全在插件方法外面的,由於這些代碼是在閉包裡面,我們不用擔心這些變數被重寫。

5. 為什麼要設置 Class Prototyping

作為你代碼的血與肉,方法和函數應該放在prototype函數內。有兩個原因:

  •  它可以節省很多記憶體,因為可以不用重覆創建這些方法。

  •  引用一個現成的方法比重新創建一個好快很多。

簡單的說,prototype就是擴展了一個對象,為它提供方法,而不用在每一個對象中實例化這些方法。這也讓你的代碼更有條理和高效。一旦你習慣這種開發方式,你會發現它在你將來的項目中為你節省了很多時間。

6. 如何設置 Class Prototyping

設置一個 prototype 方法有兩個部分。首先我們需要創建我們最初的類定義,在多數情況下這就意味著創建一個對象。這個定義包含了每一個對象實例都不同的部分。在我的Paint jQuery Plugin 插件中,我是這麼寫的:

function Canvas(settings)  {
this.settings = settings;
this.draw = false;
this.canvas = null;
this.ctx = null;
return this;  }

下麵來添加全局的方法:

Canvas.prototype =  {
generate: function() {
//generate code
}
}

這裡的關鍵是要讓prototype的方法是通用的,但是數據是每個實例自己的,可以用“this”引用。

7. 使用 “this” 對象

通過使用“$this”,我們可以向別的閉包傳遞正確的引用。我們也可能需要向別的方法傳入 $this 引用。需要註意的是, $this 這個名字是可以改的,任意的變數名都可以。

Canvas.prototype =  {
generate: function()   {
//some code
var $this = this;
var buton = //...some code
button.click(function(){
//using this will not be found since it has it's own this
//use $this instead.
$this.someFunc($this);
});
},

someFunc: function($this)      {
//won't know what "this" is.
//use $this instead passed from the click event
}
}

8. 在每一個對象中保存設置

我一直在每一個對象中保存自己的設置,然後操作它自己的設置。這樣你就不用在不同的方法中傳遞很多參數。把這些變數放在對象中,也方便你在其他地方調用這些變數。

function Canvas(settings)  {
this.settings = settings;
return this;
}

9. 分離你的Prototype方法邏輯

這可能是一個基本的原則。當你在猶豫是否需要提供一個方法的時候,你可以問你自己 “如果其他人要重寫這個方法的話,你的代碼是否能滿足他的需求?”或者“別人來寫這個方法有多困難?”。當然這是一個靈活性拿捏的問題。這裡列出了我的Color Picker jQuery Plugin 的方法,你可以參考一下:

generate()
appendColors()
colorSelect()
colorHoverOn()
colorHoverOff()
appendToElement()
showPalette()
hidePalette()

10. 提供 Setter/Getter 選項

這一條不是必須的,但是我發現我所有的插件都包用到了這一條。因為它只需要一點點代碼,就能為別人提供一個他可能需要的功能。

基本上,我們只要讓開發者能夠設置或者獲取元素已經存在的值:

var lineWidth = $("#container").wPaint("lineWidth");  $("#container").wPaint("lineWidth", "5");

總結:以上十條基本上覆蓋了jQuery插件開發的核心,並且可以作為開發的模板。有一套基本的代碼可以極大的縮短你的開發時間,並且能夠讓你設計插件架構的時候更自信。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 頁面顯示效果,如下圖: 主頁面代碼: 跳轉頁面代碼: ...
  • 問題 react native版本 0.53.3 react native splash screen版本 3.0.6 一切配置妥當後出現如下問題: 在android studio里的調試報錯為 原因 react native splash screen版本 3.0.1 和 3.0.6 有所不同 差 ...
  • 在典型的面向對象的語言中,如java,都存在類(class)的概念,類就是對象的模板,對象就是類的實例。但是在Javascript語言體系中,是不存在類(Class)的概念的,javascript中不是基於‘類的',而是通過構造函數(constructor)和原型鏈(prototype chains ...
  • // ajax的倆個版本: var xmlhttp; if(window.xmlHttpRequest){ xmlhttp = new xmlHttpRequest(); }else{ xmlhttp = new Activexobjext("Microsoft.xmlhttp"); } // 向服 ...
  • API sectionsColor:['green','orange','red','lime']; //設置背景顏色 可以為每一個section設置background-color屬性 controlArrows: 定義是否通過箭頭來控制slide幻燈片,預設為true,當我們設置為false,則 ...
  • 趁著最近工作不忙,重新溫習前端一些知識,從JavaScript開始吧。 (一)溫習JS知識一些簡單記錄 在這裡,我就只記錄一些我想記載的東西,以備自己以後繼續研究和擴展。 1.JavaScript是一種基於對象和事件驅動的客戶端腳本語言,也能運行於後臺的語言,如現在流行的node.js。 2.Jav ...
  • 隨著越來越多不同解析度和大小的顯示器終端出現在市場上,原先用一個板式的web頁面設計和佈局來應對所有設備的做法遇到了越來越多的問題,針對寬屏設備開發的頁面在手機或者pad上佈局會產生各種錯位或者Bug,大幅度降低了用戶體驗。 響應式佈局就是為了應對這樣的情況而出現的一種設計方式,其核心理念是在不同的 ...
  • 1.1,JavaScript起源--Netscape和Sun公司 1.2,Dom,DHTML(Dynamic HTML)動態HTML 1.3,瀏覽器戰爭 1.4,最後都遵循W3C標準 1.5,WebKit(http://webkit.org)是Safari和Chrome採用的一個開源的Web瀏覽器引 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...