JavaScript 专题系列第一篇，解说防抖，带你从零完成一个 underscore 的 debounce 函数
媒介
在前端开辟中会碰到一些频仍的事宜触发，比方：
window 的 resize、scroll
mousedown、mousemove
keyup、keydown
……
为此，我们举个示例代码来了解事宜怎样频仍的触发：
我们写个 index.html 文件：
<!DOCTYPE html>
<html lang="zh-cmn-Hans">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="IE=edge, chrome=1">
<title>debounce</title>
<style>
#container{
width: 100%; height: 200px; line-height: 200px; text-align: center; color: #fff; background-color: #444; font-size: 30px;
}
</style>
</head>
<body>
<div id="container"></div>
<script src="debounce.js"></script>
</body>
</html>debounce.js 文件的代码以下：
var count = 1;
var container = document.getElementById('container');
function getUserAction() {
container.innerHTML = count++;
};
container.onmousemove = getUserAction;我们来看看效果：
从左侧滑到右侧就触发了 165 次 getUserAction 函数！
由于这个例子很简单，所以浏览器完全回响反映的过来，然则假如是庞杂的回调函数或是 ajax 要求呢？假定 1 秒触发了 60 次，每一个回调就必须在 1000 / 60 = 16.67ms 内完成，不然就会有卡顿涌现。
为了处置惩罚这个题目，平常有两种处置惩罚方案：
debounce 防抖
throttle 撙节
防抖
本日重点讲讲防抖的完成。
防抖的原理就是：你只管触发事宜，然则我一定在事宜触发 n 秒后才实行，假如你在一个事宜触发的 n 秒内又触发了这个事宜，那我就以新的事宜的时刻为准，n 秒后才实行，总之，就是要等你触发完事宜 n 秒内不再触发事宜，我才实行，真是率性呐!
初版
依据这段表述，我们能够写初版的代码：
// 初版
function debounce(func, wait) {
var timeout;
return function () {
clearTimeout(timeout)
timeout = setTimeout(func, wait);
}
}假如我们要运用它，以最一开始的例子为例：
container.onmousemove = debounce(getUserAction, 1000);如今随你怎样挪动，横竖你挪动完 1000ms 内不再触发，我才实行事宜。看看运用效果：
马上就从 165 次下降成了 1 次!
棒棒哒，我们接着完美它。
this
假如我们在 getUserAction 函数中 console.log(this)，在不运用 debounce 函数的时刻，this 的值为：
<div id="container"></div>然则假如运用我们的 debounce 函数，this 就会指向 Window 对象！
所以我们需要将 this 指向准确的对象。
我们修正下代码：
// 第二版
function debounce(func, wait) {
var timeout;
return function () {
var context = this;
clearTimeout(timeout)
timeout = setTimeout(function(){
func.apply(context)
}, wait);
}
}如今 this 已能够准确指向了。让我们看下个题目：
event 对象
JavaScript 在事宜处置惩罚函数中会供应事宜对象 event，我们修正下 getUserAction 函数：
function getUserAction(e) {
console.log(e);
container.innerHTML = count++;
};假如我们不运用 debouce 函数，这里会打印 MouseEvent 对象，如图所示：
然则在我们完成的 debounce 函数中，却只会打印 undefined!
所以我们再修正一下代码：
// 第三版
function debounce(func, wait) {
var timeout;
return function () {
var context = this;
var args = arguments;
clearTimeout(timeout)
timeout = setTimeout(function(){
func.apply(context, args)
}, wait);
}
}到此为止，我们修复了两个小题目：
this 指向
event 对象
马上实行
这个时刻，代码已非常完美了，然则为了让这个函数越发完美，我们接下来思索一个新的需求。
这个需求就是：
我不愿望非要比及事宜住手触发后才实行，我愿望马上实行函数，然后比及住手触发 n 秒后，才够从新触发实行。
想一想这个需求也是很有原理的嘛，那我们加个 immediate 参数推断是不是是马上实行。
// 第四版
function debounce(func, wait, immediate) {
var timeout, result;
return function () {
var context = this;
var args = arguments;
if (timeout) clearTimeout(timeout);
if (immediate) {
// 假如已实行过，不再实行
var callNow = !timeout;
timeout = setTimeout(function(){
timeout = null;
}, wait)
if (callNow) func.apply(context, args)
}
else {
timeout = setTimeout(function(){
func.apply(context, args)
}, wait);
}
}
}再来看看运用效果：
返回值
此时注重一点，就是 getUserAction 函数多是有返回值的，所以我们也要返回函数的实行效果，然则当 immediate 为 false 的时刻，由于运用了 setTimeout ，我们将 func.apply(context, args) 的返回值赋给变量，末了再 return 的时刻，值将会一直是 undefined，所以我们只在 immediate 为 true 的时刻返回函数的实行效果。
// 第五版
function debounce(func, wait, immediate) {
var timeout, result;
return function () {
var context = this;
var args = arguments;
if (timeout) clearTimeout(timeout);
if (immediate) {
// 假如已实行过，不再实行
var callNow = !timeout;
timeout = setTimeout(function(){
timeout = null;
}, wait)
if (callNow) result = func.apply(context, args)
}
else {
timeout = setTimeout(function(){
func.apply(context, args)
}, wait);
}
return result;
}
}作废
末了我们再思索一个小需求，我愿望能作废 debounce 函数，比方说我 debounce 的时刻距离是 10 秒钟，immediate 为 true，如许的话，我只要等 10 秒后才从新触发事宜，如今我愿望有一个按钮，点击后，作废防抖，如许我再去触发，就能够又马上实行啦，是不是是很高兴？
为了这个需求，我们写末了一版的代码：
// 第六版
function debounce(func, wait, immediate) {
var timeout, result;
var debounced = function () {
var context = this;
var args = arguments;
if (timeout) clearTimeout(timeout);
if (immediate) {
// 假如已实行过，不再实行
var callNow = !timeout;
timeout = setTimeout(function(){
timeout = null;
}, wait)
if (callNow) result = func.apply(context, args)
}
else {
timeout = setTimeout(function(){
func.apply(context, args)
}, wait);
}
return result;
};
debounced.cancel = function() {
clearTimeout(timeout);
timeout = null;
};
return debounced;
}那末该怎样运用这个 cancel 函数呢？依然是以上面的 demo 为例：
var count = 1;
var container = document.getElementById('container');
function getUserAction(e) {
container.innerHTML = count++;
};
var setUseAction = debounce(getUserAction, 10000, true);
container.onmousemove = setUseAction;
document.getElementById("button").addEventListener('click', function(){
setUseAction.cancel();
})演示效果以下：
至此我们已完全完成了一个 underscore 中的 debounce 函数，祝贺，撒花！
演示代码
相干的代码能够在 Github 博客堆栈 中找到
专题系列
JavaScript专题系列目次地点：https://github.com/mqyqingfeng/Blog。
JavaScript专题系列估计写二十篇摆布，重要研讨一样平常开辟中一些功用点的完成，比方防抖、撙节、去重、范例推断、拷贝、最值、扁平、柯里、递归、乱序、排序等，特点是研(chao)究(xi) underscore 和 jQuery 的完成体式格局。
假如有毛病或许不严谨的处所，请务必赋予斧正，非常谢谢。假如喜好或许有所启示，迎接 star，对作者也是一种勉励。
