全栈修炼

# 3 个使用场景助你用好 DOM 事件

这篇文章我们将一起来探究 DOM 事件。

DOM 事件数量非常多，即使分类也有十多种，比如键盘事件、鼠标事件、表单事件等，而且不同事件对象属性也有差异，这带来了一定的学习难度。

但页面要与用户交互，接收用户输入，就离不开监听元素事件，所以，DOM 事件是前端工程师必须掌握的重要内容，同时也是 DOM 的重要组成部分。

下面我们就从 防抖、节流、代理 3 个场景出发，详细了解 DOM 事件。

# 防抖

试想这样的一个场景，有一个搜索输入框，为了提升用户体验，希望在用户输入后可以立即展现搜索结果，而不是每次输入完后还要点击搜索按钮。最基本的实现方式应该很容易想到，那就是绑定 input 元素的键盘事件，然后在监听函数中发送 AJAX 请求。伪代码如下：

const ipt = document.querySelector('input');
ipt.addEventListener('input', e => {
  search(e.target.value).then(
    resp => {
      // ...
    },
    e => {
      // ...
    }
  );
});

但其实这样的写法很容易造成性能问题。比如当用户在搜索“golderBrother”这个词的时候，每一次输入都会触发搜索：

  1. 搜索“g”
  2. 搜索“go”
  3. 搜索“gol”
  4. 搜索“gold”
  5. 搜索“golde” ...

而实际上，只有最后一次搜索结果是用户想要的，前面进行了 4 次无效查询，浪费了网络带宽和服务器资源。

所以对于这类连续触发的事件，需要添加一个防抖功能，为函数的执行设置一个合理的时间间隔，避免事件在时间间隔内频繁触发，同时又保证用户输入后能即时看到搜索结果。

要实现这样一个功能我们很容易想到使用 setTimeout() 函数来让函数延迟执行。就像下面的伪代码，当每次调用函数时，先判断 timeout 实例是否存在，如果存在则销毁，然后创建一个新的定时器。

// 代码1
const ipt = document.querySelector('input');
let timeout = null;
ipt.addEventListener('input', e => {
  if (timeout) {
    clearTimeout(timeout);
    timeout = null;
  }
  timeout = setTimeout(() => {
    search(e.target.value).then(
      resp => {
        // ...
      },
      e => {
        // ...
      }
    );
  }, 500);
});

问题确实是解决了，但这并不是最优答案，或者说我们需对这个防抖操作进行一些“优化”。

试想一下，如果另一个搜索框也需要添加防抖，是不是也要把 timeout 相关的代码再编写一次？而其实这个操作是完全可以抽取成公共函数的。

在抽取成公共函数的同时，还需要考虑更复杂的情况：

  • 参数和返回值如何传递？
  • 防抖化之后的函数是否可以立即执行？
  • 防抖化的函数是否可以手动取消？

具体代码如下所示，首先将原函数作为参数传入 debounce() 函数中，同时指定延迟等待时间，返回一个新的函数，这个函数包含 cancel 属性，用来取消原函数执行。flush 属性用来立即调用原函数，同时将原函数的执行结果以 Promise 的形式返回。

// 代码2
const debounce = (func, wait = 0) => {
  let timeout = null;
  let args;
  function debounced(...arg) {
    args = arg;
    if (timeout) {
      clearTimeout(timeout);
      timeout = null;
    }
    // 以Promise的形式返回函数执行结果
    return new Promise((res, rej) => {
      timeout = setTimeout(async () => {
        try {
          const result = await func.apply(this, args);
          res(result);
        } catch (e) {
          rej(e);
        }
      }, wait);
    });
  }
  // 允许取消
  function cancel() {
    clearTimeout(timeout);
    timeout = null;
  }
  // 允许立即执行
  function flush() {
    cancel();
    return func.apply(this, args);
  }
  debounced.cancel = cancel;
  debounced.flush = flush;
  return debounced;
};

我们在写代码解决当前问题的时候，最初只能写出像代码 1 那样满足需求的代码。但要成为高级工程师，就一定要将问题再深想一层，比如代码如何抽象成公共函数，才能得到较为完善的代码 2，从而自身得到成长。

关于防抖函数还有功能更丰富的版本，比如 lodash 的 debounce() 函数，有兴趣的话可以到 GitHub 上查阅资料。

# 节流

现在来考虑另外一个场景，一个左右两列布局的查看文章页面，左侧为文章大纲结构，右侧为文章内容。现在需要添加一个功能，就是当用户滚动阅读右侧文章内容时，左侧大纲相对应部分高亮显示，提示用户当前阅读位置。

这个功能的实现思路比较简单，滚动前先记录大纲中各个章节的垂直距离，然后监听 scroll 事件的滚动距离，根据距离的比较来判断需要高亮的章节。伪代码如下：

// 监听scroll事件
wrap.addEventListener('scroll', e => {
  let highlightId = '';
  // 遍历大纲章节位置，与滚动距离比较，得到当前高亮章节id
  for (let id in offsetMap) {
    if (e.target.scrollTop <= offsetMap[id].offsetTop) {
      highlightId = id;
      break;
    }
  }
  const lastDom = document.querySelector('.highlight');
  const currentElem = document.querySelector(`a[href="#${highlightId}"]`);
  // 修改高亮样式
  if (lastDom && lastDom.id !== highlightId) {
    lastDom.classList.remove('highlight');
    currentElem.classList.add('highlight');
  } else {
    currentElem.classList.add('highlight');
  }
});

功能是实现了，但这并不是最优方法，因为滚动事件的触发频率是很高的，持续调用判断函数很可能会影响渲染性能。实际上也不需要过于频繁地调用，因为当鼠标滚动 1 像素的时候，很有可能当前章节的阅读并没有发生变化。所以我们可以设置在指定一段时间内只调用一次函数，从而降低函数调用频率，这种方式我们称之为节流。

