jQuery升級踩的那些坑

HorstXu發表於2016-01-13
jQuery

背景

jQuery想必各個web工程師都再熟悉不過了，不過現如今很多網站還採用了很古老的jQuery版本。其實如果早期版本使用不當，可能會有DOMXSS漏洞，非常建議升級到jQuery 1.9.x或以上版本。前段時間我就主導了這件事情，把公司裡我們組負責的專案jQuery版本從1.4.2升級到了jQuery 1.11.3。jQuery官方也為類似升級工作提供了jQuery Migrate外掛。

言歸正傳。

坑從何處來

jQuery 1.11.3是1.x時代的最後一個版本（作者更新：2016年1月8日，jQuery 1.12.0上線，jQuery 1.11.3不再是1.x時代最後一個版本了），由於我的部門專案已經有一定年頭了，當時還是採用的jQuery 1.4.2，這次升級步子邁得算是比較大。早期時候jQuery的很多寫法，在新版本中已經被廢棄，亦或者有些不規範的寫法，當時版本還能支援，但是現在已經不支援。更糟糕的情況是，新版本還支援，但是功能已經和以前不一樣了……這種情況連個錯都不會報，需要深入到程式碼邏輯裡面去看。

jQuery官方推薦了jQuery Migrate 庫來解決jQuery升級問題。不過一直採用這個庫終究不是長久之計，開發中建議使用jQuery Migrate的開發版，可以在瀏覽器控制檯上列印出來不相容的地方詳細資訊。需要注意的是開發中一定要使用jQuery Migrate的開發版，因為壓縮版的是不會在控制檯給出警告的……把jQuery Migrate的庫緊跟在jQuery庫後面引用即可：

<script src="<path>/<to>/jquery-1.11.3.js"></script>
<script src="<path>/<to>/jquery-migrate-1.2.1.js"></script>

等升級完畢，確定沒問題了之後，再將jQuery Migrate庫去掉就可以了。根據個人經驗，下面我把坑分成 常見坑，少見坑兩類來論述。

常見坑

1. 使用了被廢棄的jQuery.fn.live方法

jQuery Migrate庫對此錯誤也在控制檯有相應的警告：

JQMIGRATE: jQuery.fn.live() is deprecated

live方法原本的作用是設定事件代理，該方法在jQuery 1.7之後就不推薦使用了，取代之的是jQuery.fn.on函式。他們的介面分別是：

$(selector).live('click', function(){/* some code */});
$(selector).on('click', [selector,] function(){/* some code */});

乍一看，中括號裡面的引數可以省略掉，倆函式不是一模一樣麼？於是天真地把函式名live直接替換成on，大部分時候，這麼做好像沒有引起任何異常。但是如果在你呼叫on函式的時候，前面的$(selector)在當前的網頁上根本不匹配任何元素（該元素可能是後面的程式碼才加到DOM裡的），那是不會繫結成功的。事實上，live函式將$(selector)代理到了document元素上，這個元素是肯定存在的，所以不會出現類似情況。正確的替換方法應該是：

$(selector).live('click', function(){/* some code */}); 替換為
$(document).on('click', selector, function(){/* some code */});

2. 使用了被廢棄的jQuery.fn.die方法

jQuery Migrate對此錯誤的警告是：

JQMIGRATE: jQuery.fn.die() is deprecated

這個方法和前面的live剛好反過來，取消事件處理函式的繫結。新版本中應該使用off函式代替之，替換方式類似。

3. 使用了被廢棄的jQuery.fn.toggle函式

jQuery Migrate對此錯誤的警告是：

JQMIGRATE: jQuery.fn.toggle(handler, handler...) is deprecated

早期jQuery中名字叫toggle的函式有兩個，一個是用於控制元素的顯示和隱藏，這個用途的函式目前jQuery中依舊存在；另一個就是上面提到的被廢棄的toggle函式，它用於繫結至少兩個函式到同一個元素，點選該元素的時候兩個函式交替著執行。這兩個同名函式功能相差甚遠，為了不引起誤導，在jQuery 1.8中就不再建議使用了。替換的方式是把兩個函式合併成一個函式的if-else兩個區段，然後自己設定一個boolean變數，控制每次點選時應該執行哪個區段即可。

4. 使用了被廢棄的jQuery.browser屬性

jQuery Migrate對此錯誤的警告是

JQMIGRATE: jQuery.browser is deprecated

