Detaillierte Erläuterung der Schritte zum Packen des jQuery-Plug-Ins-js-Tutorial-php.cn

Dieses Mal werde ich Ihnen die Schritte zum Verpacken des jQuery-Plugins ausführlich erläutern. Was sind die Vorsichtsmaßnahmen für das Verpacken des jQuery-Plugins?

Das Erweitern von jQuery-Plug-ins und -Methoden ist sehr leistungsfähig und kann viel Entwicklungszeit sparen. In diesem Artikel werden die Grundlagen, Best Practices und häufigen Fallstricke bei der Entwicklung von jQuery-Plugins beschrieben.

1. Erste Schritte

Das Schreiben eines jQuery-Plugins beginnt mit dem Hinzufügen neuer Funktionsattribute zu jQuery.fn. Die hier hinzugefügten Objektattribute sind Der Name ist der Name Ihres Plug-Ins:

Der Code lautet wie folgt:

jQuery.fn.myPlugin = function(){ 
//你自己的插件代码 
};

Nach dem Login kopieren

Wo sind die Symbole, die den Benutzern sehr gefallen? Es existiert jedoch immer noch, um Konflikte mit anderen JavaScript-Bibliotheken zu vermeiden, übergeben wir jQuery besser an ein selbstausführendes geschlossenes Programm, in dem jQuery als Symbol abgebildet wird, um das $ zu vermeiden Zeichen, das von anderen Bibliotheken verwendet wird, überschreiben.

. Der Code lautet wie folgt:

(function ($) {
$.fn.myPlugin = function () {
//你自己的插件代码
};
})(jQuery);

Nach dem Login kopieren

In diesem geschlossenen Programm können wir das $-Symbol ohne Einschränkung verwenden, um jQuery-Funktionen darzustellen.

2. Umgebung

Jetzt können wir mit dem Schreiben des eigentlichen Plug-in-Codes beginnen. Zuvor müssen wir jedoch eine Vorstellung von der Umgebung haben, in der sich das Plug-in befindet. Im Geltungsbereich des Plug-Ins stellt das Schlüsselwort „This“ das jQuery-Objekt dar, das das Plug-In ausführt. Hier kann es leicht zu Missverständnissen kommen, da das Schlüsselwort „This“ in anderen jQuery-Funktionen, die Rückrufe enthalten, das native DOM-Element darstellt . Dies führt häufig dazu, dass Entwickler das Schlüsselwort this fälschlicherweise unnötigerweise in jQuery einschließen, wie unten gezeigt.

Der Code lautet wie folgt:

(function ($) {
$.fn.myPlugin = function () {
//此处没有必要将this包在$号中如$(this)，因为this已经是一个jQuery对象。
//$(this)等同于 $($('#element'));
this.fadeIn('normal', function () {
//此处callback函数中this关键字代表一个DOM元素
});
};
})(jQuery);
$('#element').myPlugin();

Nach dem Login kopieren

3. Grundkenntnisse

Jetzt verstehen wir die Grundlagen Wissen Sie, was das jQuery-Plugin betrifft? Schreiben wir ein Plugin, das etwas tut.

. Der Code lautet wie folgt:

(function ($) {
$.fn.maxHeight = function () {
var max = 0;
this.each(function () {
max = Math.max(max, $(this).height());
});
return max;
};
})(jQuery);
var tallest = $('p').maxHeight(); //返回高度最大的p元素的高度

Nach dem Login kopieren

Dies ist ein einfaches Plug-in, das .height() verwendet, um die Höhe des p-Elements mit der größten Höhe auf der Seite zurückzugeben .

4. Verkettbarkeit aufrechterhalten

Oft besteht die Absicht eines Plug-Ins lediglich darin, die gesammelten Elemente auf irgendeine Weise zu modifizieren und weiterzugeben sie zur nächsten Methode in der Kette weiter. Das ist das Schöne am jQuery-Design und einer der Gründe, warum jQuery so beliebt ist. Um die Verkettbarkeit eines Plugins aufrechtzuerhalten, müssen Sie daher sicherstellen, dass Ihr Plugin das Schlüsselwort this zurückgibt.

. Der Code lautet wie folgt:

(function ($) {
$.fn.lockDimensions = function (type) {
return this.each(function () {
var $this = $(this);
if (!type || type == 'width') {
$this.width($this.width());
}
if (!type || type == 'height') {
$this.height($this.height());
}
});
};
})(jQuery);
$('p').lockDimensions('width').CSS('color', 'red');

Nach dem Login kopieren

