组建开发 教程详解1（转）

jQuery插件开发全解析

jQuery插件的开发包括两种：

一种是类级别的插件开发，即给jQuery添加新的全局函数，相当于给jQuery类本身添加方法。jQuery的全局函数就是属于jQuery命名空间的函数，另一种是对象级别的插件开发，即给jQuery对象添加方法。下面就两种函数的开发做详细的说明。

1、类级别的插件开发

类级别的插件开发最直接的理解就是给jQuery类添加类方法，可以理解为添加静态方法。典型的例子就是$.AJAX()这个函数，将函数定义于jQuery的命名空间中。关于类级别的插件开发可以采用如下几种形式进行扩展：

1.1 添加一个新的全局函数

添加一个全局函数，我们只需如下定义：

Java代码

  1. jQuery.foo = function() {
  2. alert(‘This is a test. This is only a test.‘);
  3. };

1.2 增加多个全局函数

添加多个全局函数，可采用如下定义：

Java代码

  1. jQuery.foo = function() {
  2. alert(‘This is a test. This is only a test.‘);
  3. };
  4. jQuery.bar = function(param) {
  5. alert(‘This function takes a parameter, which is "‘ + param + ‘".‘);
  6. };
  7. 调用时和一个函数的一样的:jQuery.foo();jQuery.bar();或者$.foo();$.bar(‘bar‘);

1.3 使用jQuery.extend(object);　

Java代码 

  1. jQuery.extend({
  2. foo: function() {
  3. alert(‘This is a test. This is only a test.‘);
  4. },
  5. bar: function(param) {
  6. alert(‘This function takes a parameter, which is "‘ + param +‘".‘);
  7. }
  8. });

1.4 使用命名空间

虽然在jQuery命名空间中，我们禁止使用了大量的javaScript函数名和变量名。但是仍然不可避免某些函数或变量名将于其他jQuery插件冲突，因此我们习惯将一些方法封装到另一个自定义的命名空间。

Java代码

  1. jQuery.myPlugin = {
  2. foo:function() {
  3. alert(‘This is a test. This is only a test.‘);
  4. },
  5. bar:function(param) {
  6. alert(‘This function takes a parameter, which is "‘ + param + ‘".‘);
  7. }
  8. };
  9. 采用命名空间的函数仍然是全局函数，调用时采用的方法：
  10. $.myPlugin.foo();
  11. $.myPlugin.bar(‘baz‘);

通过这个技巧（使用独立的插件名），我们可以避免命名空间内函数的冲突。

2、对象级别的插件开发

对象级别的插件开发需要如下的两种形式：、

形式1：

Java代码

  1. (function($){
  2. $.fn.extend({
  3. pluginName:function(opt,callback){
  4. // Our plugin implementation code goes here.
  5. }
  6. })
  7. })(jQuery);

形式2：

Java代码

  1. (function($) {
  2. $.fn.pluginName = function() {
  3. // Our plugin implementation code goes here.
  4. };
  5. })(jQuery);

上面定义了一个jQuery函数,形参是$，函数定义完成之后,把jQuery这个实参传递进去.立即调用执行。这样的好处是,我们在写jQuery插件时,也可以使用$这个别名,而不会与prototype引起冲突.

2.1 在JQuery名称空间下申明一个名字

这是一个单一插件的脚本。如果你的脚本中包含多个插件，或者互逆的插件（例如： $.fn.doSomething() 和$.fn.undoSomething()），那么你需要声明多个函数名字。但是，通常当我们编写一个插件时，力求仅使用一个名字来包含它的所有内容。我们的示例插件命名为“highlight“

