事件模型

2021-05-28

事件的本质是程序各组成部分之间的一种通信方式，也是异步编程的一种实现。DOM支持大量的事件。本章介绍DOM的事件编程。

1、EventTarget接口

DOM的事件操作(监听和触发)，都定义在EventTarget接口。所有节点对象都部署了这个接口，其他一些需要事件通信的浏览器内置对象（比如，XMLHttpRequest、AudioNode、AudioContext）也部署了这个接口。
该接口主要提供三个实例方法。

addEventListener: 绑定事件的监听函数

removeEventListener: 移除事件的监听函数

dispatchEvent: 触发事件

1.1、EventTarget.addEventListener()

EventTarget.addEventListener()用于在当前节点或对象上，定义一个特定事件的监听函数。一旦这个事件发生，就会执行监听函数。该方法没有返回值。

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

该方法接收三个参数.

type: 事件名称，大小写敏感。

listener: 监听函数。事件发生时，会调用该监听函数。

useCapture: 布尔值，表示监听函数是否在捕获阶段（capture）触发，默认为false（监听函数只在冒泡阶段被触发）。该参数可选。

下面是一个例子。

function hello () {
    console.log('hello world');
}
let button = document.getElementById('btn');
button.addEventListener('click', hello, false);

上面的代码中，button节点的addEventListener方法绑定click事件的监听函数hello,该函数只在冒泡阶段触发。

关于参数，有两个地方需要注意。

首先，第二个参数除了监听函数，还可以是一个具有handleEvent方法的对象.
1
2
3
4
5
buttonElement.addEventListener('click', {
handleEvent: function (event) {
console.log('click');
}
});
上面代码中，addEventListener方法的第二个参数，就是一个具有handleEvent方法的对象。
其次，第三个参数除了布尔值useCapture，还可以是一个属性配置对象。该对象有以下属性。

capture：布尔值，表示该事件是否在捕获阶段触发监听函数。

once：布尔值，表示监听函数是否只触发一次，然后就自动移除。

passive：布尔值，表示监听函数不会调用事件的preventDefault方法。如果监听函数调用了，浏览器将忽略这个要求，并在监控台输出一行警告。

addEventListener方法可以为针对当前对象的同一个事件，添加多个不同的监听函数。这些函数按照添加顺序触发，即先添加先触发。如果为同一个事件多次添加同一个监听函数，该函数只会执行一次，多余的添加将自动被去除（不必使用removeEventListener方法手动去除）。

function hello() {
    console.log('Hello world');
}
document.addEventListener('click', hello, false);
document.addEventListener('click', hello, false);

执行上面代码，点击文档只会输出一行Hello world。
如果希望向监听函数传递参数，可以用匿名函数包装一下监听函数。

function print(x) {
    console.log(x);
}
let el = document.getElementById('div1');
el.addEventListener('click', function () {
    print('hello');
}, false);

上面代码通过匿名函数，向监听函数print传递一个参数。
监听函数内部的this,指向当前事件所在的那个对象。

//HTML代码如下
//<p id="area">Hello</p>
let area = document.getElementById('area');
area.addEventListener('click', function (e) {
    console.log(this.nodeName);//"P"
}, false);

上面代码中，监听函数内部的this指向事件所在的对象area。

1.2、EventTarget.removeEventListener()

EventTarget.removeEventListener方法用来移除addEventListener方法添加的事件监听函数。该方法没有返回值。

1 2	div.addEventListener('click', listener, false); div.removeEventListener('click', listener, false);

removeEventListener方法的参数，与addEventListener方法完全一致。它的第一个参数“事件类型”，大小写敏感。
注意，removeEventListener方法移除的监听函数，必须是addEventListener方法添加的那个监听函数，而且必须在同一个元素节点，否则无效。

1 2	div.addEventListener('click', function (e) {}, false); div.removeEventListener('click', function (e) {}, false);

上面代码中，removeEventListener方法无效，因为监听函数不是同一个匿名函数。

1 2	element.addEventListener('mousedown', handleMouseDown, true); element.removeEventListener("mousedown", handleMouseDown, false);

