一、jQuery.clean 使用方法
jQuery.clean( elems, context, fragment, scripts );
二、思路分析
1、處理 context 參數,確保其為文件根節點 document。
2、處理 elems 陣列(迴圈遍歷):
2.1、elem 為數字時,轉為字串。
2.2、elem 為非法值時,跳過本次迴圈。
2.3、elem 為字串時:
2.4、若字串不含實體編號或 html 標籤,則建立文字節點。
2.5、若為實體編號或 html 標籤,則建立 div 並插入文件片段、處理 xhtml 風格標籤、將 elem 包裹後作為 div 的 innerHTML;若包裹深度大於 1,只保留第一層;清除 IE6/7 中空 table 自動加入的 tbody;把 IE9 以下被剝除的開頭空白字串補回為 div 的第一個文字子節點;最後把 elem 重新指派為 div 的子節點集合,並移除該 div 以保持乾淨。
2.6、若 elem 為文字節點,直接加入回傳的 ret 陣列,否則把 nodeList 中的節點合併進去。
2.7、修復 IE6/7 中 radio、checkbox 節點選中狀態 (checked) 失效的 bug。
3、處理 fragment 參數:把 ret 各節點加入文件片段,並抽出其中的 script 子節點加到 ret 陣列(位置在其原父元素之後)。
4、回傳 ret 陣列。
三、源碼註解分析
1、函式中用到的變數與函式:
var nodeNames = "abbr|article|aside|audio|bdi|canvas|data|datalist|details|figcaption|figure|footer|" +
"header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",
wrapMap = {
option: [ 1, "<select multiple='multiple'>", "</select>" ],
legend: [ 1, "<fieldset>", "</fieldset>" ],
thead: [ 1, "<table>", "</table>" ],
tr: [ 2, "<table><tbody>", "</tbody></table>" ],
td: [ 3, "<table><tbody><tr>", "</tr></tbody></table>" ],
col: [ 2, "<table><tbody></tbody><colgroup>", "</colgroup></table>" ],
area: [ 1, "<map>", "</map>" ],
_default: [ 0, "", "" ]
},
rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,
rtagName = /<([\w:]+)/,
rtbody = /<tbody/i,
rhtml = /<|?\w+;/,
rleadingWhitespace = /^\s+/,
rcheckableType = /^(?:checkbox|radio)$/,
rscriptType = /\/(java|ecma)script/i;
// 設定 checkbox 或 radio 表單元素的預設選中狀態
function fixDefaultChecked( elem ) {
if ( rcheckableType.test( elem.type ) ) {
elem.defaultChecked = elem.checked;
}
}
// 建立一個安全的文件片段
function createSafeFragment( document ) {
var list = nodeNames.split( "|" ),
safeFrag = document.createDocumentFragment();
if ( safeFrag.createElement ) {
while ( list.length ) {
safeFrag.createElement( list.pop() );
}
}
return safeFrag;
}
2、clean 主體源碼(含中文註解)如下:
jQuery.extend({
clean: function( elems, context, fragment, scripts ) {
var i, j, elem, tag, wrap, depth, div, hasBody, tbody, len, handleScript, jsTags,
safe = context === document && safeFragment,
ret = [];
// 確保 context 為文件根節點 document
if ( !context || typeof context.createDocumentFragment === "undefined" ) {
context = document;
}
for ( i = 0; (elem = elems[i]) != null; i++ ) {
if ( typeof elem === "number" ) { elem += ""; } // 數字轉字串
if ( !elem ) { continue; } // 非法值跳過
if ( typeof elem === "string" ) {
if ( !rhtml.test( elem ) ) { // 非 html,建立文字節點
elem = context.createTextNode( elem );
} else {
safe = safe || createSafeFragment( context );
div = context.createElement("div");
safe.appendChild( div );
elem = elem.replace(rxhtmlTag, "<$1></$2>"); // 修正 xhtml 風格標籤
tag = ( rtagName.exec( elem ) || ["", ""] )[1].toLowerCase();
wrap = wrapMap[ tag ] || wrapMap._default;
depth = wrap[0];
div.innerHTML = wrap[1] + elem + wrap[2];
while ( depth-- ) { div = div.lastChild; } // 剝除多餘包裹
// 清除 IE 為空 table 自動插入的 tbody
if ( !jQuery.support.tbody ) {
hasBody = rtbody.test(elem);
tbody = tag === "table" && !hasBody ?
div.firstChild && div.firstChild.childNodes :
wrap[1] === "<table>" && !hasBody ?
div.childNodes : [];
for ( j = tbody.length - 1; j >= 0 ; --j ) {
if ( jQuery.nodeName( tbody[ j ], "tbody" ) && !tbody[ j ].childNodes.length ) {
tbody[ j ].parentNode.removeChild( tbody[ j ] );
}
}
}
// IE9 以下補回被剝除的開頭空白
if ( !jQuery.support.leadingWhitespace && rleadingWhitespace.test( elem ) ) {
div.insertBefore( context.createTextNode( rleadingWhitespace.exec(elem)[0] ), div.firstChild );
}
elem = div.childNodes;
div.parentNode.removeChild( div ); // 移除暫時的 div
}
}
if ( elem.nodeType ) { ret.push( elem ); } // DOM 節點直接加入
else { jQuery.merge( ret, elem ); } // nodeList 合併
}
if ( div ) { elem = div = safe = null; }
// 修復 IE6/7 中 radio、checkbox 插入後選中狀態失效 (#8060)
if ( !jQuery.support.appendChecked ) {
for ( i = 0; (elem = ret[i]) != null; i++ ) {
if ( jQuery.nodeName( elem, "input" ) ) {
fixDefaultChecked( elem );
} else if ( typeof elem.getElementsByTagName !== "undefined" ) {
jQuery.grep( elem.getElementsByTagName("input"), fixDefaultChecked );
}
}
}
// 把各節點加入文件片段,並抽出其中的 script
if ( fragment ) {
handleScript = function( elem ) {
if ( !elem.type || rscriptType.test( elem.type ) ) {
return scripts ?
scripts.push( elem.parentNode ? elem.parentNode.removeChild( elem ) : elem ) :
fragment.appendChild( elem );
}
};
for ( i = 0; (elem = ret[i]) != null; i++ ) {
if ( !( jQuery.nodeName( elem, "script" ) && handleScript( elem ) ) ) {
fragment.appendChild( elem );
if ( typeof elem.getElementsByTagName !== "undefined" ) {
jsTags = jQuery.grep( jQuery.merge( [], elem.getElementsByTagName("script") ), handleScript );
ret.splice.apply( ret, [i + 1, 0].concat( jsTags ) );
i += jsTags.length;
}
}
}
}
return ret;
}
});
整體而言,clean 的核心價值在於把「字串形式的 HTML」安全地轉換為 DOM 節點,同時處理了各瀏覽器(尤其舊版 IE)在 innerHTML、tbody、空白節點與表單狀態上的種種相容性問題,是 jQuery 內部相當關鍵的一環。