Debouncing в JavaScript
В JavaScript есть много событий, которые запускаются очень быстро.
Когда вы прокручиваете страницу, изменяете размер окна, перемещаете мышь — браузер фиксирует десятки событий в секунду.
Но во многих случаях не требуется фиксировать каждый промежуточный шаг — интересует только захват конечного состояния (когда пользователь заканчивает прокрутку или заканчивает изменять размер окна).
JavaScript debouncing — это стратегия, которая позволяет повысить производительность приложения, откладывая запуск некоторого события, до тех пор пока не пройдет определенное количество времени. Когда пользователь перестанет инициировать событие, код будет запущен.
В некоторых случаях в debouncing нет необходимости. Но, если используются какие-либо сетевые запросы или если изменяется DOM (например, повторный рендеринг компонента), этот метод может значительно повысить плавность приложения.
В этом примере ничего не произойдет до тех пор, пока пользователь не начнет перемещать мышь, а затем не прекратит ее перемещение как минимум на 350 мс.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>JavaScript Debounce</title>
</head>
<body>
<script>
const debounce = (callback, wait) => {
let timeoutId = null; // ссылка на таймер
// возвращаемая функция принимает произвольное количество аргументов
return (...args) => {
// очищаем предыдущий таймер
window.clearTimeout(timeoutId);
// планируем событие
timeoutId = window.setTimeout(() => {
// вызываем переданный коллбэк с произвольным числом аргументом
callback.apply(null, args);
}, wait);
};
}
// откладываем выполнение функции на 350 мс
const onMouseMoveDebounced = debounce((e) => {
console.log(`offsetX = ${e.offsetX}; offsetY = ${e.offsetY}`);
}, 350)
// при движении мыши в окне
document.addEventListener('mousemove', onMouseMoveDebounced);
</script>
</body>
</html>
Наша функция debounce принимает два аргумента: функцию обратного вызова и длительность в миллисекундах.
Всякий раз, когда запускается обернутая функция, происходят две вещи:
- Мы отменяем любой ранее существовавший тайм-аут
- Мы планируем новый тайм-аут, основанный на количестве времени, указанном аргументом wait. Когда истекает время ожидания, мы вызываем нашу функцию обратного вызова с помощью apply и передаем ей любые имеющиеся у нас аргументы.
- setTimeout возвращает число, ссылку на конкретный тайм-аут. Мы храним его в переменной timeoutId. Поскольку эта переменная хранится вне области видимости нашей обернутой функции, она сохраняется между вызовами.
Теперь, допустим, пользователь еще не закончил перемещать мышь. Проходит несколько миллисекунд, и наша обертка вызывается снова.
На этот раз timeoutId указывает на запланированный в данный момент тайм-аут, поэтому первая строка отменяет его. А затем мы запланируем новый.
Если пользователь будет перемещать мышь без остановки какое-то время, этот цикл повторится десятки раз. Множество запланированных и немедленно отмененных тайм-аутов. Но как только действия пользователя прекращаются, этот цикл останавливается. В тот момент, когда проходит 350 мс, наш тайм-аут срабатывает снова, и код в конечном итоге выполняется.
Пример вы можете увидеть в браузере — пока вы двигаете указатель мыши на странице — ничего не происходит, но как только Вы его остановите, увидите всплывающее окно с сообщением.
Планирование и очистка тайм-аутов — это очень быстрая операция с низким потреблением памяти, поэтому нам не нужно сильно беспокоиться о ее производительности.
Таким образом, можно откладывать выполнение очень быстрых событий на определенное время с помощью debouncing в JavaScript, что, в итого, помогает сделать приложение более отзывчивым и плавным.