上面代码中，removeEventListener方法也是无效的，因为第三个参数不一样。

1.3、EventTarget.dispatchEvent()

EventTarget.dispatchEvent方法在当前节点上触发指定事件，从而触发监听函数的执行。该方法返回一个布尔值，只要有一个监听函数调用了Event.preventDefault()，则返回值为false，否则为true。

1	target.dispatchEvent(event);

dispatchEvent方法的参数是一个Event对象的实例

1
2
3

para.addEventListener('click', hello, false);
let event = new Event('click');
para.dispatchEvent(event);

上面代码在当前节点触发了click事件
如果dispatchEvent方法的参数为空，或者不是一个有效的事件对象，将报错。
下面代码根据dispatchEvent方法的返回值，判断事件是否被取消了。

let canceled = !cb.dispatchEvent(event);
if (canceled) {
    console.log('事件取消');
} else {
    console.log('事件未取消');
}

2、监听函数

浏览器的事件模型，就是通过监听函数（listener）对事件做出反应。事件发生后，浏览器监听到了这个事件，就会执行对应的监听函数。这是事件驱动编程模式（event-driven）的主要编程方式。
JavaScript 有三种方法，可以为事件绑定监听函数。

2.1、HTML的on-属性

HTML语言允许在元素的属性中，直接定义某些事件的监听代码。

1
2
3

<body onload="doSomething()">
    <div onclick="console.log('触发事件')"></div>
</body>

上面代码为body节点的load事件、div节点的click事件，指定了监听代码。一旦事件发生，就会执行这段代码。
元素的事件监听属性，都是on加上事件名，比如onload就是on + load，表示load事件的监听代码。
注意，这些属性的值是将会执行的代码，而不是一个函数。

<!-- 正确 -->
<body onload="doSomething()">

<!-- 错误 -->
<body onload="doSomething">

一旦指定的事件发生，on-属性的值是原样传入 JavaScript 引擎执行。因此如果要执行函数，不要忘记加上一对圆括号。

使用这个方法指定的监听代码，只会在冒泡阶段触发。

1
2
3

<div onclick="console.log(2)">
  <button onclick="console.log(1)">点击</button>
</div>

上面代码中，<button>是<div>的子元素。<button>的click事件，也会触发<div>的click事件。由于on-属性的监听代码，只在冒泡阶段触发，所以点击结果是先输出1，再输出2，即事件从子元素开始冒泡到父元素。
直接设置on-属性，与通过元素节点的setAttribute方法设置on-属性，效果是一样的。

1
2
3

el.setAttribute('onclick', 'doSomething()');
<!-- 等同于 -->
<!-- <Element onclick="doSomething()"> -->

2.2、元素节点的事件属性

元素节点对象的事件属性，同样可以指定监听函数。

window.onload = doSomething;
div.onclick = function (event) {
    console.log('触发事件')
}

使用这个方法指定的监听函数，也是只会在冒泡阶段触发。
注意，这种方法与 HTML 的on-属性的差异是，它的值是函数名（doSomething），而不像后者，必须给出完整的监听代码（doSomething()）。

2.3、EventTarget.addEventListener()

所有DOM节点实例都有addEventListener方法，用来未该节点定义事件的监听函数。

1	window.addEventListener('load', doSomething, false);

2.4、小结

上面三种方法，第一种”HTML的on-属性”，违反了HTML与JavaScript代码相分离的原则，将两者写在一起，不利于分工，因此不推荐使用。
第二种”元素节点的事件属性”的缺点在于，同一个事件只能定义一个监听函数，也就是说，如果定义两次onclick属性，后一次定义会覆盖前一次。因此，也不推荐使用。
第三种EventTarget.addEventListener是推荐的指定监听函数的方法。它有如下优点：

同一个事件可以添加多个监听函数。

能够指定在哪个阶段（捕获阶段还是冒泡阶段）触发监听函数。

除了 DOM 节点，其他对象（比如window、XMLHttpRequest等）也有这个接口，它等于是整个 JavaScript 统一的监听函数接口。

3、this的指向

监听函数内部的this指向触发事件的那个元素节点。

1	<button id="btn" onclick="console.log(this.id)">点击</button>