在前端開發中我們經常要根據不同的瀏覽器版本做出不同的處理，jQuery.browser本來是通過瀏覽器的userAgent欄位來提取瀏覽器相關資訊的。新版本中已經將其廢棄，而是建議使用特徵檢測的方法去判斷，並且給了一個Modernizr庫作為推薦。不過，改成這個庫可能改動成本有點大，如果你還是想沿用jQuery.browser的思路的話，可以自己去實現一下它。例如，判斷是不是IE瀏覽器，可以用

/msie/.test(navigator.userAgent.toLowerCase());

即自己手動獲取userAgent欄位，並且做一個正規表示式匹配。其他瀏覽器思路類似，都是對navigator.userAgent做一個正則匹配。

5. $(html)格式書寫錯誤

在jQuery Migrate中，出現以下三種警告中的任何一種，都是屬於這個錯誤：

1. JQMIGRATE: $(html) HTML strings must start with '<' character
2. JQMIGRATE: $(html) HTML text after last tag is ignored
3. JQMIGRATE: HTML string cannot start with a '#' character

這個錯誤還是蠻值得注意的，因為我們文章開頭所說的jQuery低版本有XSS漏洞，其實就是和這個錯誤有關係。在javascript中我們經常會直接將一段html格式的字串寫在jQuery引用裡面，比如$('<div></div>')。按照新版本的jQuery要求，這段html格式的字串必須是以左尖括號（小於號）開頭，其他字元都不可以。以下幾種寫法，都是錯誤的：

