jQuery事件处理: 别再乱用“return false”了

可能在你刚开始学习关于jQuery事件处理时，看到的第一个例子就是关于如何阻止浏览器执行默认行为，好比下面这段演示click事件的代码：

$("a.toggle").click(function () {
    $("#mydiv").toggle();
    return false; // Prevent browser from visiting `#`
});

这个函数使用toggle来显示或者隐藏#mydiv，而后阻止浏览器继续访问href中指定的连接。

像上面这样的例子会让用户养成使用“return false”来阻止浏览器执行默认行为的坏习惯，在这篇文章里，我将会讨论关于阻止浏览器执行默认行为的两个很是重要的主题：

• 选择正确的方法： return false仍是preventDefault，stopPropagation或者stopImmediatePropagation
• 选择合适的位置，开始，结束，仍是中间某个地方：你应该在事件回调的哪一个部分取消浏览器执行默认行为？

注意：当我在这篇文章中提到event bubbling（事件冒泡），我想表达的是大部分事件都是先在初始DOM上触发，而后再经过DOM树往上，在每一级父元素上触发，事件不会在兄弟节点或是子节点上冒泡（当事件向下冒泡时，咱们叫它事件捕捉（event capturing))，你能够在这里了解更多关于事件起泡和捕捉的介绍。

选择正确的方法

“return false”之因此被误用的如此厉害，是由于它看起来像是完成了咱们交给它的工做，浏览器不会再将咱们重定向到href中的连接，表单也不会被继续提交，但这么作到底有什么不对呢？

”return false“到底作了什么？

当你每次调用”return false“的时候，它实际上作了3件事情：

• event.preventDefault();
• event.stopPropagation();
• 中止回调函数执行并当即返回。

“等等”，你叫了起来！我只是想让浏览器中止继续执行默认行为而已，我不须要它去作另外2件事。

这3件事中用来阻止浏览器继续执行默认行为的只有preventDefault，除非你想要中止事件冒泡，不然使用return false会为你的代码埋下很大的隐患，让咱们经过一个真实的例子来看看这样的误用会形成什么后果：

这是咱们用来演示的HTML：

<div class="post">
<h2><a href="http://heikezhi.com/path/to/page">My Page</a></h2>
<div class="content">
    Teaser text...
  </div>
</div>
<div class="post">
<h2><a href="http://heikezhi.com/path/to/other_page">My Other Page</a></h2>
<div class="content">
    Teaser text...
  </div>
</div>

如今假设咱们想要在用户点击文章标题时，将文章动态载入到div.contentd中：

jQuery(document).ready(function ($) {
  $("div.post h2 a").click(function () {
    var a    = $(this),
    href = a.attr('href'), // Let jQuery normalize `href`,
    content  = a.parent().next();
    content.load(href + " #content");
    return false; // "cancel" the default behavior of following the link
  });
});

这段代码能够正常工做（至少目前是），但若是咱们顺着这个思路继续，若是我想要在用户点击了一个div.post元素（或者任何一个它的子元素）时，给它加上一个active类，我就须要给div.post增长了一个click回调：

// Inside Document Ready:
var posts = $("div.post");
  posts.click(function () {
  // Remove active from all div.post
  posts.removeClass("active");
  // Add it back to this one
  $(this).addClass("active");
});

如今，若是咱们点击一个帖子的标题，这段代码会工做吗？答案是不会，由于咱们在标题的click回调里使用了return false而不是咱们应该使用的，”return false“等于event.preventDefault();加event.stopPropagation();，因此事件冒泡就被终止了，click事件不会被冒泡到div.post上，咱们为它添加的事件回调固然也就不会被调用了。

若是咱们把它和live或者delegate事件混在一块儿使用时，状况就更糟了。

$("a").click(function () {
  // do something
  return false;
});

$("a").live("click", function () {
  // THIS WON'T FIRE
});

那么咱们真正须要的是什么呢？

preventDefault()

大多数状况下，当你使用return false时，你其实真正须要的是e.preventDefault()。要使用e.preventDefault，你须要确保你传递了event参数到你的回掉函数中（在这个例子里，就是那个e）：

$("a").click(function (e) {
  // e == our event data
  e.preventDefault();
});

它会替咱们完成全部工做，但不会阻止父节点继续处理事件，要记住，你放在代码中的限制越少，你的代码就越灵活，也就越易于维护。

stopPropagation()