执行上面代码，点击后会输出btn。
其他两种监听函数的写法，this的指向也是如此。

// HTML 代码如下
// <button id="btn">点击</button>
var btn = document.getElementById('btn');

// 写法一
btn.onclick = function () {
  console.log(this.id);
};

// 写法二
btn.addEventListener(
  'click',
  function (e) {
    console.log(this.id);
  },
  false
);

上面两种写法，点击按钮以后也是输出btn。

4、事件的传播

一个事件发生后，会在子元素和父元素之间传播（propagation）。这种传播分成三个阶段

第一阶段：从window对象传导目标节点(上层传到底层), 称为”捕获阶段”（capture phase）。

第二阶段：从目标节点上触发，称为”目标阶段”(target phase).

第三阶段：从目标节点传导回window对象(从底层传回上层)，称为”冒泡阶段”（bubbling phase）。
这种三阶段的传播模型，使得同一个事件会在多个节点上触发。

1
2
3

<div>
    <p>点击</p>
</div>

上面代码中，<div>节点之中有一个<p>节点。
如果对这两个节点，都设置click事件的监听函数（每个节点的捕获阶段和监听阶段，各设置一个监听函数），共计设置四个监听函数。然后，对<p>点击，click事件会触发四次。

<div>
    <button>点击</button>
</div>
<script>
    let phases = {
        1: 'capture phase-捕获阶段',
        2: 'target phase-目标阶段',
        3: 'bubbling phase-冒泡阶段'
    };
    let div = document.querySelectorAll('div')[0];
    let button = document.querySelectorAll('button')[0];

    div.addEventListener('click', callback, false);
    button.addEventListener('click', callback, false);
    div.addEventListener('click', callback, true);
    button.addEventListener('click', callback, true);

    function callback(event) {
        let tag = event.currentTarget.tagName;
        let phase = phases[event.eventPhase];
        console.log(`Tag（标签名）: ${tag}, EventPhase(事件阶段): ${phase}`);
    }
</script>
<!-- 
点击以后的结果
Tag（标签名）: DIV, EventPhase(事件阶段): capture phase-捕获阶段
test.html:30 Tag（标签名）: BUTTON, EventPhase(事件阶段): target phase-目标阶段
test.html:30 Tag（标签名）: BUTTON, EventPhase(事件阶段): target phase-目标阶段
test.html:30 Tag（标签名）: DIV, EventPhase(事件阶段): bubbling phase-冒泡阶段
 -->

上面代码表示，click事件被触发四次：<div>节点的捕获阶段和冒泡阶段各1次，<button>节点的目标阶段触发了2次。

1、捕获阶段：事件从<div>向<button>传播时，触发<div>的click事件
2、目标阶段：事件从<div>到达<button>时，触发<button>的click事件
3、冒泡阶段：事件从<button>传回<div>时，再次触发<div>的click事件。

其中，<button>节点有两个监听函数（addEventListener方法第三个参数的不同，会导致绑定两个监听函数），因此它们都会因为click事件触发一次。所以，<button>会在target阶段有两次输出。
注意，浏览器总是假定click事件的目标节点，就是点击位置嵌套最深的那个节点（本例是<div>节点里面的<button>节点）。所以，<button>节点的捕获阶段和冒泡阶段，都会显示为target阶段。

事件传播的最上层对象是window，接着依次是document，html（document.documentElement）和body（document.body）。也就是说，上例的事件传播顺序，在捕获阶段依次为window、document、html、body、div、button，在冒泡阶段依次为button、div、body、html、document、window。

5、事件的代理

由于事件会在冒泡阶段向上传播到父节点，因此可以把子节点的监听函数定义在父节点上，由父节点的监听函数统一处理多个子元素的事件。这种方法叫做事件的代理（delegation）。

let ul = document.querySelector('ul');
ul.addEventListener('click', function (event) {
    if (event.target.tagName.toLowerCase() === 'li') {
        //some code ...
    }
})