Da das Plugin dieses Schlüsselwort zurückgibt, bleibt die Verkettbarkeit erhalten, sodass von jQuery erfasste Elemente weiterhin durch jQuery-Methoden wie .css gesteuert werden können . Wenn Ihr Plugin daher keinen intrinsischen Wert zurückgibt, sollten Sie das Schlüsselwort this immer innerhalb seines Gültigkeitsbereichs zurückgeben. Darüber hinaus können Sie daraus schließen, dass an ein Plugin übergebene Parameter innerhalb des Gültigkeitsbereichs des Plugins übergeben werden. Daher wird im vorherigen Beispiel die Zeichenfolge „width“ zu einem Typparameter des Plugins.

5. Standardwerte und Optionen

Für komplexere Plug-Ins, die viele anpassbare Optionen bieten, ist es am besten, ein zu haben Standardeinstellungen, die beim Aufruf des Plugins erweitert werden können (durch Verwendung von $.extend). Anstatt also ein Plugin mit einer Reihe von Parametern aufzurufen, können Sie es mit einem Objektparameter aufrufen, der die Einstellungen enthält, die Sie überschreiben möchten.

. Der Code lautet wie folgt:

(function ($) {
$.fn.tooltip = function (options) {
//创建一些默认值，拓展任何被提供的选项
var settings = $.extend({
'location': 'top',
'background-color': 'blue'
}, options);
return this.each(function () {
// Tooltip插件代码
});
};
})(jQuery);
$('p').tooltip({
'location': 'left'
});

Nach dem Login kopieren

In diesem Beispiel wird beim Aufruf des Tooltip-Plugins die Standortoption in den Standardeinstellungen und die Hintergrundfarbenoption überschrieben Bleibt auf seinem Standardwert, daher wird er schließlich aufgerufen. Der Einstellungswert lautet:

Der Code lautet wie folgt:

{
'location': 'left',
'background-color': 'blue'
}

Nach dem Login kopieren

Dies ist eine sehr flexible Möglichkeit, einen hochgradig konfigurierbaren Stecker bereitzustellen -in, ohne dass Entwickler alle verfügbaren Optionen definieren müssen.

6. Namespace

Die richtige Benennung Ihres Plug-Ins ist ein sehr wichtiger Teil der Plug-In-Entwicklung. Mit dem richtigen Namespace können Sie garantieren, dass die Wahrscheinlichkeit, dass Ihr Plugin von anderen Plugins oder anderem Code auf derselben Seite überschrieben wird, sehr gering ist. Namespaces erleichtern Ihnen auch das Leben als Plugin-Entwickler, da sie Ihnen dabei helfen, den Überblick über Ihre Methoden, Ereignisse und Daten zu behalten.

7. Plug-in-Methode

在任何情况下，一个单独的插件不应该在jQuery.fnjQuery.fn对象里有多个命名空间。

. 代码如下:

(function ($) {
$.fn.tooltip = function (options) {
// this
};
$.fn.tooltipShow = function () {
// is
};
$.fn.tooltipHide = function () {
// bad
};
$.fn.tooltipUpdate = function (content) {
// !!!
};
})(jQuery);

Nach dem Login kopieren

这是不被鼓励的，因为它.fn使.fn命名空间混乱。为了解决这个问题，你应该收集对象文本中的所有插件的方法，通过传递该方法的字符串名称给插件以调用它们。

. 代码如下:

