jQueryプラグインのパッケージ化手順の詳細な説明

今回は、jQuery プラグインをカプセル化する手順について詳しく説明します。jQuery プラグインをカプセル化する際の 注意事項 について、実際のケースを見てみましょう。

jQuery プラグインとメソッドの拡張は非常に強力で、開発時間を大幅に節約できます。この記事では、jQuery プラグイン開発の基本、ベスト プラクティス、およびよくある落とし穴について概説します。

1. はじめに

jQuery プラグインの作成は、新しい function 属性を jQuery.fn に追加することから始まります。ここで追加されるオブジェクト属性の名前は、プラグインの名前です。コードは次のとおりです:

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

ユーザーがとても愛したシンボルはどこに行ってしまったのでしょうか?まだ存在しますが、他の

JavaScript

ライブラリとの競合を避けるために、jQuery を自己実行の閉じたプログラムに渡し、jQuery がシンボルとしてマップされるようにして、$ 記号が上書きされるのを避けることをお勧めします。他の図書館。 コードは次のとおりです:

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

この閉じたプログラムでは、jQuery 関数を表すために $ 記号を制限なく使用できます。

2. 環境 ここで、実際のプラグイン コードを書き始めることができます。 ただし、その前に、プラグインが配置されている環境について理解しておく必要があります。 プラグインのスコープでは、this キーワードはプラグインが実行する jQuery オブジェクトを表します。これは、コールバックを含む他の jQuery 関数では、this キーワードがネイティブ DOM 要素を表すためです。 。これにより、開発者は、以下に示すように、jQuery で this キーワードを誤って不必要にラップすることがよくあります。

. コードは次のとおりです:

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

3. 基本知識 jQuery プラグインの基本を理解したので、何かを行うためのプラグインを作成しましょう。

コードは次のとおりです:

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

これは、 .height() を使用して、ページ上で最大の高さを持つ p 要素の高さを返す単純なプラグインです。

4. チェーン可能性を維持する 多くの場合、プラグインの目的は、収集された要素を何らかの方法で変更し、チェーン内の次のメソッドに渡すことだけです。 これが jQuery の設計の美しさであり、jQuery が人気がある理由の 1 つです。 したがって、プラグインのチェーン可能性を維持するには、プラグインが this キーワードを返すようにする必要があります。

コードは次のとおりです:

(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');

プラグインはこのキーワードを返すため、jQuery によって収集された要素が .css などの jQuery メソッドによって引き続き制御できるように連鎖性が維持されます。 したがって、プラグインが組み込み値を返さない場合は、常にスコープ内で this キーワードを返す必要があります。 さらに、プラグインに渡されるパラメータはプラグインのスコープ内で渡されると推測することもできます。 したがって、前の例では、文字列「width」がプラグインの型パラメータになります。

5. デフォルト値とオプションより複雑で多くのカスタマイズ可能なオプションを提供するプラグインの場合は、プラグインの呼び出し時に ($.伸ばす）。 したがって、多数のパラメーターを使用してプラグインを呼び出す代わりに、オーバーライドする設定を含むオブジェクト パラメーターを使用してプラグインを呼び出すことができます。コードは次のとおりです:

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

この例では、ツールチップ プラグインを呼び出すと、デフォルト設定の location オプションが上書きされ、background-color オプションはデフォルト値のままになるため、最後に呼び出されます。設定値は:

コードは次のとおりです:

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

これは、開発者が利用可能なすべてのオプションを定義する必要がなく、高度に構成可能なプラグインを提供する非常に柔軟な方法です。

6.

名前空間

プラグインに正しく名前を付けることは、プラグイン開発の非常に重要な部分です。 適切な名前空間を使用すると、プラグインが他のプラグインや同じページ上の他のコードによって上書きされる可能性が非常に低いことが保証されます。 また、名前空間を使用すると、メソッド、イベント、データをより適切に追跡できるため、プラグイン開発者としての作業が容易になります。

7. プラグイン方式

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

. 代码如下:

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

这是不被鼓励的，因为它.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!');

这种类型的插件架构允许您封装所有的方法在父包中，通过传递该方法的字符串名称和额外的此方法需要的参数来调用它们。 这种方法的封装和架构类型是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');

在这个例子中，当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></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);

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

十、总结和最佳做法

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

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

. 代码如下:

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

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  $('#smallImg').width() - $('#slider').width()) {
x = $('#smallImg').width() - $('#slider').width();
}
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)

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

推荐阅读：

怎样快速的操作JQuery元素

使用JQuery操作Ajax（附案例）

以上がjQueryプラグインのパッケージ化手順の詳細な説明の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。