上面代码中，click事件的监听函数定义在<ul>节点，但是实际上，它处理的是子节点<li>的click事件。这样做的好处是，只要定义一个监听函数，就能处理多个子节点的事件，而不用在每个<li>节点上定义监听函数。而且以后再添加子节点，监听函数依然有效。
如果希望事件到某个节点为止，不再传播，可以使用事件对象的stopPropagation方法.

// 事件传播到p元素后，就不再向下传播了
p.addEventListener('click', function (event) {
    event.stopPropagation();
}, true);
//事件冒泡到p元素后，就不再向上冒泡了
p.addEventListener('click', function (event) {
    event.stopPropagation();
}, false)

上面代码中，stopPropagation方法分别在捕获阶段和冒泡阶段，阻止了事件的传播。
但是，stopPropagation方法只会阻止事件的传播，不会阻止该事件触发<p>节点的其他click事件的监听函数。也就是说，不是彻底取消click事件。

p.addEventListener('click', function (event) {
  event.stopPropagation();
  console.log(1);
});
p.addEventListener('click', function(event) {
  // 会触发
  console.log(2);
});

上面代码中，p元素绑定了两个click事件的监听函数。stopPropagation方法只能阻止这个事件向其他元素传播。因此，第二个监听函数会触发。输出结果会先是1，然后是2。

如果想要彻底阻止这个事件的传播，不再触发后面所有click的监听函数，可以使用stopImmediatePropagation方法。

p.addEventListener('click', function (event) {
  event.stopImmediatePropagation();
  console.log(1);
});
p.addEventListener('click', function(event) {
  // 不会被触发
  console.log(2);
});

上面代码中，stopImmediatePropagation方法可以彻底阻止这个事件传播，使得后面绑定的所有click监听函数都不再触发。所以，只会输出1，不会输出2。

6、Event对象概述

事件发生以后，会产生一个事件对象，作为参数传给监听函数。浏览器原生提供一个Event对象，所有的事件都是这个对象的实例，或者说继承了Event.prototype对象。
Event对象本身就是一个构造函数，可以用来生成新的实例。

1	event = new Event(type, options);

Event构造函数接受两个参数。第一个参数type是字符串，表示事件的名称；第二个参数options是一个对象，表示事件对象的配置。该对象主要有下面两个属性。

bubbles：布尔值，可选，默认为false，表示事件对象是否冒泡。

cancelable：布尔值，可选，默认为false，表示事件是否可以被取消，即能否用Event.preventDefault()取消这个事件。一旦事件被取消，就好像从来没有发生过，不会触发浏览器对该事件的默认行为。

let ev = new Event(
    'look',
    {
        'bubbles': true,
        'cancelable': false
    }
);
document.dispatchEvent(ev);

上面代码新建一个look事件实例，然后使用dispatchEvent方法触发该事件。
注意，如果不是显式指定bubbles属性为true，生成的事件就只能在“捕获阶段”触发监听函数。

// HTML 代码为
// <div><p>Hello</p></div>
var div = document.querySelector('div');
var p = document.querySelector('p');

function callback(event) {
  var tag = event.currentTarget.tagName;
  console.log('Tag: ' + tag); // 没有任何输出
}

div.addEventListener('click', callback, false);

var click = new Event('click');
p.dispatchEvent(click);

上面代码中，p元素发出一个click事件，该事件默认不会冒泡。div.addEventListener方法指定在冒泡阶段监听，因此监听函数不会触发。如果写成div.addEventListener('click', callback, true)，那么在“捕获阶段”可以监听到这个事件。
另一方面，如果这个事件在div元素上触发。

1	div.dispatchEvent(click);

那么，不管div元素是在冒泡阶段监听，还是在捕获阶段监听，都会触发监听函数。因为这时div元素是事件的目标，不存在是否冒泡的问题，div元素总是会接收到事件，因此导致监听函数生效。

7、Event对象的实例属性

7.1、Event.bubbles, Event.eventPhase

Event.bubbles属性返回一个布尔值，表示当前事件是否会冒泡。该属性为只读属性，一般用来了解Event实例是否可以冒泡。前面说过，除非显式声明，Event构造函数生成的事件，默认是不冒泡的。
Event.eventPhase属性返回一个整数常量，表示事件目前所处的阶段。该属性只读。

