jquery1.43源码分析之属性操作
by
at 2010-10-26 05:05:37
original http://www.javaeye.com/topic/793835
jquery提供了一些快捷函数来对dom对象的属性进行存取操作. 这一部分还是比较简单的. jquery的主要工作还是为了解决浏览器的兼容性. 这部分的方法一般都有2个特点.
1, set方法和get方法一体化. 根据参数数量来判断是set还是get.
2, value可以传入一个闭包. 这个闭包的返回值才是真正的value.
jQuery.prototype.attr.
实际上这个方法就是setAttribute和getAttribute操作的集合.jQuery把又长又难记的函数名省略成attr.
严格的讲, 挂在dom元素身上的属性,又可以分为属性(property)和特性(attribute).
属性可以看成是dom节点对象上的一个普通的property.跟var a = {b:1}的a.b一样. 设置它可以用a.b=1, 删除它可以用delete a.b
而特性是真正被应用到dom节点当中, 会改变节点在document中的状态.如果给dom节点添加了一个特性, 在firebug中是能够看到dom节点标签里多了这个attribute的.删除它要用removeAttribute
对于id, a标签的href这样的特殊属性,通过dom0方式(即xxx.xxx=xxx)和dom1方式(setAttribute/getAttribute)方式都可以访问到它们.这些特殊的属性也被当成特性, 在各个浏览器中行为都是一样的.
除了这些特殊属性, 在firefox等符合w3c标准的浏览器中,特性和属性是严格区分的. 如果要给dom节点设置/取得一个自定义特性,必须用setAttribute/getAttribute, 在firefox中用dom0的方式操作的只是这个dom节点对象的property.
而在IE中, dom节点内的任何通过硬编码(即写在html标签内的属性)和通过dom0方式(即xxx.xxx=xxx)设置的属性,也都被当做了特性. 也就是说set/get它的时候通过dom0方式和dom1方式都可以.
删除dom节点特性/属性的时候, 如果是特性就用removeAttrtibute, 如果是属性就用delete xxx.xxx. 由上面的分析可知, IE中都是用removeAttrtibute. 而firefox中要看具体到底是特性还是属性.因为各个浏览器对特性/属性的混乱实现, jquery里面提供了jQuery.support.deleteExpando这个特性检测.
了解了这些之后就来看看attr函数的实现.
暴露给api的原型方法非常简单,只有一句话.把参数交给jQuery.access函数去处理. jQuery.access主要作用是修正参数. 看看attr函数里的最后一个参数jQuery.attr. 这个参数的作用是告诉access方法, 修正完参数后再去调用 jQuery.attr方法. 因为access还可以被 jQuery.css利用,如果这里的最后一个参数是 jQuery.css.
attr: function( name, value ) {
return jQuery.access( this, name, value, true, jQuery.attr );
}
access忘记是1.3还是1.4版本被提炼出来的.它的作用就好像机场的安检处,检查你的行李,没收你的打火机.然后根据你的机票告诉你,北京往左边走,深圳往右边走,当然还记得带上你的行李.
access: function( elems, key, value, exec, fn, pass ) {
//value可能是一个闭包函数,exec参数是判断value是一个直接的//string值还是这个闭包函数计算后的返回值, 属性操作这部分的方法里都可以传入一个闭包的返回值当value.可以应用于
//$("div").attr("id", function(elem){return parseInt(elem.id) + 1})
var length = elems.length;
// Setting many attributes
if ( typeof key === "object" ) {
//可以传入object类型参数,一次设置多个属性.
for ( var k in key ) {
jQuery.access( elems, k, key[k], exec, fn, value );
}
return elems;
}
// set方式
if ( value !== undefined ) {
exec = !pass && exec && jQuery.isFunction(value);
//pass默认是undefined的. 所以如果exec为true并且value
//是函数的话, value应该是这个函数的返回值.
for ( var i = 0; i < length; i++ ) {
//给集合内的每个元素都设置key,value.
//这里fn是jQuery.attr
fn( elems[i], key, exec ? value.call( elems[i], i, fn( elems[i], key ) ) : value, pass );
}
return elems;
}
// get方式
return length ? fn( elems[0], key ) : undefined;
}
access函数最后把参数又传递给了jQuery.attr, 在jQuery.attr里才真正进行setAttribute/getAttribute操作.
attr: function( elem, name, value, pass ) {
// don't set attributes on text and comment nodes
if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 ) {
return undefined;
}
if ( pass && name in jQuery.attrFn ) {
//jQuery.attrFn里包含了一些快捷方法, 如.html(), .text()
//如果name等于html,text这些, 直接调用这些快捷方法.
return jQuery(elem)[name](value);
}
var notxml = elem.nodeType !== 1 || !jQuery.isXMLDoc( elem ),
//确认不是xml文档
set = value !== undefined;
//判断是set方式还是get方式
name = notxml && jQuery.props[ name ] || name;
//修正 name, 比如class变成className.
if ( elem.nodeType === 1 ) {
var special = rspecialurl.test( name );
//如果name是 href || src || style, 特殊处理.
if ( name === "selected" && !jQuery.support.optSelected ) {
//对safari中select的特殊处理
var parent = elem.parentNode;
if ( parent ) {
parent.selectedIndex;
if ( parent.parentNode ) {
parent.parentNode.selectedIndex;
}
}
}
if ( (name in elem || elem[ name ] !== undefined) && notxml && !special ) {
//这个if分支是处理dom0方式. name in elem就可以判断出name是elem中一个已经存在的property,
//如果是这种情况, 实际上是通过dom0方式修改这个
//属性的值. 这次操作跟设置元素的特性无关.
//并且name不是style, href, src.
if ( set ) {
if ( name === "type" && rtype.test( elem.nodeName ) && elem.parentNode ) {
//input和button的type属性不能被改变
jQuery.error( "type property can't be changed" );
}
if ( value === null ) {
//value为null的话, 实际上remove掉这个特性.
if ( elem.nodeType === 1 ) {
elem.removeAttribute( name );
}
} else {
elem[ name ] = value;
//用dom0的方式set
}
}
if ( jQuery.nodeName( elem, "form" ) && elem.getAttributeNode(name) ) {
//表单元素返回的是nodeValue.
return elem.getAttributeNode( name ).nodeValue;
}
if ( name === "tabIndex" ) {
//如果tabIndex没有被显示设定, 可能得不到正确的值
var attributeNode = elem.getAttributeNode( "tabIndex" );
return attributeNode && attributeNode.specified ?
attributeNode.value :
rfocusable.test( elem.nodeName ) || rclickable.test( elem.nodeName ) && elem.href ?
0 :
undefined;
}
return elem[ name ];
//dom0方式, 返回属性值
}
if ( !jQuery.support.style && notxml && name === "style" ) {
//如果是set/get style.
if ( set ) {
elem.style.cssText = "" + value;
}
return elem.style.cssText;
}
if ( set ) {
//非dom0方式.
//除了IE之外的浏览器, getAttribute的返回值都是string类型.
//而IE中返回的是原始类型, 这里为了统一, setAttribute之前
//先转化为string
elem.setAttribute( name, "" + value );
}
// Ensure that missing attributes return undefined
// Blackberry 4.7 returns "" from getAttribute #6938
if ( !elem.attributes[ name ] && (elem.hasAttribute && !elem.hasAttribute( name )) ) {
//没有这个attribute的话, 返回undefined.
return undefined;
}
var attr = !jQuery.support.hrefNormalized && notxml && special ?
elem.getAttribute( name, 2 ) :
elem.getAttribute( name );
/
当dom节点的属性是一个超链接的时候, IE下面的反应不一样.
比如如果href是一个相对路径.它会把你的域名自动补全到href前面再返回.不过IE和firefox都提供了一个返回 原始文本值的方法. 即elem.getAttribute( "href", 2 ).
/
return attr === null ? undefined : attr;
}
}
})
再看看jQuery.prototype.removeAttr函数
removeAttr: function( name, fn ) {
return this.each(function(){
jQuery.attr( this, name, "" ); ------(1)设置为""有什么意义??
if ( this.nodeType === 1 ) {
this.removeAttribute( name ); -------------------(2)
}
});
}
代码很直观, (1)是掉用jQuery.attr删除dom0方式注册的属性. 具体实现原理可以重新跟着走一次jQuery.attr方法.(2)处是删除特性. 不过我有个疑问. 假如有这样一段代码.
$("#div1")[0].fff = 111;
$("#div1").removeAttr("fff");
alert ($("#div1")[0].fff); //firefox下是"", IE下是undefined.
就我个人的理解, 这2个值是应该统一的. 为什么IE和firefox返回的值不一样, 因为这个通过dom0方式注册的属性fff, 在IE下也是元素的特性,而在firefox下则不然. (1)处调用的jQuery.attr()只负责完把属性设置为""之后就退出了. 而(2)处的代码只能删除特性,所以实际上只在IE下起作用, 所以remove掉之后只有IE弹出的是undefined. 其实在(2)处的后面加上这样一句代码就OK了.
jQuery.support.deleteExpando && delete this[name];
看看几个跟元素的className有关的方法, 包括addClass, removeClass, toggleClass.
jQuery.prototype.addClass
先看看addClass方法, 给元素添加className. 元素可以同时有多个className. 每2个className中间以空格符来分开.
这个方法的思路很简单. 先取出原来的className, 再用新来的className和旧的className做比较. 旧的className中没有它, 就合并到原来的className字符串中.
addClass: function( value ) {
if ( jQuery.isFunction(value) ) {
//如果value是一个函数
return this.each(function(i) {
var self = jQuery(this);
self.addClass( value.call(this, i, self.attr("class")) );
//把函数的返回值当做参数重新调用addClass函数
});
}
if ( value && typeof value === "string" ) {
var classNames = (value || "").split( rspace );
//以空格为分割号, 把参数make成数组
for ( var i = 0, l = this.length; i < l; i++ ) {
//循环集合内每个元素, 依次addClass
var elem = this[i];
if ( elem.nodeType === 1 ) {
//确认是dom节点
if ( !elem.className ) {
elem.className = value;
//如果没有className属性, 直接把className设置为value
} else {
var className = " " + elem.className + " ", setClass = elem.className;
//加2个空格是为了统一className的格式, 方便后面的indexOf判断
for ( var c = 0, cl = classNames.length; c < cl; c++ ) {
if ( className.indexOf( " " + classNames[c] + " " ) < 0 ) {
//如果当前的className中没有
setClass += " " + classNames[c];
}
}
elem.className = jQuery.trim( setClass );
//去掉前后空格
}
}
}
}
return this;
}
jQuery.prototype.removeClass
删除元素的某个className
removeClass也是用旧的className字符串和参数比较. 如果有参数在这个字符串中, 说明元素包含了这个className. 把className中的这一段用空格replace掉. 如果参数为undefined. 清空元素所有的className,实际上就是直接把className设置为"".
removeClass: function( value ) {
if ( jQuery.isFunction(value) ) {
return this.each(function(i) { //这一段同addClass
var self = jQuery(this);
self.removeClass( value.call(this, i, self.attr("class")) );
});
}
if ( (value && typeof value === "string") || value === undefined ) {
//value为undefined时, remove掉所有的className.
var classNames = (value || "").split(rspace);
//需要remove掉的classNames, 数组形式
for ( var i = 0, l = this.length; i < l; i++ ) {
var elem = this[i];
if ( elem.nodeType === 1 && elem.className ) {
if ( value ) {
var className = (" " + elem.className + " ").replace(rclass, " ");
//当前的className中的多个空格合并成一个空格
for ( var c = 0, cl = classNames.length; c < cl; c++ ) {
className = className.replace(" " + classNames[c] + " ", " ");
//把需要被remove的className替换为""
}
elem.className = jQuery.trim( className );
} else {
elem.className = "";
//参数为undefined的时候, 清空className
}
}
}
}
return this;
}
jQuery.prorotype.toggleClass
三 切换元素的className
toggleClass就是addClass和removeClass操作的集合.
当这个方法有参数的时候. 如果元素有这个className, 就删除这个className. 反之添加.
如果toggleClass方法没有传入参数. 分别删除之前className和添加之前的className.
另外toggleClass还可以传入一个返回值为boolean的表达式, 当这个值为true时, 执行addClass, 为false时执行removeClass.
和addClass和removeClass一样, toggleClass的第一个参数也可以传入一个闭包.
第一种有参数的情况比较容易想到怎么做. 就是判断当前的className集合, 根据当中有没有跟参数一样的className来看是执行add还是remove操作.
如果没有参数的情况下, 要删除原来所有的className. 这时需要把原来的className设置到元素的缓存当中.以便可以在下次toggleClass的时候恢复.
看代码
toggleClass: function( value, stateVal ) {
var type = typeof value, isBool = typeof stateVal === "boolean";
if ( jQuery.isFunction( value ) ) {
return this.each(function(i) { //同addClass和removeClass
var self = jQuery(this);
self.toggleClass( value.call(this, i, self.attr("class"), stateVal), stateVal );
});
}
return this.each(function() {
if ( type === "string" ) {
var className, i = 0, self = jQuery(this),
state = stateVal,
classNames = value.split( rspace );
//需要切换的className, 数组形式
while ( (className = classNames[ i++ ]) ) {
//循环数组, 里面的每个className都需要被切换
state = isBool ? state : !self.hasClass( className );
self[ state ? "addClass" : "removeClass" ]( className );
//看元素是执行addClass还是removeClass.
}
} else if ( type === "undefined" || type === "boolean" ) {
//删除所有的className或者把原来的所有className重新添加上
if ( this.className ) {
jQuery.data( this, "__className__", this.className );
//缓存原来的className
}
this.className = this.className || value === false ? "" : jQuery.data( this, "__className__" ) || "";
//切换元素的className为空或者为缓存的className
}
});
}
jQuery.prototype.hasClass
判断是否含有某个特定的className
hasClass是检查当前的元素是否含有某个特定的className, 代码很直观. 不过在判断前也要记得先把className字符串中的多个空格合并成一个.
hasClass: function( selector ) {
var className = " " + selector + " ";
for ( var i = 0, l = this.length; i < l; i++ ) {
if ( (" " + this[i].className + " ").replace(rclass, " ").indexOf( className ) > -1 ) {
return true;
}
}
return false;
}
jQuery.prototype.val
取得或者设置一个元素的值, 也可以给一组元素, 比如checkbox, radio设置值, 参数是数组形式. 这个方法一般只用于select radio checkbox input textarea等.
这个函数很长, 但代码比较简单. 很多代码都在处理单选select, 多选select, redio, checkbox.
val: function( value ) {
if ( value === undefined ) {
//get方式
var elem = this[0];
//获取第一个元素
if ( elem ) {
//确认元素存在
if ( jQuery.nodeName( elem, "option" ) ){
//如果是option
return (elem.attributes.value || {}).specified ? elem.value : elem.text;
//如果元素没有value属性, 在IE和firefox下 (elem.attributes.value || {}).specified分别等于false/undefined. 这时返回元素的text.
//默认情况下, 如果元素没有value属性. firefox会把元素的text代替value返回. 这里主要是针对IE做的处理.
}
if ( jQuery.nodeName( elem, "select" ) ) {
//如果元素是select, 要处理单选和多选的情况. 多
//选下拉框把所有选中option的value组合成一个数组.
var index = elem.selectedIndex,
//第一个选中的option的index
values = [],
//如果是多选下拉框, 这个数组用来装载所有选中
//的option的value
options = elem.options,
one = elem.type === "select-one";
//elem.type === "select-one"时为单选下拉框, 另外
//一种情况是 type="select-multiple"
if ( index < 0 ) {
return null;
}
//没有被选中的, 返回null.
for ( var i = one ? index : 0, max = one ? index + 1 : options.length; i < max; i++ ) {
/
循环所有的option,这个变态的循环主要是为了减少循环的次数.
如果是select-one形式, 作用不变,还是判断一次. 也就是从index 到index+1的这次.就是当前被选中的option.
如果是select-multiple形式, 从第一个被选中的option开始判断到最后, 第一个被选中的前面的option就不用再判断了.
/
var option = options[ i ];
if ( option.selected ) {
value = jQuery(option).val();
//取得每个被选中option的value
if ( one ) {
return value;
//select-one形式, 返回单个值
}
values.push( value );
//select-multiple形式, push进一个数组, 在下面返回.
}
}
return values;
}
if ( rradiocheck.test( elem.type ) && !jQuery.support.checkOn ) {
//如果是radio或者checkbox元素, 并且没有默认的值"on", 主要是兼容safari.
return elem.getAttribute("value") === null ? "on" : elem.value;
//如果value为null, 返回"on", 跟其它浏览器兼容.
}
return (elem.value || "").replace(rreturn, "");
//其它情况下, 直接返回elem的value. 并且把回车符也替换为"".
}
return undefined;
}
//从下面开始进入set方式
var isFunction = jQuery.isFunction(value);
//如果参数为函数, 这个函数的返回值才是要真正要设置的value.
return this.each(function(i) {
//给集合中每个元素都设置
var self = jQuery(this), val = value;
if ( this.nodeType !== 1 ) {
//需保证是dom节点.
return;
}
if ( isFunction ) {
val = value.call(this, i, self.val());
//求出返回值
}
if ( typeof val === "number" ) {
val += "";
//数字转化为字符串.
}
if ( jQuery.isArray(val) && rradiocheck.test( this.type ) ) {
//如果当前元素是radio或者checkbox, 并且参数value是数组.
this.checked = jQuery.inArray( self.val(), val ) >= 0;
/*
inArray是返回索引的, >=0后其实就是等于inArray返回true/false一样的效果.
也就是说当前元素的value在数组中的话,就把当前元素的checked设置为true.
*/
} else if ( jQuery.nodeName( this, "select" ) ) {
//如果当前元素是select
var values = jQuery.makeArray(val);
jQuery( "option", this ).each(function() {
/*取得这个selector下的所有option再遍历每一个
jQuery("option", this)相当于$(this).find("option")
*/
this.selected = jQuery.inArray( jQuery(this).val(), values ) >= 0;
//当前元素的value在数组中的话,就把当前元素的selected设置为true.
});
if ( !values.length ) {
this.selectedIndex = -1;
//如果数组为空, 不选中任何option.
}
} else {
this.value = val;
//其它情况, 也是最常用的情况, 直接设置value.
}
});
}
});
jQuery.prototype.text
相当于IE中的innerText. set/get某个元素的文本值.
text: function( text ) {
if ( jQuery.isFunction(text) ) {
//如果参数是函数
return this.each(function(i) {
var self = jQuery(this);
self.text( text.call(this, i, self.text()) );
//函数的返回值,作为参数重新调用此方法
});
}
if ( typeof text !== "object" && text !== undefined ) {
//set方式
return this.empty().append( (this[0] && this[0].ownerDocument || document).createTextNode( text ) );
//用元素的根元素(若没有,就用document)创建一个文本节点.
//然后清空元素的子节点,把刚刚创建的文本节点append进去.
}
return jQuery.text( this );
//如果是get, 调用getText函数, 在源码的第3680行, jQuery.text = getText.
}
再看getText函数, getText会遍历集合中的所有元素, 把每个元素的文本值加起来拼成一个字符串返回.
function getText( elems ) {
var ret = "", elem;
for ( var i = 0; elems[i]; i++ ) {
elem = elems[i];
//遍历集合中的所有元素.
if ( elem.nodeType === 3 || elem.nodeType === 4 ) {
//如果是文本节点或者<![CDATA[ ]]>文本节点
ret += elem.nodeValue;
//拼接nodeValue
} else if ( elem.nodeType !== 8 ) {
ret += getText( elem.childNodes );
//如果元素不是注释节点的话, 把子节点的nodeValue也拼接进来
}
}
return ret;
//返回拼接好的字符串
jQuery.prototype.html
set/get每一个匹配元素的html内容. 做法就是先用innerHTML,如果innerHTML抛出异常,则用this.empty().append( value ).还要记得清空子节点上的缓存,避免内存泄露.
html: function( value ) {
if ( value === undefined ) {
//get方式.val()函数里已经改成了!arguments.length.这里还
//是用的value===undefined.咋就不能统一呢?
return this[0] && this[0].nodeType === 1 ?
this[0].innerHTML.replace(rinlinejQuery, "") :
null;
} else if ( typeof value === "string" && !rnocache.test( value ) &&
(jQuery.support.leadingWhitespace || !rleadingWhitespace.test( value )) &&
!wrapMap[ (rtagName.exec( value ) || ["", ""])[1].toLowerCase() ] ) {
value = value.replace(rxhtmlTag, "<$1></$2>");
//修正一些不规范的html标签
try {
for ( var i = 0, l = this.length; i < l; i++ ) {
// Remove element nodes and prevent memory leaks
if ( this[i].nodeType === 1 ) {
jQuery.cleanData( this[i].getElementsByTagName("*") );
//清空所有子元素的缓存,避免内存泄露.
this[i].innerHTML = value;
//用快捷方式innerHTML
}
}
} catch(e) {
this.empty().append( value );
//如果innerHTML抛出异常, 用this.empty().append( value ).
//先清空子节点, 再把value append进去.
}
} else if ( jQuery.isFunction( value ) ) {
//参数是闭包函数
this.each(function(i){
var self = jQuery(this);
self.html( value.call(this, i, self.html()) );
//取得函数的返回值, 重新调用.html(value)
});
} else {
this.empty().append( value );
//其他情况
}
return this;
}
<br><br>
作者: <a href="http://gengzhelun619-163-com.javaeye.com">__游乐场</a>
<br>
声明: 本文系JavaEye网站发布的原创文章,未经作者书面许可,严禁任何网站转载本文,否则必将追究法律责任!
<br><br>
<span style="color:red">
<a href="http://www.javaeye.com/topic/793835" style="color:red">已有 <strong>0</strong> 人发表回复,猛击->><strong>这里</strong><<-参与讨论</a>
</span>
<br><br><br>
JavaEye推荐