Java代码

  1. $.fn.hilight = function() {
  2. // Our plugin implementation code goes here.
  3. };
  4. 我们的插件通过这样被调用：
  5. $(‘#myDiv‘).hilight();

但是如果我们需要分解我们的实现代码为多个函数该怎么办？有很多原因：设计上的需要；这样做更容易或更易读的实现；而且这样更符合面向对象。 这真是一个麻烦事，把功能实现分解成多个函数而不增加多余的命名空间。出于认识到和利用函数是javascript中最基本的类对象，我们可以这样做。就像其他对象一样，函数可以被指定为属性。因此我们已经声明“hilight”为jQuery的属性对象，任何其他的属性或者函数我们需要暴露出来的，都可以在"hilight" 函数中被声明属性。稍后继续。
2.2 接受options参数以控制插件的行为

让我们为我们的插件添加功能指定前景色和背景色的功能。我们也许会让选项像一个options对象传递给插件函数。例如：

Java代码

  1. // plugin definition
  2. $.fn.hilight = function(options) {
  3. var defaults = {
  4. foreground: ‘red‘,
  5. background: ‘yellow‘
  6. };
  7. // Extend our default options with those provided.
  8. var opts = $.extend(defaults, options);
  9. // Our plugin implementation code goes here.
  10. };
  11. 我们的插件可以这样被调用：
  12. $(‘#myDiv‘).hilight({
  13. foreground: ‘blue‘
  14. });

2.3 暴露插件的默认设置

我们应该对上面代码的一种改进是暴露插件的默认设置。这对于让插件的使用者更容易用较少的代码覆盖和修改插件。接下来我们开始利用函数对象。

Java代码

  1. // plugin definition
  2. $.fn.hilight = function(options) {
  3. // Extend our default options with those provided.
  4. // Note that the first arg to extend is an empty object -
  5. // this is to keep from overriding our "defaults" object.
  6. var opts = $.extend({}, $.fn.hilight.defaults, options);
  7. // Our plugin implementation code goes here.
  8. };
  9. // plugin defaults - added as a property on our plugin function
  10. $.fn.hilight.defaults = {
  11. foreground: ‘red‘,
  12. background: ‘yellow‘
  13. };
  14. 现在使用者可以包含像这样的一行在他们的脚本里：
  15. //这个只需要调用一次，且不一定要在ready块中调用
  16. $.fn.hilight.defaults.foreground = ‘blue‘;
  17. 接下来我们可以像这样使用插件的方法，结果它设置蓝色的前景色：
  18. $(‘#myDiv‘).hilight();

如你所见，我们允许使用者写一行代码在插件的默认前景色。而且使用者仍然在需要的时候可以有选择的覆盖这些新的默认值：

// 覆盖插件缺省的背景颜色

$.fn.hilight.defaults.foreground = ‘blue‘;

// ...

// 使用一个新的缺省设置调用插件

$(‘.hilightDiv‘).hilight();

// ...

// 通过传递配置参数给插件方法来覆盖缺省设置

$(‘#green‘).hilight({

foreground: ‘green‘

});

2.4 适当的暴露一些函数

这段将会一步一步对前面那段代码通过有意思的方法扩展你的插件（同时让其他人扩展你的插件）。例如，我们插件的实现里面可以定义一个名叫"format"的函数来格式化高亮文本。我们的插件现在看起来像这样，默认的format方法的实现部分在hiligth函数下面。

Java代码

  1. // plugin definition
  2. $.fn.hilight = function(options) {
  3. // iterate and reformat each matched element
  4. return this.each(function() {
  5. var $this = $(this);
  6. // ...
  7. var markup = $this.html();
  8. // call our format function
  9. markup = $.fn.hilight.format(markup);
  10. $this.html(markup);
  11. });
  12. };
  13. // define our format function
  14. $.fn.hilight.format = function(txt) {
  15. return ‘<strong>‘ + txt + ‘</strong>‘;
  16. };

我们很容易的支持options对象中的其他的属性通过允许一个回调函数来覆盖默认的设置。这是另外一个出色的方法来修改你的插件。这里展示的技巧是进一步有效的暴露format函数进而让他能被重新定义。通过这技巧，是其他人能够传递他们自己设置来覆盖你的插件，换句话说，这样其他人也能够为你的插件写插件。 
      考虑到这个篇文章中我们建立的无用的插件，你也许想知道究竟什么时候这些会有用。一个真实的例子是Cycle插件.这个Cycle插件是一个滑动显示插件，他能支持许多内部变换作用到滚动，滑动，渐变消失等。但是实际上，没有办法定义也许会应用到滑动变化上每种类型的效果。那是这种扩展性有用的地方。 Cycle插件对使用者暴露"transitions"对象，使他们添加自己变换定义。插件中定义就像这样：