1	let phase = event.eventPhase;

Event.eventPhase的返回值有四种可能。

0, 事件目前没有发生
1, 事件目前处于捕获阶段，即处于从祖先节点向目标节点的传播过程中。
2, 事件到达目标节点，即Event.target属性指向的那个节点。
3, 事件处于冒泡阶段，即处于从目标节点向祖先节点的反向传播过程中。

7.2、Event.cancelable, Event.cancelBubble, Event.defaultPrevented

Event.cancelable属性返回一个布尔值，表示事件是否可以取消。该属性为只读属性，一般用来了解 Event 实例的特性。
大多数浏览器的原生事件是可以取消的。比如，取消click事件，点击链接将无效。但是除非显式声明，Event构造函数生成的事件，默认是不可以取消的。

1 2	let evt = new Event('foo'); evt.cancelable //false

当Event.cancelable属性为true时，调用Event.preventDefault()就可以取消这个事件，阻止浏览器对该事件的默认行为。
如果事件不能取消，调用Event.preventDefault()会没有任何效果。所以使用这个方法之前，最好用Event.cancelable属性判断一下是否可以取消。

function preventEvent(event) {
    if (event.cancelable) {
        event.preventDefault();
    } else {
        console.warn(`this event couldn't be canceled.`);
        console.dir(event);
    }
}

Event.cancelBubble属性是一个布尔值，如果设为true，相当于执行Event.stopPropagation()，可以阻止事件的传播。
Event.defaultPrevented属性返回一个布尔值，表示该事件是否调用过Event.preventDefault方法。该属性只读。

1
2
3

if (event.defaultPrevented) {
    console.log('该事件已经取消了');
}

7.3、Event.currentTarget, Event.target

Event.currentTarget属性返回事件当前所在的节点，即正在执行的监听函数所绑定的那个节点。
Event.target属性返回原始触发事件的那个节点，即事件最初发生的节点。事件传播过程中，不同节点的监听函数内部的Event.target与Event.currentTarget属性的值是不一样的，前者总是不变的，后者则是指向监听函数所在的那个节点对象。

7.4、Event.type

Event.type属性返回一个字符串，表示事件类型。事件的类型是在生成事件的时候。该属性只读。

1 2	let evt = new Event('foo'); evt.type;//"foo"

7.5、Event.timeStamp

Event.timeStamp属性返回一个毫秒时间戳，表示事件发生的时间。它是相对于网页加载成功开始计算的。

7.6、Event.isTrusted

Event.isTrusted属性返回一个布尔值，表示该事件是否由真实的用户行为产生。比如，用户点击链接会产生一个click事件，该事件是用户产生的；Event构造函数生成的事件，则是脚本产生的。

1 2	let evt = new Event('foo'); evt.isTrusted //false

上面代码中，evt对象是脚本产生的，所以isTrusted属性返回false。

7.7、Event.detail

Event.detail属性只有浏览器的 UI （用户界面）事件才具有。该属性返回一个数值，表示事件的某种信息。具体含义与事件类型相关。比如，对于click和dbclick事件，Event.detail是鼠标按下的次数（1表示单击，2表示双击，3表示三击）；对于鼠标滚轮事件，Event.detail是滚轮正向滚动的距离，负值就是负向滚动的距离，返回值总是3的倍数。

// HTML 代码如下
// <p>Hello</p>
function giveDetails(e) {
  console.log(e.detail);
}

document.querySelector('p').onclick = giveDetails;

8、Event对象的实例方法

8.1、Event.preventDefault()

Event.preventDefault方法取消浏览器对当前事件的默认行为。比如点击链接后，浏览器默认会跳转到另一个页面，使用这个方法以后，就不会跳转了；再比如，按一下空格键，页面向下滚动一段距离，使用这个方法以后也不会滚动了。该方法生效的前提是，事件对象的cancelable属性为true，如果为false，调用该方法没有任何效果。

注意，该方法只是取消事件对当前元素的默认影响，不会阻止事件的传播。如果要阻止传播，可以使用stopPropagation()或stopImmediatePropagation()方法。

// HTML 代码为
// <input type="checkbox" id="my-checkbox" />
var cb = document.getElementById('my-checkbox');

