jQuery编码规范和最佳实践

[Go7hic]

加载jQuery 1、尽量使用CDN加载（ CDN Benefits）

    <script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
    <script>window.jQuery || document.write('<script src="js/jquery-1.11.0.min.js" type="text/javascript"><\/script>')</script>

一些流行的jquery cdns:

    Google: https://developers.google.com/speed/libraries/devguide 
    Microsoft: http://www.asp.net/ajaxlibrary/cdn.ashx 
    jQuery: http://jquery.com/download/ 
    cdnjs: http://cdnjs.com 
    OSSCdn: http://osscdn.com

2、就像上面的代码一样，在CDN加载失败时，要回源到本地服务器的同版本jQuery。

3、使用依赖协议的URL（不加http:和https:，直接使用//），参看上面的例子。

4、尽可能在页面底部加载jQuery和javascript。

5、如何选择jQuery版本？

如果要兼容IE6/7/8，不要使用2.x版本的 对于新的应用，如果不考虑一些插件的兼容性问题，尽可能的使用最新版 从CDN加载jQuery的时候，使用完整的版本号（例如，使用1.11.0，不用1.11和1） 不要加载多个版本的jQuery 6、如果你使用了Prototype, MooTools, Zepto等，尝试使用jQuery代替$。可以使用$.noConflict()让出$的控制权。

jQuery变量 1、所有被缓存的jQuery对象，变量名以$开头。

2、总是缓存jQuery选择器返回的对象，方便复用：

    var $myDiv = $("#myDiv");
    $myDiv.click(function(){...});

3、使用驼峰命名。

选择器 1、尽可能的使用ID选择器。ID选择器使用document.getElementById()，所以更快。

2、当使用类选择器的时候，不要加DOM元素类型：

    var $products = $("div.products"); // SLOW
    var $products = $(".products"); // FAST

3、使用find查找ID->Child的嵌套查询，.find()方法更快，因为第一次选择没有使用jQuery的选择器引擎：

    // BAD, a nested query for Sizzle selector engine
    var $productIds = $("#products div.id");

    // GOOD, #products is already selected by document.getElementById() so only div.id needs to go through Sizzle selector engine
    var $productIds = $("#products").find("div.id");

4、越靠右侧越具体：

    // Unoptimized
    $("div.data .gonzalez");

    // Optimized
    $(".data td.gonzalez");

5、选择器不要太“具体”：

    $(".data table.attendees td.gonzalez");

    // Better: Drop the middle if possible.
    $(".data td.gonzalez");

6、给选择器指定上下文（限定范围）：

    // SLOWER because it has to traverse the whole DOM for .class
    $('.class');

    // FASTER because now it only looks under class-container.
    $('.class', '#class-container');

7、避免使用“*”：

    $('div.container > *'); // BAD
    $('div.container').children(); // BETTER

8、避免隐式使用“*”：

    $('div.someclass :radio'); // BAD
    $('div.someclass input:radio'); // GOOD

9、不要使用多个ID选择器，或者嵌套使用ID选择器，单独的ID选择器使用document.getElementById()，速度很快：

    $('#outer #inner'); // BAD
    $('div#inner'); // BAD
    $('.outer-container #inner'); // BAD
    $('#inner'); // GOOD, only calls document.getElementById()

DOM操作 1、先把元素分离出DOM结构，再进行复杂的操作，之后再附加回DOM中。不明白原因的话，可以了解下.detach()这个方法

    var $myList = $("#list-container > ul").detach();

    //...a lot of complicated things on $myList
    $myList.appendTo("#list-container");

2、使用字符串连接或者array.join()，少用.append()，点击这里查看性能比较。

    // BAD
    var $myList = $("#list");
    for(var i = 0; i < 10000; i++){
        $myList.append("<li>"+i+"</li>");
    }

    // GOOD
    var $myList = $("#list");
    var list = "";
    for(var i = 0; i < 10000; i++){
        list += "<li>"+i+"</li>";
    }
    $myList.html(list);

    // EVEN FASTER
    var array = []; 
    for(var i = 0; i < 10000; i++){
        array[i] = "<li>"+i+"</li>"; 
    }
    $myList.html(array.join(''));

3、不要对不存在的元素做操作：

// BAD: This runs three functions before it realizes there's nothing in the selection
$("#nosuchthing").slideUp();

