[OHIF-Viewers]医疗数字阅片-医学影像-Lodash 是一个一致性、模块化、高性能的 JavaScript 实用工具库。_.throttle(func, [wait=0], [option

2020-07-14 10:08:00 浏览数 (1)

OHIF-Viewers里面有一句

代码语言：javascript复制
import throttle from 'lodash.throttle';

先找手册，这里贴中文的手册地址吧，看着方便一点

https://www.lodashjs.com/docs/lodash.throttle

npmjs下载地址

https://www.npmjs.com/package/lodash.throttle

代码语言：javascript复制
npm i  lodash.throttle

_.throttle(func, [wait=0], [options={}])

创建一个节流函数，在 wait 秒内最多执行 func 一次的函数。 该函数提供一个 cancel 方法取消延迟的函数调用以及 flush 方法立即调用。 可以提供一个 options 对象决定如何调用 func 方法， options.leading 与|或 options.trailing 决定 wait 前后如何触发。 func 会传入最后一次传入的参数给这个函数。 随后调用的函数返回是最后一次 func 调用的结果。 注意: 如果 leading 和 trailing 都设定为 true 则 func 允许 trailing 方式调用的条件为: 在 wait 期间多次调用。 如果 wait 为 0 并且 leading 为 false, func调用将被推迟到下一个点，类似setTimeout为0的超时。

参数
  1. func (Function): 要节流的函数。
  2. [wait=0] (number): 需要节流的毫秒。
  3. [options={}] (Object): 选项对象。
  4. [options.leading=true] (boolean): 指定调用在节流开始前。
  5. [options.trailing=true] (boolean): 指定调用在节流结束后。
返回

(Function): 返回节流的函数。

例子
代码语言：javascript复制
// 避免在滚动时过分的更新定位
jQuery(window).on('scroll', _.throttle(updatePosition, 100));
 
// 点击后就调用 `renewToken`，但5分钟内超过1次。
var throttled = _.throttle(renewToken, 300000, { 'trailing': false });
jQuery(element).on('click', throttled);
 
// 取消一个 trailing 的节流调用。
jQuery(window).on('popstate', throttled.cancel);

实例解析防抖动（Debouncing）和节流阀（Throttling）

原文：Debouncing and Throttling Explained Through Examples

防抖（Debounce）和节流（throttle）都是用来控制某个函数在一定时间内执行多少次的技巧，两者相似而又不同。

当我们给 DOM 绑定事件的时候，加了防抖和节流的函数变得特别有用。为什么呢？因为我们在事件和函数执行之间加了一个控制层。记住，我们是无法控制 DOM 事件触发频率的。

看下滚动事件的例子：

当使用触控板，滚动滚轮，或者拖拽滚动条的时候，一秒可以轻松触发30次事件。经我的测试，在智能手机上，慢慢滚动一下，一秒可以触发事件100次之多。这么高的执行频率，你的滚动回调函数压力大吗？

早在2011年，Twitter 网站抛出了一个问题：向下滚动 Twitter 信息流的时候，变得很慢，很迟钝。John Resig 发表了一篇博客解释这个问题，文中解释到直接给 scroll 事件关联昂贵的函数，是多么糟糕的主意。

John（5年前）建议的解决方案是，在 onScroll 事件外部，每 250ms 循环执行一次。简单的技巧，避免了影响用户体验。

现如今，有一些稍微高端的方式处理事件。我来结合用例介绍下 Debounce，Throttle 和 requestAnimationFrame 吧。

防抖动（Debounce）

防抖技术可以把多个顺序地调用合并成一次。

假想一下，你在电梯中，门快要关了，突然有人准备上来。电梯并没有改变楼层，而是再次打开梯门。电梯延迟了改变楼层的功能，但是优化了资源。

在顶部按钮上点击或移动鼠标试一下：

你可以看到连续快速的事件是如何被一个 debounce 事件替代的。但是如果事件触发的时间间隔过长，debounce 则不会生效。

前缘（或者“immediate”）

你会发现，直到事件停止快速执行以后，debounce 事件才会触发相应功能。为何不立即触发呢？那样的话就跟原本的非 debounce 处理无异了。

直到两次快速调用之间的停顿结束，事件才会再次触发。

这是带 leading 标记的例子：

前缘 debounce 的例子

在 underscore.js 中，选项叫 immediate ，而不是 leading：

Debounce 实现

我首次看到 debounce 的 JavaScript 实现是在 2009 年的 John Hann 的博文。

不久后，Ben Alman 做了个 jQuery 插件（不再维护），一年后 Jeremy Ashkenas 把它加入了 underscore.js。而后加入了 Lodash 。

Lodash 给 _.debounce 和 _.throttle 添加了不少特性。之前的 immediate 被 leading（最前面） 和 trailing（最后面） 选项取代。你可以选一种，或者都选，默认只有 trailing 启用。

新的 maxWait 选项（仅 Lodash 有）本文未提及，但是也很有用。事实上，throttle 方法是用 _.debounce 加 maxWait 实现的，你可以看 lodash 源码。

Debounce 实例

调整大小的例子

调整桌面浏览器窗口大小的时候，会触发很多次 resize 事件。

看下面 demo：

如你所见，我们为 resize 事件使用了默认的 trailing 选项，因为我们只关心用户停止调整大小后的最终值。

基于 AJAX 请求的自动完成功能，通过 keypress 触发

为什么用户还在输入的时候，每隔50ms就向服务器发送一次 AJAX 请求？_.debounce 可以帮忙，当用户停止输入的时候，再发送请求。

此处也不需要 leading 标记，我们想等最后一个字符输完。

相似的使用场景还有，直到用户输完，才验证输入的正确性，显示错误信息。

如何使用 debounce 和 throttle 以及常见的坑

自己造一个 debounce / throttle 的轮子看起来多么诱人，或者随便找个博文复制过来。我是建议直接使用 underscore 或 Lodash 。如果仅需要 _.debounce 和 _.throttle 方法，可以使用 Lodash 的自定义构建工具，生成一个 2KB 的压缩库。使用以下的简单命令即可：

代码语言：javascript复制
npm i -g lodash-cli
lodash-cli include=debounce,throttle

常见的坑是，不止一次地调用 _.debounce 方法：

代码语言：javascript复制
// 错误
$(window).on('scroll', function() {
_.debounce(doSomething, 300);
});
 
// 正确
$(window).on('scroll', _.debounce(doSomething, 200));

debounce 方法保存到一个变量以后，就可以用它的私有方法 debounced_version.cancel()，lodash 和 underscore.js 都有效。

代码语言：javascript复制
var debounced_version = _.debounce(doSomething, 200);
$(window).on('scroll', debounced_version);
 
// 如果需要的话
debounced_version.cancel();

Throttle（节流阀）

使用 _.throttle 的时候，只允许一个函数在 X 毫秒内执行一次。

跟 debounce 主要的不同在于，throttle 保证 X 毫秒内至少执行一次。

节流阀实例

无限滚动

用户向下滚动无限滚动页面，需要检查滚动位置距底部多远，如果邻近底部了，我们可以发 AJAX 请求获取更多的数据插入到页面中。

我们心爱的 _.debounce 就不适用了，只有当用户停止滚动的时候它才会触发。只要用户滚动至邻近底部时，我们就想获取内容。

使用 _.throttle 可以保证我们不断检查距离底部有多远。

requestAnimationFrame（rAF）

requestAnimationFrame 是另一种限速执行的方式。

跟 _.throttle(dosomething, 16) 等价。它是高保真的，如果追求更好的精确度的话，可以用浏览器原生的 API 。

可以使用 rAF API 替换 throttle 方法，考虑一下优缺点：

优点

  • 动画保持 60fps（每一帧 16 ms），浏览器内部决定渲染的最佳时机
  • 简洁标准的 API，后期维护成本低

缺点

  • 动画的开始/取消需要开发者自己控制，不像 ‘.debounce’ 或 ‘.throttle’由函数内部处理。
  • 浏览器标签未激活时，一切都不会执行。
  • 尽管所有的现代浏览器都支持 rAF ，IE9，Opera Mini 和 老的 Android 还是需要打补丁。
  • Node.js 不支持，无法在服务器端用于文件系统事件。

根据经验，如果 JavaScript 方法需要绘制或者直接改变属性，我会选择 requestAnimationFrame，只要涉及到重新计算元素位置，就可以使用它。

涉及到 AJAX 请求，添加/移除 class （可以触发 CSS 动画），我会选择 _.debounce 或者 _.throttle ，可以设置更低的执行频率（例子中的200ms 换成16ms）。

rAF 实例

灵感来自于 Paul Lewis 的文章，我将用 requestAnimationFrame 控制 scroll 。

16ms 的 _.throttle 拿来做对比，性能相仿，用于更复杂的场景时，rAF 可能效果更佳。

headroom.js 是个更高级的例子。

结论

使用 debounce，throttle 和 requestAnimationFrame 都可以优化事件处理，三者各不相同，又相辅相成。

总之：

  • debounce：把触发非常频繁的事件（比如按键）合并成一次执行。
  • throttle：保证每 X 毫秒恒定的执行次数，比如每200ms检查下滚动位置，并触发 CSS 动画。
  • requestAnimationFrame：可替代 throttle ，函数需要重新计算和渲染屏幕上的元素时，想保证动画或变化的平滑性，可以用它。注意：IE9 不支持。
http css lodash underscore ajax

0 人点赞