closertb / closertb.github.io

浏览issue 或 我的网站,即可查看我的所有博客
https://closertb.site
32 stars 0 forks source link

一个removeEventListener引发的思考 #32

Open closertb opened 5 years ago

closertb commented 5 years ago

写于:2019-08-04

起因

最近在看以前的代码时,发现年初在熟悉react hooks新特性时写下了这样一段代码:

let i = 0;
function Test(props) {
  const { loading, error, startFetch } = props;
  useEffect(() => {
    const $btn = document.querySelector('.btn'); // .info-con 存在于外层的dom中
    $btn.addEventListener('click', () => {
      const action =`action data${i++}`;
      console.log('resbtn', action);
    }, false);
    return $btn.removeEventListener('click', () => {});
  });
  if (error) {
    return <div>{error.msg}</div>;
  }
  return (
    <div>
      {loading && <h3>loading</h3>}
      <h3 className="mt-10 mb-10">finished</h3>
      <button onClick={startFetch}>获取数据</button>
      <h4 className="mt-10"><span className="btn">Saga模拟测试</span></h4>
    </div>
  );
}

我用了addEventListener和removeEventListener来尝试useEffect的挂载和清除功能,细心的你,发现这段代码有几个错误呢?
自我观察,自认为是有如下几个的:

  1. 清除函数使用方式错误,应该返回的是一个函数,like:() => { $btn.removeEventListener('click', () => {}); },而我这里是一个语句;
  2. removeEventListener使用语法错误;
  3. useEffect未使用第二个参数,导致addEventListener挂载会多次执行(可以优化) 第1个和第3个错误,是可以原谅的,当时自己对hooks还不熟悉。但第二个错误,是不可原谅的,这是需要检讨的。本文后面不会对useEffect做深入讲解,官方文档已经足够清楚,后面围绕removeEventListener来剖析。

    认清removeEventListener

    第二个错误,拆开看,又可分为两个方面:removeEventListener使用方式多余与语法错误。

    • 使用方式多余:虽然$btn添加了click监听事件回调,但由于这个节点属于当前Test组件,所以组件销毁时,其相关节点的监听事件也会一并销毁,这个在自己刚接触前端时就做过这一方面的解析,所以这里的removeEventListener使用是多余的。但如果换成一个组件外的节点,比如我后面替换的.info-con节点,这是一直存在于Layout组件中的,使用removeEventListener是必要的。
    • 语法错误:指使用removeEventListener,前面两个参数是必传的,事件类型(type:click),事件回调函数(listener: callback),由于使用addEventListener是为事件添加的一个队列(即同一个事件,可添加多个监听回调),所以事件回调函数(listener)是必传,且其引用与添加的事件监听回调函数指向相同。详细描述见官方文档 关于语法错误,官方文档中有这样一段描述:
      image

由于我在添加监听时,使用的是箭头函数,所以删除时无法找到相同引用的监听事件,所以第一件事就是改变监听函数的写法。完善后,写法是下面这样的:

let i = 0;
function Test(props) {
  const { loading, error, startFetch } = props;
  useEffect(() => {
    const $btn = document.querySelector('.info-con');
    const eventAction = () => {
      const action =`action data${i++}`;
      console.log('resbtn:', action);
    };
    $btn.addEventListener('click', eventAction);
    return () => {
      $btn.removeEventListener('click', eventAction);
    };
  }, []);
  if (error) {
    return <div>{error.msg}</div>;
  }
  return (
    <div>
      {loading && <h3>loading</h3>}
      <h3 className="mt-10 mb-10">finished</h3>
      <button onClick={startFetch}>获取数据</button>
      <h4 className="mt-10"><span className="btn">Saga模拟测试</span></h4>
    </div>
  );
}

到此,看似已经结束了。但既然已经打开了,就深入的学习一下这个api吧,常用的前两个参数,我们都很熟悉,第三个参数写成布尔值也偶尔会有,但是否已足够了解呢?

第三个参数

addEventListener和removeEventListener传参是一样的,第三个可选参数都是一个对象或者一个布尔值:

target.addEventListener(type, listener[, options]);
target.addEventListener(type, listener[, useCapture]);
target.removeEventListener(type, listener[, options]);
target.removeEventListener(type, listener[, useCapture]);

当参数为布尔值时,意指useCapture,是否在捕获阶段触发监听函数。而为对象时,可用选项如下:

image之所以第三个参数有两种形态,是在旧版本中只存在一个布尔值,即useCapture属性;但随着时间推移以及发展的需要,需要支持设置更多的特性设置,所以有了options选项这个对象传参,又为了兼容以前的老程序,所以对两者进行了兼容。once和passive属性非常有趣,但我还没想到合适的使用它们的场景。查看官方文档,发现里面确实有好多以前没有关注到的东西,值得细细品味。 其实在js很多api中,我们都只用了一些常用的用法,而忽略了一些存在且也很适用的不常用传参,比如下面这些: