[转]浅谈jQuery EasyUI的属性设置

原文地址:http://www.easyui.info/archives/1664.html

对jQuery EasyUI有一定了解的话，应该知道基本上每一个组件都有一个"options"方法用于返回该组件实例的属性。这些属性决定了组件实例将如何展现和运作。

不过EasyUI的属性取值渠道比较多，多得有些让人眼花缭乱，渠道多有好处也有坏处，好处就是很灵活，坏处就是容易乱，比如说多种渠道设置同一个属性时，到底以哪种渠道设置的属性为准呢？

本篇文章就来较为详细的做一下总结，注意，我们只关注属性有哪些渠道获取，各种渠道的优先级，属性的类型等，我们并不关注属性是如何影响组件实例的。

属性获取渠道

  • 【渠道1】组件定义时设置的默认值，组件没有实例化就是相当于"类"了，各种属性设置了默认值；
  • 【渠道2】组件实例宿主DOM对象的data-options属性，data-options是以json串的方式设置属性的，很灵活;
  • 【渠道3】组件实例宿主DOM对象的属性，也就是html标签的各个属性(style和data-options例外)
  • 【渠道4】组件实例宿主DOM对象的style属性；
  • 【渠道5】如果组件的实例化是通过javascript的话，组件构造函数的的入参也可以设置组件实例属性

组件的构造函数

这么多种方式设置组件实例的属性，到底他们的优先级是什么样的？我们拿panel组件的源码来分析，看pane构造函数代码，因为一切都是从构造函数开始的：

  1. /**  
  2.  * panel组件的构造函数  
  3.  * @param options  
  4.  * @param param  
  5.  * @returns {*}  
  6.  */  
  7. $.fn.panel = function(options, param){   
  8.     if (typeof options == 'string'){   
  9.         return $.fn.panel.methods[options](this, param);   
  10.     }   
  11.   
  12.     options = options || {};   
  13.     return this.each(function(){   
  14.         var state = $.data(this, 'panel');   
  15.         var opts;   
  16.         if (state){//已经初始化过   
  17.             //属性值用新传入的覆盖   
  18.             opts = $.extend(state.options, options);   
  19.             state.isLoaded = false;   
  20.         } else {//还未初始化   
  21.             //获取panel组件实例的属性列表   
  22.             opts = $.extend({}, $.fn.panel.defaults, $.fn.panel.parseOptions(this), options);   
  23.             $(this).attr('title', '');   
  24.             state = $.data(this, 'panel', {   
  25.                 options: opts,   
  26.                 panel: wrapPanel(this),   
  27.                 isLoaded: false  
  28.             });   
  29.         }   
  30.   
  31.         addHeader(this);   
  32.         setProperties(this);   
  33.   
  34.         if (opts.doSize == true){   
  35.             state.panel.css('display','block');   
  36.             setSize(this);   
  37.         }   
  38.         if (opts.closed == true || opts.minimized == true){   
  39.             state.panel.hide();   
  40.         } else {   
  41.             openPanel(this);   
  42.         }   
  43.     });   
  44. };  

关键性代码就是22行，使用了jQuery的extend函数，这行代码的信息量很大，我们可以轻松地看出，组件默认值的优先级最低；如果是javascript构造的组件实例，构造函数的入参优先级最高；夹在中间的是panel组件的属性转换器。

到这里，我们至少已经得出了一个简单结论：【渠道1】的优先级最低，【渠道5】的优先级最高。

组件的属性转换器

对于渠道2,3,4，我们则要进一步分析panel组件的属性转换器了，看它的代码：

  1. /**  
  2.  * panel组件的属性转换器  
  3.  * @param target 组件实例的宿主DOM  
  4.  * @returns {*}  
  5.  */  
  6. $.fn.panel.parseOptions = function (target) {   
  7.     var t = $(target);   
  8.     return $.extend(   
  9.         //新空对象   
  10.         {},   
  11.         //公用的属性转换器   
  12.         $.parser.parseOptions(target, ['id', 'width', 'height', 'left', 'top',   
  13.             'title', 'iconCls', 'cls', 'headerCls', 'bodyCls', 'tools', 'href',   
  14.             {cache: 'boolean', fit: 'boolean', border: 'boolean', noheader: 'boolean'},   
  15.             {collapsible: 'boolean', minimizable: 'boolean', maximizable: 'boolean'},   
  16.             {closable: 'boolean', collapsed: 'boolean', minimized: 'boolean', maximized: 'boolean', closed: 'boolean'}   
  17.         ]),   
  18.         //loadingMessage属性有什么特别之处，为什么要单独作为一个参数？   
  19.         {   
  20.             loadingMessage: (t.attr('loadingMessage') != undefined ? t.attr('loadingMessage') : undefined)   
  21.         }   
  22.     );   
  23. };  