cb.addEventListener(
  'click',
  function (e){ e.preventDefault(); },
  false
);

上面代码中，浏览器的默认行为是单击会选中单选框，取消这个行为，就导致无法选中单选框。
利用这个方法，可以为文本输入框设置校验条件。如果用户的输入不符合条件，就无法将字符输入文本框。

// HTML 代码为
// <input type="text" id="my-input" />
let input = document.getElementById('my-input');
input.addEventListener('keypress', checkName, false);
function checkName(e) {
    console.log(e);
    if (e.charCode < 97 || e.charCode > 122) {
        e.preventDefault();
    }
}

上面代码为文本框的keypress事件设定监听函数后，将只能输入小写字母，否则输入事件的默认行为（写入文本框）将被取消，导致不能向文本框输入内容。

8.2、Event.stopPropagation()

stopPropagation方法阻止事件在DOM中继续传播，防止再触发定义在别的节点上的监听函数，但是不包括在当前节点上其他的事件监听函数。

function stopEvent(e) {
    e.stopPropagation();
}
el.addEventListener('click', stopEvent, false);

上面代码中，click事件将不会进一步冒泡到el节点的父节点

8.3、Event.stopImmediatePropagation()

Event.stopImmediatePropagation方法阻止同一个事件的其他监听函数被调用，不管监听函数定义在当前节点还是其他节点。也就是说，该方法阻止事件的传播，比Event.stopPropagation()更彻底。

如果同一个节点对于同一个事件指定了多个监听函数，这些函数会根据添加的顺序依次调用。只要其中有一个监听函数调用了Event.stopImmediatePropagation方法，其他的监听函数就不会再执行了。

function l1(e){
  e.stopImmediatePropagation();
}
function l2(e){
  console.log('hello world');
}
el.addEventListener('click', l1, false);
el.addEventListener('click', l2, false);

上面代码在el节点上，为click事件添加了两个监听函数l1和l2。由于l1调用了event.stopImmediatePropagation方法，所以l2不会被调用。

8.4、Event.composedPath()

Event.composedPath()返回一个数组，成员是事件的最底层节点和依次冒泡经过的所有上层节点。

// HTML 代码如下
// <div>
//   <p>Hello</p>
// </div>
var div = document.querySelector('div');
var p = document.querySelector('p');

div.addEventListener('click', function (e) {
  console.log(e.composedPath());
}, false);
// [p, div, body, html, document, Window]

上面代码中，click事件的最底层节点是p，向上依次是div、body、html、document、Window。

9、CustomEvent接口

CustomEvent 接口用于生成自定义的事件实例。那些浏览器预定义的事件，虽然可以手动生成，但是往往不能在事件上绑定数据。如果需要在触发事件的同时，传入指定的数据，就可以使用 CustomEvent 接口生成的自定义事件对象。
浏览器原生提供CustomEvent()构造函数，用来生成 CustomEvent 事件实例。

1	new CustomEvent(type, options)

CustomEvent()构造函数接受两个参数。第一个参数是字符串，表示事件的名字，这是必须的。第二个参数是事件的配置对象，这个参数是可选的。CustomEvent的配置对象除了接受 Event 事件的配置属性，只有一个自己的属性。

detail：表示事件的附带数据，默认为null。
下面是一个例子。

var event = new CustomEvent('build', { 'detail': 'hello' });

function eventHandler(e) {
  console.log(e.detail);
}

document.body.addEventListener('build', function (e) {
  console.log(e.detail);
});

document.body.dispatchEvent(event);

上面代码中，我们手动定义了build事件。该事件触发后，会被监听到，从而输出该事件实例的detail属性（即字符串hello）。
下面是另一个例子。

var myEvent = new CustomEvent('myevent', {
  detail: {
    foo: 'bar'
  },
  bubbles: true,
  cancelable: false
});

el.addEventListener('myevent', function (event) {
  console.log('Hello ' + event.detail.foo);
});

el.dispatchEvent(myEvent);

上面代码也说明，CustomEvent 的事件实例，除了具有 Event 接口的实例属性，还具有detail属性。