事件的本质是程序各个组成部分之间的一种通信方式,也是异步编程的一种实现。DOM 支持大量的事件,本章开始,我们一起看看 DOM 的事件编程。
1 概念
DOM 的事件操作(监听和触发),都定义在EventTarget接口。所有节点对象都部署了这个接口,其他一些需要事件通信的浏览器内置对象(比如,XMLHttpRequest、AudioNode、AudioContext)也部署了这个接口。
该接口主要提供三个实例方法:
- addEventListener:绑定事件的监听函数
- removeEventListener:移除事件的监听函数
- dispatchEvent:触发事件
2 EventTarget.addEventListener()
EventTarget.addEventListener()用于在当前节点或对象上,定义一个特定事件的监听函数。一旦这个事件发生,就会执行监听函数。该方法没有返回值:
target.addEventListener(type, listener[, useCapture]);
该方法接受三个参数:
- type:事件名称,大小写敏感。
- listener:监听函数。事件发生时,会调用该监听函数。
- useCapture:布尔值,表示监听函数是否在捕获阶段(capture)触发(后面的章节会涉及到),默认为false(监听函数只在冒泡阶段被触发)。该参数可选。
下面是一个例子:
function hello() {
console.log('Hello world');
}
let btn = document.getElementById('btn');
btn.addEventListener('click', hello, false);
上面代码中,btn节点的addEventListener方法绑定click事件的监听函数hello,该函数只在冒泡阶段触发。
关于参数,有两个地方需要注意。
首先,第二个参数除了监听函数,还可以是一个具有handleEvent方法的对象:
buttonElement.addEventListener('click', {
handleEvent: function (event) {
console.log('click');
}
});
上面代码中,addEventListener方法的第二个参数,就是一个具有handleEvent方法的对象。
其次,第三个参数除了布尔值useCapture,还可以是一个属性配置对象。该对象有以下属性。
- capture:布尔值,表示该事件是否在捕获阶段触发监听函数。
- once:布尔值,表示监听函数是否只触发一次,然后就自动移除。
- passive:布尔值,表示监听函数不会调用事件的preventDefault方法。如果监听函数调用了,浏览器将忽略这个要求,并在监控台输出一行警告。
如果希望事件监听函数只执行一次,可以打开属性配置对象的once属性:
element.addEventListener('click', function (event) {
// 只执行一次的代码
}, {once: true});
addEventListener方法可以为针对当前对象的同一个事件,添加多个不同的监听函数。这些函数按照添加顺序触发,即先添加先触发。如果为同一个事件多次添加同一个监听函数,该函数只会执行一次,多余的添加将自动被去除(不必使用removeEventListener方法手动去除)。
使用如下HTML:
执行上面代码,点击文档只会输出一行Hello JavaScript!。
如果希望向监听函数传递参数,可以用匿名函数包装一下监听函数:
function print(x) {
console.log(x);
}
let el = document.getElementById('div1');
el.addEventListener('click', () => { print('Hello'); }, false);
上面代码通过匿名函数,向监听函数print传递了一个参数。
监听函数内部的this,指向当前事件所在的那个对象:
上面代码中,监听函数内部的this指向事件所在的对象p。
这里如果使用匿名箭头函数(() =>)的话,this的指向会是undefined,故此我们也要看情况使用箭头函数。
3 EventTarget.removeEventListener()
EventTarget.removeEventListener方法用来移除addEventListener方法添加的事件监听函数。该方法没有返回值:
div.addEventListener('click', listener, false);
div.removeEventListener('click', listener, false);
removeEventListener方法的参数,与addEventListener方法完全一致。它的第一个参数“事件类型”,大小写敏感。
注意,removeEventListener方法移除的监听函数,必须是addEventListener方法添加的那个监听函数,而且必须在同一个元素节点,否则无效:
div.addEventListener('click', function (e) {}, false);
div.removeEventListener('click', function (e) {}, false);
上面代码中,removeEventListener方法无效,因为监听函数不是同一个匿名函数。
element.addEventListener('mousedown', handleMouseDown, true);
element.removeEventListener("mousedown", handleMouseDown, false);
上面代码中,removeEventListener方法也是无效的,因为第三个参数不一样。
4 EventTarget.dispatchEvent()
EventTarget.dispatchEvent方法在当前节点上触发指定事件,从而触发监听函数的执行。该方法返回一个布尔值,只要有一个监听函数调用了Event.preventDefault(),则返回值为false,否则为true。
target.dispatchEvent(event)
dispatchEvent方法的参数是一个Event对象的实例(后面的章节会涉及到 Event 对象):
上面代码在当前节点触发了click事件。
如果dispatchEvent方法的参数为空,或者不是一个有效的事件对象,将报错:
下面代码根据dispatchEvent方法的返回值,判断事件是否被取消了:
let canceled = !cb.dispatchEvent(event);
if (canceled) {
console.log('事件取消');
} else {
console.log('事件未取消');
}
5 事件模型的监听函数
浏览器的事件模型,就是通过监听函数(listener)对事件做出反应。事件发生后,浏览器监听到了这个事件,就会执行对应的监听函数。这是事件驱动编程模式(event-driven)的主要编程方式。
JavaScript 有三种方法,可以为事件绑定监听函数。
5.1 HTML 的 on- 属性
HTML 语言允许在元素的属性中,直接定义某些事件的监听代码:
<body onload="doSomething()">
<div onclick="console.log('触发事件')">
上面代码为body节点的load事件、div节点的click事件,指定了监听代码。一旦事件发生,就会执行这段代码。
元素的事件监听属性,都是on加上事件名,比如onload就是on + load,表示load事件的监听代码。
注意,这些属性的值是将会执行的代码,而不是一个函数:
<!-- 正确 -->
<body onload="doSomething()">
<!-- 错误 -->
<body onload="doSomething">
一旦指定的事件发生,on-属性的值是原样传入 JavaScript 引擎执行。因此如果要执行函数,不要忘记加上一对圆括号。
使用这个方法指定的监听代码,只会在冒泡阶段触发:
<div onclick="console.log(2)">
<button onclick="console.log(1)">点击</button>
</div>
上面代码中,<button>是<div>的子元素。<button>的click事件,也会触发<div>的click事件。由于on-属性的监听代码,只在冒泡阶段触发,所以点击结果是先输出1,再输出2,即事件从子元素开始冒泡到父元素。
直接设置on-属性,与通过元素节点的setAttribute方法设置on-属性,效果是一样的:
el.setAttribute('onclick', 'doSomething()');
// 等同于
// <Element onclick="doSomething()">
5.2 元素节点的事件属性
元素节点对象的事件属性,同样可以指定监听函数:
window.onload = doSomething;
div.onclick = event => {
console.log('触发事件');
};
使用这个方法指定的监听函数,也是只会在冒泡阶段触发。
注意,这种方法与 HTML 的on-属性的差异是,它的值是函数名(doSomething),而不像后者,必须给出完整的监听代码(doSomething())。
5.3 EventTarget.addEventListener()
所有 DOM 节点实例都有addEventListener方法,用来为该节点定义事件的监听函数:
window.addEventListener('load', doSomething, false);
addEventListener方法的详细介绍就在前文。
5.4 小结
上面三种方法,第一种“HTML 的 on- 属性”,违反了 HTML 与 JavaScript 代码相分离的原则,将两者写在一起,不利于代码分工,因此不推荐使用。
第二种“元素节点的事件属性”的缺点在于,同一个事件只能定义一个监听函数,也就是说,如果定义两次onclick属性,后一次定义会覆盖前一次。因此,也不推荐使用。
第三种EventTarget.addEventListener是推荐的指定监听函数的方法。它有如下优点:
- 同一个事件可以添加多个监听函数。
- 能够指定在哪个阶段(捕获阶段还是冒泡阶段)触发监听函数。
- 除了 DOM 节点,其他对象(比如window、XMLHttpRequest等)也有这个接口,它等于是整个 JavaScript 统一的监听函数接口。
6 this 的指向
监听函数内部的this指向触发事件的那个元素节点:
<button id="btn" onclick="console.log(this.id)">click</button>
执行上面代码,点击后会输出btn。
其他两种监听函数的写法,this的指向也是如此:
// HTML 代码如下
// <button id="btn">点击</button>
let btn = document.getElementById('btn');
// 写法一
btn.onclick = function () {
console.log(this.id);
};
// 写法二
btn.addEventListener(
'click',
function (e) {
console.log(this.id);
},
false
);
上面两种写法,点击按钮以后也是输出btn。
7 事件的传播
一个事件发生后,会在子元素和父元素之间传播(propagation)。这种传播分成三个阶段:
- 第一阶段:从window对象传导到目标节点(上层传到底层),称为“捕获阶段”(capture phase)。
- 第二阶段:在目标节点上触发,称为“目标阶段”(target phase)。
- 第三阶段:从目标节点传导回window对象(从底层传回上层),称为“冒泡阶段”(bubbling phase)。
这种三阶段的传播模型,使得同一个事件会在多个节点上触发。
使用如下HTML:
上面代码中,foo(<div>)节点之中有一个para(<p>)节点。
如果对这两个节点,都设置click事件的监听函数(每个节点的捕获阶段和冒泡阶段,各设置一个监听函数),共计设置四个监听函数。然后,对para点击,click事件会触发四次:
上面代码表示,click事件被触发了四次:foo节点的捕获阶段和冒泡阶段各1次,para节点的目标阶段触发了2次。
- 捕获阶段:事件从foo向para传播时,触发foo的click事件;
- 目标阶段:事件从foo到达para时,触发para的click事件;
- 冒泡阶段:事件从para传回foo时,再次触发foo的click事件。
其中,para节点有两个监听函数(addEventListener方法第三个参数的不同,会导致绑定两个监听函数),因此它们都会因为click事件触发一次。所以,para会在target阶段有两次输出。
注意,浏览器总是假定click事件的目标节点,就是点击位置嵌套最深的那个节点(本例是foo节点里面的para节点)。所以,para节点的捕获阶段和冒泡阶段,都会显示为target阶段。
事件传播的最上层对象是window,接着依次是document,html(document.documentElement)和body(document.body)。也就是说,上例的事件传播顺序,在捕获阶段依次为window、document、html、body、div、p,在冒泡阶段依次为p、div、body、html、document、window。
8 事件的代理
由于事件会在冒泡阶段向上传播到父节点,因此可以把子节点的监听函数定义在父节点上,由父节点的监听函数统一处理多个子元素的事件。这种方法叫做事件的代理(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元素绑定了两个click事件的监听函数。stopPropagation方法只能阻止这个事件的传播,不能取消这个事件,因此,第二个监听函数会触发。输出结果会先是1,然后是2。
如果想要彻底取消该事件,不再触发后面所有click的监听函数,可以使用stopImmediatePropagation方法:
上面代码中,stopImmediatePropagation方法可以彻底取消这个事件,使得后面绑定的所有click监听函数都不再触发。所以,只会输出1,不会输出2。