又是用了jQuery的extend函数，直接看上去，得不到太多信息，extend函数有三个实参。第一个是为了拷贝到新对象上，第二个是公用的属性转换器，第三个则有些莫名其妙，单单的一个loadingMessage属性，为何要特殊处理？

公用的属性转换器

进一步看公用属性转换器的源码：

  1. /**  
  2.  * parse options, including standard 'data-options' attribute.  
  3.  *  
  4.  * @param target [DOM对象] 组件的宿主对象  
  5.  * @param properties [数组] 需要优先从宿主对象属性(不包含data-options属性)中取的opts列表  
  6.  *  
  7.  * calling examples:  
  8.  * $.parser.parseOptions(target);  
  9.  * $.parser.parseOptions(target, ['id','title','width',{fit:'boolean',border:'boolean'},{min:'number'}]);  
  10.  */  
  11. function parseOptions(target, properties){   
  12.     var t = $(target);   
  13.     var options = {};   
  14.   
  15.     //第一步：首先从data-options属性中取opts   
  16.     var s = $.trim(t.attr('data-options'));   
  17.     if (s){   
  18.         //兼容写大括号和不写大括号的写法   
  19.         if (s.substring(0, 1) != '{'){   
  20.             s = '{' + s + '}';   
  21.         }   
  22.         //利用Function函数将字符串转为化对象   
  23.         //到这里，我们第一次取值就完成了。   
  24.         options = (new Function('return ' + s))();   
  25.     }   
  26.   
  27.     //第二步：如果properties不为空的话，则将properties中定义的属性增加或者覆盖到“第一步”中取到的属性列表中   
  28.     if (properties){   
  29.         var opts = {};   
  30.         for(var i=0; i<properties.length; i++){   
  31.             var pp = properties[i];   
  32.             //如果是字符串型   
  33.             if (typeof pp == 'string'){   
  34.                 //width height left top四个属性从宿主对象的style属性中取值   
  35.                 if (pp == 'width' || pp == 'height' || pp == 'left' || pp == 'top'){   
  36.                     opts[pp] = parseInt(target.style[pp]) || undefined;   
  37.                 } else {//其它情况直接从宿主对象的对应属性中取值   
  38.                     opts[pp] = t.attr(pp);   
  39.                 }   
  40.             } else {//布尔型或者数字型   
  41.                 for(var name in pp){   
  42.                     var type = pp[name];   
  43.                     if (type == 'boolean'){//布尔型从宿主对象对应属性中取值，同时将属性值转为布尔型   
  44.                         opts[name] = t.attr(name) ? (t.attr(name) == 'true') : undefined;   
  45.                     } else if (type == 'number'){//数字型也从宿主对象对应属性中取值，同时将属性值转为浮数   
  46.                         opts[name] = t.attr(name)=='0' ? 0 : parseFloat(t.attr(name)) || undefined;   
  47.                     }   
  48.                 }   
  49.             }   
  50.         }   
  51.         //第二步取得的结果覆盖到第一步取得的结果中   
  52.         $.extend(options, opts);   
  53.     }   
  54.     return options;   
  55. }  

原来主要的逻辑在公用的属性转换器里面，由代码我们可以清楚的看出【渠道3】和【渠道4】的优先级是高于【渠道2】的。

公用属性转换器的入参properties的用途究竟是什么呢？有代码可以看出，它是一个数组，数组元素只支持string和object两种，再 回头看，结合panel组件的属性转换器代码，不难可以看出，properties属性规范了组件实例各属性的数据类型，不过properties能规范 的类型只有boolen,number,string三种。

特殊的，对于width,height,left,top这四个属性，优先级最高的是【渠道4】,即最优先从style属性中取，且类型都为number型。

最后的结论

由上述总结，可以得出以下结论：

【渠道5】 > 【渠道4】 > 【渠道3】 > 【渠道2】 > 【渠道1】

到此处，我们关心的主要问题就算分析完了。不过还是遗留了一个问题，那就是panel组件的属性转换器中，为何loadingMessage属性不 放在公共的属性转换器里处理？单独作为参数传入的，number,bool,string这三种类型之外的属性，才有这必要。1.3.5的panel源码 为何要把loadingMessage属性特殊对待，本人是没有想明白。

注意：本文的分析基于data-options属性出世之后（印象中是1.2.6版本之后），文中代码是1.3.5版本的源码。

posted @ 2016-02-06 19:57  dirgo  阅读(1170)  评论(0)  编辑  收藏  举报