实现节流函数的过程和防抖函数有些类似，只是对于节流函数而言，有两种执行方式，在调用函数时执行最先一次调用还是最近一次调用，所以需要设置时间戳加以判断。我们可以基于 debounce() 函数加以修改，代码如下所示：

const throttle = (func, wait = 0, execFirstCall) => {
  let timeout = null;
  let args;
  let firstCallTimestamp;

  function throttled(...arg) {
    if (!firstCallTimestamp) firstCallTimestamp = new Date().getTime();
    if (!execFirstCall || !args) {
      console.log('set args:', arg);
      args = arg;
    }
    if (timeout) {
      clearTimeout(timeout);
      timeout = null;
    }
    // 以Promise的形式返回函数执行结果
    return new Promise(async (res, rej) => {
      if (new Date().getTime() - firstCallTimestamp >= wait) {
        try {
          const result = await func.apply(this, args);
          res(result);
        } catch (e) {
          rej(e);
        } finally {
          cancel();
        }
      } else {
        timeout = setTimeout(async () => {
          try {
            const result = await func.apply(this, args);
            res(result);
          } catch (e) {
            rej(e);
          } finally {
            cancel();
          }
        }, firstCallTimestamp + wait - new Date().getTime());
      }
    });
  }
  // 允许取消
  function cancel() {
    clearTimeout(timeout);
    args = null;
    timeout = null;
    firstCallTimestamp = null;
  }
  // 允许立即执行
  function flush() {
    cancel();
    return func.apply(this, args);
  }
  throttled.cancel = cancel;
  throttled.flush = flush;
  return throttle;
};

节流与防抖都是通过延迟执行，减少调用次数，来优化频繁调用函数时的性能。不同的是，对于一段时间内的频繁调用，防抖是延迟执行后一次调用，节流是延迟定时多次调用。

# 代理

下面的 HTML 代码是一个简单的无序列表，现在希望点击每个项目的时候调用 getInfo() 函数，当点击编辑时，调用一个 edit() 函数，当点击删除时，调用一个 del() 函数。

html 代码如下：

<ul class="list">
  <li class="item" id="item1">
    项目1<span class="edit">编辑</span><span class="delete">删除</span>
  </li>
  <li class="item" id="item2">
    项目2<span class="edit">编辑</span><span class="delete">删除</span>
  </li>
  <li class="item" id="item3">
    项目3<span class="edit">编辑</span><span class="delete">删除</span>
  </li>
  ...
</ul>

要实现这个功能并不难，只需要对列表中每一项，分别监听 3 个元素的 click 事件即可。

但如果数据量一旦增大，事件绑定占用的内存以及执行时间将会成线性增加，而其实这些事件监听函数逻辑一致，只是参数不同而已。此时我们可以以事件代理或事件委托来进行优化。不过在此之前，我们必须先复习一下 DOM 事件的触发流程。

事件触发流程如图 1 所示，主要分为 3 个阶段：

  • 捕获，事件对象 Window 传播到目标的父节点，图 1 的红色过程；
  • 目标，事件对象到达事件对象的事件目标，图 1 的蓝色过程；
  • 冒泡，事件对象从目标的父节点开始传播到 Window，图 1 的绿色过程。

domEvent

例如，在下面的代码中，虽然我们第二次进行事件监听时设置为捕获阶段，但点击事件时仍会按照监听顺序进行执行。

<body>
  <button>click</button>
</body>
<script>
  document.querySelector('button').addEventListener('click', function() {
    console.log('bubble');
  });
  document.querySelector('button').addEventListener(
    'click',
    function() {
      console.log('capture');
    },
    true
  );
  // 执行结果
  // buble
  // capture
</script>

我们再回到事件代理，事件代理的实现原理就是利用上述 DOM 事件的触发流程来对一类事件进行统一处理。比如对于上面的列表，我们在 ul 元素上绑定事件统一处理，通过得到的事件对象来获取参数，调用对应的函数。

const ul = document.querySelector('.list');
ul.addEventListener('click', e => {
  // 获取真实触发的事件对象(e.target), 不是e.currentTarget
  const t = e.target || e.srcElement;
  if (t.classList.contains('item')) {
    getInfo(t.id);
  } else {
    id = t.parentElement.id;
    if (t.classList.contains('edit')) {
      edit(id);
    } else if (t.classList.contains('delete')) {
      del(id);
    }
  }
});

虽然这里我们选择了默认在冒泡阶段监听事件，但和捕获阶段监听并没有区别。对于其他情况还需要具体情况具体细分析，比如有些列表项目需要在目标阶段进行一些预处理操作，那么可以选择冒泡阶段进行事件代理。

补充：关于 DOM 事件标准

你知道下面 3 种事件监听方式的区别吗？

// 方式1
<input type="text" onclick="click()" />;
// 方式2
document.querySelector('input').onClick = function(e) {
  // ...
};
// 方式3
document.querySelector('input').addEventListener('click', function(e) {
  //...
});

方式 1 和方式 2 同属于 DOM0 标准，通过这种方式进行事件监会覆盖之前的事件监听函数。

方式 3 属于 DOM2 标准，推荐使用这种方式。同一元素上的事件监听函数互不影响，而且可以独立取消，调用顺序和监听顺序一致。

# 总结

本篇文章的实例代码已经放到github，感兴趣的可以看下

# 最后

文中若有不准确或错误的地方，欢迎指出，有兴趣可以的关注下Github~

Last Updated: 2020/9/7 下午8:45:37

← 浏览器如何渲染页面？ →