(function ($) {
var methods = {
init: function (options) {
// this
},
show: function () {
// is
},
hide: function () {
// good
},
update: function (content) {
// !!!
}
};
$.fn.tooltip = function (method) {
// 方法调用
if (methods[method]) {
return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
} else if (typeof method === 'object' || !method) {
return methods.init.apply(this, arguments);
} else {
$.error('Method' + method + 'does not exist on jQuery.tooltip');
}
};
})(jQuery);
//调用init方法
$('p').tooltip();
//调用init方法
$('p').tooltip({
foo: 'bar'
});
// 调用hide方法 
$(‘p').tooltip(‘hide');
//调用Update方法 
$(‘p').tooltip(‘update', ‘This is the new tooltip content!');

Nach dem Login kopieren

这种类型的插件架构允许您封装所有的方法在父包中，通过传递该方法的字符串名称和额外的此方法需要的参数来调用它们。这种方法的封装和架构类型是jQuery插件社区的标准，它被无数的插件在使用，包括jQueryUI中的插件和widgets。

八、事件

一个鲜为人知bind方法的功能即允许绑定事件命名空间。如果你的插件绑定一个事件，一个很好的做法是赋予此事件命名空间。通过这种方式，当你在解除绑定的时候不会干扰其他可能已经绑定的同一类型事件。你可以通过追加命名空间到你需要绑定的的事件通过 ‘.'。

. 代码如下:

(function ($) {
var methods = {
init: function (options) {
return this.each(function () {
$(window).bind('resize.tooltip', methods.reposition);
});
},
destroy: function () {
return this.each(function () {
$(window).unbind('.tooltip');
})
},
reposition: function () {
//...
},
show: function () {
//...
},
hide: function () {
//...
},
update: function (content) {
//...
}
};
$.fn.tooltip = function (method) {
if (methods[method]) {
return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
} else if (typeof method === 'object' || !method) {
return methods.init.apply(this, arguments);
} else {
$.error('Method ' + method + ' does not exist on jQuery.tooltip');
}
};
})(jQuery);
$('#fun').tooltip();
//一段时间之后… … 
$(‘#fun').tooltip(‘destroy');

Nach dem Login kopieren

在这个例子中，当tooltip通过init方法初始化时，它将reposition方法绑定到resize事件并给reposition非那方法赋予命名空间通过追加.tooltip。稍后，当开发人员需要销毁tooltip的时候，我们可以同时解除其中reposition方法和resize事件的绑定，通过传递reposition的命名空间给插件。这使我们能够安全地解除事件的绑定并不会影响到此插件之外的绑定。

九、数据

通常在插件开发的时候，你可能需要记录或者检查你的插件是否已经被初始化给了一个元素。使用jQuery的data方法是一个很好的基于元素的记录变量的途径。尽管如此，相对于记录大量的不同名字的分离的data, 使用一个单独的对象保存所有变量，并通过一个单独的命名空间读取这个对象不失为一个更好的方法。

. 代码如下:

(function ($) {
var methods = {
init: function (options) {
return this.each(function () {
var $this = $(this),
data = $this.data('tooltip'),
tooltip = $('<p />', {
text: $this.attr('title')
});
// If the plugin hasn't been initialized yet
if (!data) {
/*
Do more setup stuff here
*/
$(this).data('tooltip', {
target: $this,
tooltip: tooltip
});
}
});
},
destroy: function () {
return this.each(function () {
var $this = $(this),
data = $this.data('tooltip');
// Namespacing FTW
$(window).unbind('.tooltip');
data.tooltip.remove();
$this.removeData('tooltip');
})
},
reposition: function () {
// ...
},
show: function () {
// ...
},
hide: function () {
// ...
},
update: function (content) {
// ...
}
};
$.fn.tooltip = function (method) {
if (methods[method]) {
return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
} else if (typeof method === 'object' || !method) {
return methods.init.apply(this, arguments);
} else {
$.error('Method ' + method + ' does not exist on jQuery.tooltip');
}
};
})(jQuery);

Nach dem Login kopieren

将数据通过命名空间封装在一个对象中，可以更容易的从一个集中的位置读取所有插件的属性。

十、总结和最佳做法

编写jQuery插件允许你做出库，将最有用的功能集成到可重用的代码，可以节省开发者的时间，使开发更高效。开发jQuery插件时，要牢记：

1.始终包裹在一个封闭的插件：

. 代码如下:

(function($) { 
/* plugin goes here */ 
})(jQuery);

Nach dem Login kopieren

2.不要冗余包裹this关键字在插件的功能范围内

3.除非插件返回特定值，否则总是返回this关键字来维持chainability 。

4.传递一个可拓展的默认对象参数而不是大量的参数给插件。

5.不要在一个插件中多次命名不同方法。

3.始终命名空间的方法，事件和数据。

最后加一个自己写的放大镜的插件`

(function($){$.fn.Fdj=function(){
$('#smallImg').on('mouseover', function() {
$('#slider').show();
})
$('#smallImg').on('mouseout', function() {
$('#slider').hide();
})
$('#smallImg').on('mousemove', function(e) {
var x = e.clientX - $('#slider').width() / 2;
var y = e.clientY - $('#slider').height() / 2;
if(x <= 0) {
x = 0
}
if(x > $('#smallImg').width() - $('#slider').width()) {
x = $('#smallImg').width() - $('#slider').width();
}
if(y <= 0) {
y = 0
}
if(y > $('#smallImg').height() - $('#slider').height()) {
y = $('#smallImg').height() - $('#slider').height();
}
$('#slider').css({
'left': x,
'top': y
})
var X=x/$('#smallImg').width()*800 
var Y=y/$('#smallImg').height()*800
$('#img').css({
left:-X,
top:-Y
})
}) 
}
})(jQuery)

Nach dem Login kopieren

相信看了本文案例你已经掌握了方法，更多精彩请关注php中文网其它相关文章！