// GOOD
var $mySelection = $("#nosuchthing");
if ($mySelection.length) {
    $mySelection.slideUp();

事件 1、一个页面只使用一个Document ready，便于调试和跟踪。

2、不要使用匿名函数绑定事件，匿名函数不利于调试，复用，测试，debug：

$("#myLink").on("click", function(){...}); // BAD

// GOOD
function myLinkClickHandler(){...}
$("#myLink").on("click", myLinkClickHandler);

3、Document ready 不要用匿名函数，原因同上：

$(function(){ ... }); // BAD: You can never reuse or write a test for this function.

// GOOD
$(initPage); // or $(document).ready(initPage);
function initPage(){
    // Page load event where you can initialize values and call other initializers.
}

4、Document ready 的处理函数应该写在外部文件，内联的javascript可以在一些初始化设置之后调用 ready 函数，例如：

<script src="my-document-ready.js"></script>
<script>
    // Any global variable set-up that might be needed.
    $(document).ready(initPage); // or $(initPage);
</script>

5、不要把事件直接写在HTML元素上，这样不方便调试：

    <a id="myLink" href="#" onclick="myEventHandler();">my link</a> <!-- BAD -->
    $("#myLink").on("click", myEventHandler); // GOOD

6、尽可能的给事件加上命名空间。这样方便解除绑定，而不影响该DOM元素的其他事件：

    $("#myLink").on("click.mySpecialClick", myEventHandler); // GOOD
    // Later on, it's easier to unbind just your click event
    $("#myLink").unbind("click.mySpecialClick");

AJAX

1、使用.ajax()，避免.getJson()或者.get()，它们在内部也是调用.ajax()的。

2、不要在https的站点上请求http，使用依赖协议的URL

3、不要把数据加在url上，使用data属性。

// Less readable...
$.ajax({
    url: "something.php?param1=test1&param2=test2",
    ....
});

// More readable...
$.ajax({
    url: "something.php",
    data: { param1: test1, param2: test2 }
});

4、指定dataType属性，更容易知道数据类型。

5、对于ajax加载的内容，使用委托绑定事件，这样可以在元素不存在的时候执行绑定。（之后ajax加载进DOM结构中）

$("#parent-container").on("click", "a", delegatedClickHandlerForAjax);

6、使用Promise

$.ajax({ ... }).then(successHandler, failureHandler);

// OR
var jqxhr = $.ajax({ ... });
jqxhr.done(successHandler);
jqxhr.fail(failureHandler);

7、抽象出ajax模板，方便复用：

var jqxhr = $.ajax({
    url: url,
    type: "GET", // default is GET but you can use other verbs based on your needs.
    cache: true, // default is true, but false for dataType 'script' and 'jsonp', so set it on need basis.
    data: {}, // add your request parameters in the data object.
    dataType: "json", // specify the dataType for future reference
    jsonp: "callback", // only specify this to match the name of callback parameter your API is expecting for JSONP requests.
    statusCode: { // if you want to handle specific error codes, use the status code mapping settings.
        404: handler404,
        500: handler500
    }
});
jqxhr.done(successHandler);
jqxhr.fail(failureHandler);

动画效果

1、Adopt a restrained and consistent approach to implementing animation functionality（大意：采取受限制的和统一的方法来实现动画功能。）

2、满足用户体验即可，不要做过多的动画：

尽量使用简单的show/hide，slideUp/slideDown来切换元素 尽量使用jQuery预定义的时间间隔（durations），“slow”，“fast”或者400（中等） 插件 1、选择兼容性好，文档，测试齐全何社区支持好的插件。

2、检查插件在不同版本jQuery下的兼容性。

3、任何参加的可复用的组件，都应该以插件的形式实现。

链式调用 1、使用链式调用代替变量缓存和多次调用选择器：

$("#myDiv").addClass("error").show();

2、当链式调用超过3级的时候，适当的换行增加可读性：

$("#myLink")
    .addClass("bold")
    .on("click", myClickHandler)
    .on("mouseover", myMouseOverHandler)
    .show();

3、链太长的时候，缓存中间对象是可以接受的。

其他 1、参数尽量使用对象形式：

    $myLink.attr("href", "#").attr("title", "my link").attr("rel", "external"); // BAD, 3 calls to attr()
    // GOOD, only 1 call to attr()
    $myLink.attr({
        href: "#",
        title: "my link",
        rel: "external"
    });

2、尽量不要把css混在js中：

    $("#mydiv").css({'color':red, 'font-weight':'bold'}); // BAD
    .error { color: red; font-weight: bold; } /* GOOD */

    $("#mydiv").addClass("error"); // GOOD

3、不要使用过时的方法，注意新版更新时弃用的方法，不要使用它们。

4、必要的时候使用原生js，这里看查看性能对比 http://jsperf.com/document-getelementbyid-vs-jquery/3

$("#myId"); // is still little slower than...
document.getElementById("myId");

原文地址:http://lab.abhinayrathore.com/jquery-standards/