1. $(" <div></div>"); //錯誤，字串最開頭有一個空格，不是以小於號'<'開頭的
2. $("<div></div>test"); //不標準，html標籤結束後後面還有多餘的"test"，它會被忽略
3. $("#<div></div>); //錯誤，以井號開頭並且後面並不是一個css選擇器

這一點在書寫的時候注意一下就可以了，其實還是很容易避免的。其中第三種錯誤其實就不僅僅是警告了，jQuery會直接丟擲一個錯誤，停止javascript程式碼的繼續執行。一般情況以井號開頭，例如$("#test")，其實就是一個普通的選擇器，但是上面例子中後面又夾雜著html字串，這會被jQuery判斷為潛在的XSS攻擊。

6. jQuery.fn.attr方法的錯誤使用（這是個非常易犯的錯誤！）

jQuery Migrate中，關於attr方法的警告有以下這些：

1. JQMIGRATE: jQuery.fn.attr('value', val) no longer sets properties
2. JQMIGRATE: jQuery.fn.attr('value') no longer gets properties
3. JQMIGRATE: jQuery.fn.attr('checked') may use property instead of attribute
4. JQMIGRATE: jQuery.fn.attr( props, pass ) is deprecated

實踐中我發現，早期寫的程式碼裡面，獲取一個input輸入表單的值時，是怎麼獲取的呢？$('input').attr('value')；又是怎麼設定的呢？$('input').attr('value', 'helloworld')。這在新版本中都是不正確的！正確的做法應該是

$('input').val(); //獲取input表單現在所輸入的值
$('input').val('helloworld'); //設定input表單輸入的值

到底是獲取還是設定，只取決於呼叫val方法時有沒有帶著引數。

如果你想手動設定單選框（例如<input type="radio" >）被選中，應該怎麼設定呢？老的程式碼裡面可能會看到這樣 $('input').attr('checked', true)或者$('input').attr('checked', 'checked')。這些現在也都是不正確的！正確的做法應該是

$('input').prop('checked', true); //把單選框設為選中狀態
$('input').prop('checked'); //獲取單選框是不是被選中了，返回true或false

這是從jQuery 1.6版本開始使用的寫法。如果設定disabled和selected屬性，也是使用prop方法。那到底什麼時候使用attr方法呢？兩者的區別是：prop設定的是某元素固有的屬性，而attr設定的是寫在html標籤上的自定義屬性。舉個例子：

<input type="checkbox" checked="checked" haha="hello" >
var v1 = $('input').prop("checked"); //返回true/false，是否被選中，隨狀態改變而改變
var v2 = $('input').attr("checked"); //返回"checked"，這是你設定在標籤上的，不會變
var v3 = $('input').attr("haha"); //返回"hello"，自定義屬性
var v4 = $('input').prop("haha"); //返回undefined，根本沒有這個固有屬性

上面提到的第四個錯誤，jQuery.fn.attr(props, pass) is deprecated這個警告在真實專案中從未見到過，看了一下原始碼，觸發該警告的jQuery寫法很少見，可忽略。

7. 向$.parseJSON傳入了非法的引數

在jQuery Migrate中，該錯誤產生如下警告

JQMIGRATE: jQuery.parseJSON requires a valid JSON string

jQuery之所以改這個介面，是為了和瀏覽器自帶的JSON.parse介面對齊，從jQuery 1.9開始生效。這個問題常見於AJAX接收服務端返回值的時候。服務端可能返回一個空字串，這時候呼叫該介面會產生錯誤。必須向$.parseJSON傳入合法的JSON字串。修正方法如下：

var v1 = $.parseJSON(str); 替換為
var v1 = $.parseJSON( str ? str : "null" );

8. 使用了被廢棄的’hover’事件字串

在jQuery Migrate中該錯誤產生如下警告

JQMIGRATE: 'hover' pseudo-event is deprecated, use 'mouseenter mouseleave'

在註冊事件處理函式時，’hover’以前可以看作是’mouseenter mouseleave’兩個事件的別稱。目前已經將該別稱去掉了，所以程式碼中請用’mouseenter mouseleave’替換之。

9. jQuery.fn.andSelf已經被替換，不能再使用

jQuery Migrate中是這樣的警告：

JQMIGRATE: jQuery.fn.andSelf() replaced by jQuery.fn.addBack()

兩個函式功能是完全一樣的，可以直接替換。

以上，就是在jQuery升級中常見的問題，當然，本著精益求精的精神，我們還是需要研究一下不常見的問題是什麼樣子的。需要指出的是：下面的問題在我的實際專案中從來沒有碰到過，比較少見，但也無法保證一定不會出現在你的專案中，僅供感興趣的程式設計師們參考吧。

少見坑

1. jQuery不相容瀏覽器的怪異模式

這個錯誤的觸發方式非常簡單，直接把html頁面最頂端的<!DOCTYPE html>標籤刪掉就可以了。瀏覽器怪異模式是為了相容老古董網頁而設計的，詳情可參考這篇文章：連結。我想現在的WEB程式設計師應該不會傻到不寫DOCTYPE，也很少使用這種模式下的瀏覽器吧。

jQuery Migrate展示的錯誤警告如下：

2. AJAX全域性事件必須繫結到document節點上

jQuery Migrate中的警告如下：

JQMIGRATE: AJAX events should be attached to document: ajaxStart

jQuery中AJAX全域性事件包括如下介面ajaxStart, ajaxStop, ajaxSend, ajaxComplete, ajaxError, ajaxSuccess。因為這些事件使用的比較少，所以也歸在少見坑當中。從jQuery 1.9開始，這些事件只能繫結到$(document)上。改正方法如下（摘自jQuery官網）：

$("#status").ajaxStart(function(){ $(this).text("Ajax started"); }); 修改為
$(document).ajaxStart(function(){ $("#status").text("Ajax started"); });

3. IE6/7/8瀏覽器不支援修改input表單的type屬性

在jQuery Migrate中是這樣的警告：

JQMIGRATE: Can't change the 'type' of an input or button in IE 6/7/8

改變input的表單的type屬性，你可以直接把文字框改成單選框，改成多選框等等。雖然我感覺這是一種並不算優雅的行為，但是很多瀏覽器都是支援這麼做的，除了IE6/7/8。建議在實際中也是少用這個功能為好。

4. 使用了被移除的$.clean, $.event.handle, $.attrFn, $.fn.data('events'), jQuery.event.trigger屬性與方法

在jQuery Migrate中是這樣的警告：

1. JQMIGRATE: jQuery.clean() is deprecated
2. JQMIGRATE: jQuery.event.handle is undocumented and deprecated
3. JQMIGRATE: jQuery.attrFn is deprecated
4. JQMIGRATE: Use of jQuery.fn.data('events') is deprecated
5. JQMIGRATE: Global events are undocumented and deprecated

如果你在自己的程式碼中使用過這五個介面，那確實是仔細研究過jQuery原始碼的高人啊。因為這五個介面從來沒有出現在jQuery的官方文件中，並且有些在後續版本中已經刪除，可謂來無影去無蹤。看原始碼的話在早期版本有機會找到他們的存在，但是並不建議使用。建議採用其他方法實現相應的功能。什麼？你不知道這五個函式是什麼功能？那最好了，你現在也不需要知道了……

5. 使用了過時的$.sub()方法

jQuery Migrate中對本問題的警告如下：

JQMIGRATE: jQuery.sub() is deprecated

這個介面非常簡單，不接受任何引數。它用來建立一個jQuery的副本。該方法在jQuery 1.7版本開始就已經不再使用。

6. 使用了過時的jQuery.fn.error方法

jQuery Migrate中對本問題的警告如下：

JQMIGRATE: jQuery.fn.error() is deprecated

在jQuery中，error也是和click一樣的事件。註冊該事件的處理函式，以前是$(selector).error(function(){})，現在已經被廢棄，可以使用$(selector).on('error', function(){})來替代。

示例程式碼

本文既然自稱為“XX大全”，那就應該儘量的全面一些。為了搞明白這些坑是怎麼踩進去的，我們最後來寫一段js程式碼，要求是用最少的程式碼，把jQuery Migration庫中所有的坑都踩一遍……也就是讓jQuery Migration庫列印出來它能列印的所有警告。最終的程式碼如下所示（部落格園竟然沒有辦法上傳附件，只能貼程式碼了），非常簡單易懂。開啟index.html檔案，然後再按F12鍵開啟控制檯，你就可以看到壯觀巨集偉的控制檯警告了^_^

<!-- filename : index.html -->
<!--<!DOCTYPE html>--> //keng0 怪異模式
<html>
    <head>
        <meta charset="utf-8" />
        <title>jQuery升級踩坑大全</title>
        <script type="text/javascript" src="http://code.jquery.com/jquery-2.1.4.min.js" ></script>
        <script type="text/javascript" src="http://code.jquery.com/jquery-migrate-1.2.1.js" ></script>
    </head>
    <body>
        <div class="test" id="a">a</div>
        <input type="radio" id="b" value="b" />
        <input type="radio" id="c" value="c" />
        <div id="d" value="d">test</div>
        <script type="text/javascript">
            //開始踩坑

            //使用被廢棄分$.attrFn方法
            var keng1 = $.attrFn || {};

            //該函式在jQuery內部呼叫，真實專案中從未見過，可忽略，這裡只是為了觸發一下錯誤警告
            var keng2 = $.attr($("#a"), "class", "xxx", true);

            //IE6、7、8中不支援改變輸入框的型別
            var keng3 = $("input#b").attr("type", "text");

            //在該使用prop的地方使用了attr
            var keng4 = $("input#c").attr("checked", true);

            //使用attr獲取property的值，正確的是應該使用 .val()
            var keng5 = $("div#d").attr("value");

            //使用attr設定property的值，正確的是應該使用 .val('somevalue')
            var keng6 = $("div#d").attr("value", "abcd");

            //html字串必須以'<'開頭(下面這個是以空格開頭)
            var keng7 = $(" <div></div>");

            //最後一個tag後面還有多餘字串
            var keng8 = $("<div></div>abc");

            //html字串不可以以井號‘#’開頭
            try{
                var keng9 = $("#<div></div>");
            }catch(e){
                console.error(e);
            }

            //$.parseJSON的引數必須是合法的JSON字串
            var keng10 = $.parseJSON(undefined);

            //使用被廢棄的$.browser
            var keng11 = $.browser;

            //使用被廢棄的$.sub
            var keng12 = $.sub();

            $("#c").on("click", function(){});
            var keng13 = $("#c").data("events");

            //呼叫了已經不再使用的函式andSelf，該函式已經被addBack替代
            var keng14 = $("#c").nextAll().andSelf();

            //使用被廢棄的$.clean方法
            try{
                var keng15 = $.clean();
            }catch(e){
                console.error(e);
            }

            //"hover"字串註冊事件已經被拆成"mouseenter"和"mouseleave"兩個
            var keng16 = $("#d").on("hover", function(){/*some code*/});

            //jQuery.event.handle並沒有收錄到官方的API中，新版本已經被移除
            var keng17 = function(){
                $.event.handle.apply(this, arguments);
            };

            //全域性AJAX事件處理必須繫結到document物件上
            var keng18 = $("#c").ajaxStart(function(){});

            //使用了被廢棄的error方法
            var keng19 = $("#c").error(function(){});

            //使用了被廢棄的toggle方法
            var keng20 = $("#d").toggle(function(){/*some code*/}, function(){/*some code*/});

            //使用了被廢棄的live方法，應該使用on方法替代之
            var keng21 = $("#a").live("click", function(){/*some code*/});

            //使用了被廢棄的die方法，應該使用off方法替代之
            var keng22 = $("#a").die("click");

            //使用了全域性事件函式，目前全域性事件只支援AJAX那幾個，其他全域性事件都不支援
            var keng23 = $.event.trigger("click");        

        </script>
    </body>
</html>

相關文章