但有些状况下，你有可能须要中止事件冒泡，让咱们看看下面的例子：

<div class="post">
    Normal text and then a <a href="http://heikezhi.com/path">link</a> and then more text.
</div>

如今，让咱们假设若是你点了div上除了a连接以外的地方，咱们但愿能发生点什么事情（好比改变下背景什么的），可是不能影响用户点击a连接的行为（从可用性的角度，这个例子不怎么好，你可能不但愿用户点击别的地方时发生任何事情）。

$("div.post").click(function () {
  // Do the first thing;
});

$("div.post a").click(function (e) {
  // Don't cancel the browser's default action
  // and don't bubble this event!
  e.stopPropagation();
});

在这种状况下，若是咱们使用return false，div的click事件不会被触发，可是用户也不会到达他们点的那个连接。

stopImmediatePropagation()

这个方法会中止一个事件继续执行，即便当前的对象上还绑定了其它处理函数，全部绑定在一个对象上的事件会按绑定顺序执行，看看下面的例子：

$("div a").click(function () {
  // Do something
});

$("div a").click(function (e) {
  // Do something else
  e.stopImmediatePropagation();
});

$("div a").click(function () {
  // THIS NEVER FIRES
});

$("div").click(function () {
  // THIS NEVER FIRES
});

你可能会以为这个例子看起来很别扭，没错，尽管如此，但有时这的确会发生，若是你的代码很是复杂，那么不一样的widgets和plugin就有可能在同一个对象上添加事件，若是遇到这种状况，那你就颇有必要理解和使用stopImmediatePropagation。

return false

只有当你同时须要preventDefault和stopPropagation，而且你的代码能够接受直到你的回调执行完成才中止执行浏览器的默认行为，那你就可使用”return false“。但我强烈建议你别在写给其它jQuery开发者的演示代码中使用这个方法，由于这会形成更多误用，只有在你确信非用不可的状况下再去使用”return false“。

选择适当的位置

若是你使用了”return false“，它只会在你的回调函数执行结束才去取消浏览器的默认行为，可是使用e.preventDefault，咱们有更多的选择，它能够随时中止浏览器执行默认动做，而无论你将它放在函数的哪一个部分。

1. 开发阶段，你应该老是将它放在第一行。你最不想作的事情可能就是你正在调试将一个form改为ajax提交的时候，它却已经被按照老方法提交了。

2.产品阶段，若是你采用了渐进加强（progressive enhancement），那就把它放到回调的结束位置，或者是逻辑终点，若是在一个普通页面采用渐进加强，那你就须要在服务器端考虑若是浏览器不支持JS时（或者被禁用时），对连接的click事件和表单的提交事件的处理。这里的好处是，咱们不考虑关闭JS的状况，只考虑支持js时的强狂，若是你的回调代码出错抛出了异常，让咱们看看下面的代码：

var data = {};
$("a").click(function (e) {
  e.preventDefault(); // cancel default behavior
  // Throws an error because `my` is undefined
  $("body").append(data.my.link);
  // The original link doesn't work AND the "cool"
  // JavaScript has broken. The user is left with NOTHING!
});

如今，让咱们看看一样的事件，把preventDefault调用放在底部的效果：

>
var data = {};
$("a").click(function (e) {
  // Throws an error because `my` is undefined
  $("body").append(data.my.link);

  // This line is never reached, and your website
  // falls back to using the `href` instead of this
  // "cool" broken JavaScript!
  e.preventDefault(); // cancel default behavior
});

这对表单提交也一样有效，你能够更好的应对出错的状况，别期望你的代码一直正常工做，在发生错误时有正确的应对总赛过假设代码不会出错。

3. 在产品阶段，若是功能这设计JS，那就还应该放在第一行。

记住，没必要非得是函数的第一行，可是越早越好，这里的原则是：若是函数的功能是经过JS实现的（不涉及服务端交互），那就不必考虑兼容，在这种状况下，添加在第一行能够防止URL中出现#字符，但显然，你仍是应该尽量多的增长些错误处理代码，以防止用户在出错时变得不知所措。

结论

我但愿这篇文章传达的信息足够你在须要阻止浏览器执行默认行为时作出正确的选择。记住，只有当你真的明白你在作什么时，才使用”return false“，并确保你是在函数的正确位置调用了相应的代码。最后，尽量保持代码的灵活性，尽可能不要再用“return false”了！