$.fn.cycle.transitions = {

// ...

};

这个技巧使其他人能定义和传递变换设置到Cycle插件。

2.5 保持私有函数的私有性

这种技巧暴露你插件一部分来被覆盖是非常强大的。但是你需要仔细思考你实现中暴露的部分。一但被暴露，你需要在头脑中保持任何对于参数或者语义的改动也许会破坏向后的兼容性。一个通理是，如果你不能肯定是否暴露特定的函数，那么你也许不需要那样做。

那么我们怎么定义更多的函数而不搅乱命名空间也不暴露实现呢？这就是闭包的功能。为了演示，我们将会添加另外一个“debug”函数到我们的插件中。这个 debug函数将为输出被选中的元素格式到firebug控制台。为了创建一个闭包，我们将包装整个插件定义在一个函数中。

Java代码

  1. (function($) {
  2. // plugin definition
  3. $.fn.hilight = function(options) {
  4. debug(this);
  5. // ...
  6. };
  7. // private function for debugging
  8. function debug($obj) {
  9. if (window.console && window.console.log)
  10. window.console.log(‘hilight selection count: ‘ + $obj.size());
  11. };
  12. //  ...
  13. })(jQuery);

我们的“debug”方法不能从外部闭包进入,因此对于我们的实现是私有的。

2.6 支持Metadata插件

在你正在写的插件的基础上，添加对Metadata插件的支持能使他更强大。个人来说，我喜欢这个Metadata插件，因为它让你使用不多的"markup”覆盖插件的选项（这非常有用当创建例子时）。而且支持它非常简单。更新：注释中有一点优化建议。

Java代码

  1. $.fn.hilight = function(options) {
  2. // ...
  3. // build main options before element iteration
  4. var opts = $.extend({}, $.fn.hilight.defaults, options);
  5. return this.each(function() {
  6. var $this = $(this);
  7. // build element specific options
  8. var o = $.meta ? $.extend({}, opts, $this.data()) : opts;
  9. //...

这些变动行做了一些事情：它是测试Metadata插件是否被安装如果它被安装了，它能扩展我们的options对象通过抽取元数据这行作为最后一个参数添加到JQuery.extend，那么它将会覆盖任何其它选项设置。现在我们能从"markup”处驱动行为,如果我们选择了“markup”：

调用的时候可以这样写： jQuery.foo(); 或 $.foo();

Java代码

  1. <!--  markup  -->
  2. <div class="hilight { background: ‘red‘, foreground: ‘white‘ }">
  3. Have a nice day!
  4. </div>
  5. <div class="hilight { foreground: ‘orange‘ }">
  6. Have a nice day!
  7. </div>
  8. <div class="hilight { background: ‘green‘ }">
  9. Have a nice day!
  10. </div>
  11. 现在我们能高亮哪些div仅使用一行脚本：
  12. $(‘.hilight‘).hilight();

2.7 整合
下面使我们的例子完成后的代码：

Java代码

  1. // 创建一个闭包
  2. (function($) {
  3. // 插件的定义
  4. $.fn.hilight = function(options) {
  5. debug(this);
  6. // build main options before element iteration
  7. var opts = $.extend({}, $.fn.hilight.defaults, options);
  8. // iterate and reformat each matched element
  9. return this.each(function() {
  10. $this = $(this);
  11. // build element specific options
  12. var o = $.meta ? $.extend({}, opts, $this.data()) : opts;
  13. // update element styles
  14. $this.css({
  15. backgroundColor: o.background,
  16. color: o.foreground
  17. });
  18. var markup = $this.html();
  19. // call our format function
  20. markup = $.fn.hilight.format(markup);
  21. $this.html(markup);
  22. });
  23. };
  24. // 私有函数：debugging
  25. function debug($obj) {
  26. if (window.console && window.console.log)
  27. window.console.log(‘hilight selection count: ‘ + $obj.size());
  28. };
  29. // 定义暴露format函数
  30. $.fn.hilight.format = function(txt) {
  31. return ‘<strong>‘ + txt + ‘</strong>‘;
  32. };
  33. // 插件的defaults
  34. $.fn.hilight.defaults = {
  35. foreground: ‘red‘,
  36. background: ‘yellow‘
  37. };
  38. // 闭包结束
  39. })(jQuery);

这段设计已经让我创建了强大符合规范的插件。我希望它能让你也能做到。

3、总结

jQuery为开发插件提拱了两个方法，分别是：

jQuery.fn.extend(object);  给jQuery对象添加方法。
jQuery.extend(object);  为扩展jQuery类本身.为类添加新的方法。

3.1 jQuery.fn.extend(object);

fn 是什么东西呢。查看jQuery代码，就不难发现。

jQuery.fn = jQuery.prototype = {

init: function( selector, context ) {//....　

//......

};

原来 jQuery.fn = jQuery.prototype.对prototype肯定不会陌生啦。虽然 javascript　没有明确的类的概念，但是用类来理解它，会更方便。jQuery便是一个封装得非常好的类，比如我们用 语句　$("#btn1") 会生成一个 jQuery类的实例。

jQuery.fn.extend(object); 对jQuery.prototype进得扩展，就是为jQuery类添加“成员函数”。jQuery类的实例可以使用这个“成员函数”。

比如我们要开发一个插件，做一个特殊的编辑框，当它被点击时，便alert 当前编辑框里的内容。可以这么做：

$.fn.extend({

alertWhileClick:function(){

$(this).click(function(){

alert($(this).val());

});

}

});

$("#input1").alertWhileClick(); //页面上为：<input id="input1" type="text"/>

$("#input1")　为一个jQuery实例，当它调用成员方法 alertWhileClick后，便实现了扩展，每次被点击时它会先弹出目前编辑里的内容。

3.2 jQuery.extend(object);　

为jQuery类添加添加类方法，可以理解为添加静态方法。如：

$.extend({

add:function(a,b){return a+b;}

});

便为　jQuery　添加一个为 add　的　“静态方法”，之后便可以在引入 jQuery　的地方，使用这个方法了，$.add(3,4); //return 7

时间： 2024-10-10 03:49:19

组建开发 教程详解1（转）的相关文章

使用ssh开发rest web服务支持http etag header的教程详解

原创整理不易,转载请注明出处:使用ssh开发rest web服务支持http etag header的教程详解 代码下载地址:http://www.zuidaima.com/share/1777391667989504.htm 导言 REST方式的应用程序构架在近日所产生的巨大影响突出了Web应用程序的优雅设计的重要性.现在人们开始理解"WWW架构"内在的可测量性及弹性,并且已经开始探索使用其范例的更好的方式.在本文中,我们将讨论一个Web应用开发工具--"简陋的.卑下的&q

webpack安装配置使用教程详解

webpack安装配置使用教程详解 www.111cn.net 更新:2015-09-01 编辑:swteen 来源:转载 本文章来为各位详细的介绍一下关于webpack安装配置使用教程吧,这篇文章对于不喜欢使用 jspm测试的朋友可以参考一下. webpack 入门 目录 1 安装 webpack2 初始化项目3 webpack 配置4 自动刷新5 第三方库6 模块化7 打包.构建8 webpack 模板我最近大量使用的是 jspm,但因为用它搭建的前端开发环境中,写测试代码非常困难,而项目又

Extjs MVC开发模式详解

Extjs MVC开发模式详解 在JS的开发过程中,大规模的JS脚本难以组织和维护,这一直是困扰前端开发人员的头等问题.Extjs为了解决这种问题,在Extjs 4.x版本中引入了MVC开发模式,开始将一个JS(Extjs)应用程序分割成Model-View-Controller三层,为JS应用程序的如何组织代码指明了方向,同时使得大规模JS代码变得更加易于重用和维护:这就是Extjs MVC开发模式的初衷. 在官方给出的MVC例子中,我们可以看到一个简单的列表编辑功能,这篇文章就围绕这个功能进

SAE上传web应用(包括使用数据库)教程详解及问题解惑

转自:http://blog.csdn.net/baiyuliang2013/article/details/24725995 SAE上传web应用(包括使用数据库)教程详解及问题解惑:       最近由于工作需求,需利用SAE平台,但在使用过程中遇到不少问题,比如如何上传应用,上传应用完毕后打不开,mysql连接不上等等,以及云豆的计费问题,结合个人使用心得,将在本帖一一解答.       1,上传web应用首先,使用SAE平台需要注册自己的账号吧,这个就不说了,然后进入我的首页,会看到: 

iOS开发：详解Objective-C runTime

Objective-C总Runtime的那点事儿(一)消息机制 最近在找工作,Objective-C中的Runtime是经常被问到的一个问题,几乎是面试大公司必问的一个问题.当然还有一些其他问题也几乎必问,例如:RunLoop,Block,内存管理等.其他的问题如果有机会我会在其他文章中介绍. 本篇文章主要介绍RunTime. RunTime简称运行时.就是系统在运行的时候的一些机制,其中最主要的是消息机制.对于C语言,函数的调用在编译的时候会决定调用哪个函数( C语言的函数调用请看这里 ).编

iOS开发 - UIActivityViewController详解

昨天在做微信分享的时候, 用到了这个东西.趁热写点东西记录下. UIActivityViewController类是一个标准的view controller,通个使用这个controller,你的应用程序就可以提供各种服务. 系统提供了一些通用的标准服务,例如拷贝内容至粘贴板.发布一个公告至社交网.通过email或者SMS发送内容. 应用程序同样可以自定义服务.(我的微信分享就属于自定义服务, 之后将会写一篇教程介绍) 你的应用程序负责配置.展现和解雇这个view controller. vie

超轻量级DI容器框架Google Guice与Spring框架的区别教程详解及其demo代码片段分享

原创不易,转载请注明出处:超轻量级DI容器框架Google Guice与Spring框架的区别教程详解及其demo代码片段分享 代码下载地址:http://www.zuidaima.com/share/1759689106541568.htm 依赖注入,DI(Dependency Injection),它的作用自然不必多说,提及DI容器,例如spring,picoContainer,EJB容器等等,近日,google诞生了更轻巧的DI容器--Guice! 废话不多讲了,先看看Guice是如何实现

windows上安装Anaconda和python的教程详解

一提到数字图像处理编程,可能大多数人就会想到matlab,但matlab也有自身的缺点: 1.不开源,价格贵 2.软件容量大.一般3G以上,高版本甚至达5G以上. 3.只能做研究,不易转化成软件. 因此,我们这里使用Python这个脚本语言来进行数字图像处理. 要使用Python,必须先安装python,一般是2.7版本以上,不管是在windows系统,还是Linux系统,安装都是非常简单的. 要使用python进行各种开发和科学计算,还需要安装对应的包.这和matlab非常相似,只是matla

Cocos2d-x 3.X手游开发实例详解

Cocos2d-x 3.X手游开发实例详解(最新最简Cocos2d-x手机游戏开发学习方法,以热门游戏2048.卡牌为例,完整再现手游的开发过程,实例丰富,代码完备,Cocos2d-x作者之一林顺和泰然网创始人杨雍力荐) 于浩洋 著   ISBN 978-7-121-23998-4 2014年9月出版 定价:59.00元 356页 16开 编辑推荐 以Cocos2d-x V3.0为框架全面讲解手游开发的知识和方法 以热门游戏2048.卡牌为例,完整再现手游的开发过程 Cocos2d-x作者之一林