事件是一种异步编程的实现方式,本质上是程序各个组成部分之间的通信。
DOM支持大量的事件,本节介绍DOM的事件编程。
一、EventTarget接口(即三个方法)
DOM的事件操作(监听和触发),都定义在EventTarget接口。Element节点、document节点和window对象,都部署了这个接口。此外,XMLHttpRequest、AudioNode、AudioContext等浏览器内置对象,也部署了这个接口。
该接口就是三个方法。
- addEventListener:绑定事件的监听函数。
- removeEventListener:移除事件的监听函数。
- dispatchEvent:触发事件。
1.1、addEventListener()
addEventListener
方法用于在当前节点或对象上,定义一个特定事件的监听函数。
//使用格式
target.addEventListener(type, listener[, useCapture]);
//实例
window.addEventListener('load', function(){...}, false);
addEventListener
方法接受三个参数。
- type:事件名称,大小写敏感。
- listener:监听函数。事件发生时,会调用该监听函数。
- useCapture:布尔值,表示监听函数是否在捕获阶段(capture)触发,默认为
false
(监听函数只在冒泡阶段被触发)。老式浏览器规定该参数必写,较新版本的浏览器允许该参数可选。为了保持兼容,建议总是写上该参数。
下面是一个例子。
function hello() {
console.log('Hello world');
}
var button = document.getElementById('btn');
button.addEventListener('click', hello, false);
上面代码中,addEventListener
方法为button
元素节点,绑定click
事件的监听函数hello
,该函数只在冒泡阶段触发。
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);
}
var el = document.getElementById('div1');
el.addEventListener('click', function(){
print('Hello');
}, false);
上面代码通过匿名函数,向监听函数print
传递了一个参数。
1.2、removeEventListener()
removeEventListener
方法用来移除addEventListener
方法添加的事件监听函数。
div.addEventListener('click', listener, false);
div.removeEventListener('click', listener, false);
removeEventListener
方法的参数,与addEventListener
方法完全一致。它的第一个参数“事件类型”,大小写敏感。
注意,removeEventListener
方法移除的监听函数,必须与对应的addEventListener
方法的参数完全一致,而且必须在同一个元素节点,否则无效。
1.3、dispatchEvent()
dispatchEvent
方法在当前节点上触发指定事件,从而触发监听函数的执行。该方法返回一个布尔值,只要有一个监听函数调用了Event.preventDefault()
,则返回值为false,否则为true。
target.dispatchEvent(event)
dispatchEvent
方法的参数是一个Event对象的实例。
para.addEventListener('click', hello, false);
var event = new Event('click');
para.dispatchEvent(event);
上面代码在当前节点触发了click
事件。
如果dispatchEvent
方法的参数为空,或者不是一个有效的事件对象,将报错。
下面代码根据dispatchEvent
方法的返回值,判断事件是否被取消了。
var canceled = !cb.dispatchEvent(event);
if (canceled) {
console.log('事件取消');
} else {
console.log('事件未取消');
}
}
二、监听函数
监听函数(listener)是事件发生时,程序所要执行的函数。它是事件驱动编程模式的主要编程方式。
DOM提供三种方法,可以用来为事件绑定监听函数。
2.1、HTML标签的on-属性
HTML语言允许在元素标签的属性中,直接定义某些事件的监听代码。
<body onload="doSomething()">
<div onclick="console.log('触发事件')">
上面代码为body
节点的load
事件、div
节点的click
事件,指定了监听函数。
使用这个方法指定的监听函数,只会在冒泡阶段触发。
注意,使用这种方法时,on-
属性的值是将会执行的代码,而不是一个函数。
<!-- 正确 -->
<body onload="doSomething()">
<!-- 错误 -->
<body onload="doSomething">
一旦指定的事件发生,on-
属性的值是原样传入JS引擎执行。因此如果要执行函数,不要忘记加上一对圆括号。
另外,Element元素节点的setAttribute
方法,其实设置的也是这种效果。
Element.setAttribute('onclick', 'doSomething()');
2.2、Element节点的事件属性
Element节点对象有事件属性,同样可以指定监听函数。
window.onload = doSomething;
div.onclick = function(event){
console.log('触发事件');
};
使用这个方法指定的监听函数,只会在冒泡阶段触发。
2.3、addEventListener方法
通过Element
节点、document
节点、window
对象的addEventListener
方法,也可以定义事件的监听函数。
window.addEventListener('load', doSomething, false);
在上面三种方法中,第一种“HTML标签的on-
属性”,违反了HTML与JS代码相分离的原则;第二种“Element节点的事件属性”的缺点是,同一个事件只能定义一个监听函数,也就是说,如果定义两次onclick
属性,后一次定义会覆盖前一次。因此,这两种方法都不推荐使用,除非是为了程序的兼容问题,因为所有浏览器都支持这两种方法。
addEventListener
是推荐的指定监听函数的方法。它的优点如下:
- 可以针对同一个事件,添加多个监听函数
- 能够指定在哪个阶段(捕获阶段还是冒泡阶段)触发监听函数
- 除了DOM节点,还可以部署
window
、XMLHttpRequest
等对象上面,等于统一了整个JS的监听函数接口。
2.4、this对象的指向
实际编程中,监听函数内部的this
对象,常常需要指向触发事件的那个Element
节点。
addEventListener
方法指定的监听函数,内部的this
对象总是指向触发事件的那个节点。
//HTML代码
//<p id="para">Hello</p>
var id = 'doc';
var para = document.getElementById('para');
function hello(){
console.log(this.id);
}
para.addEventListener('click', hello, false);
执行上面代码,点击<p>
节点会输出para
。这是因为监听函数被拷贝成了节点的一个属性,所以this
指向节点对象。使用下面的写法,会看得更清楚。
para.onclick = hello;
如果将监听函数部署在Element
节点的on-
属性上面,this
不会指向触发事件的元素节点。
<p id="para" onclick="hello()">Hello</p>
<!-- 或者使用JavaScript代码 -->
<script>
pElement.setAttribute('onclick', 'hello()');
</script>
执行上面代码,点击<p>
节点会输出doc
。这是因为这里只是调用hello函数,而hello函数实际是在全局作用域执行,相当于下面的代码。
para.onclick = function () {
hello();
}
一种解决方法是,不引入函数作用域,直接在on-
属性写入所要执行的代码。因为on-
属性是在当前节点上执行的。
<p id="para" onclick="console.log(id)">Hello</p>
<!-- 或者 -->
<p id="para" onclick="console.log(this.id)">Hello</p>
上面两行,最后输出的都是para
。
总结一下,以下写法的this
对象都指向Element节点。
// JavaScript代码
element.onclick = print
element.addEventListener('click', print, false)
element.onclick = function () {console.log(this.id);}
// HTML代码
<element onclick="console.log(this.id)">
以下写法的this对象,都指向全局对象。
// JavaScript代码
element.onclick = function (){ doSomething() };
element.setAttribute('onclick', 'doSomething()');
// HTML代码
<element onclick="doSomething()">
三、事件的传播
3.1、传播的三个阶段
当一个事件发生后,它会在不同的DOM节点之间传播(propagation)。这种传播分成三个阶段:
- 第一阶段:从window对象传导到目标节点,称为“捕获阶段”(capture phase)。
- 第二阶段:在目标节点上触发,称为“目标阶段”(target phase)。
- 第三阶段:从目标节点传导回window对象,称为“冒泡阶段”(bubbling phase)。
这种三阶段的传播模型,会使得一个事件在多个节点上触发(只要节点上绑定对应事件的监听函数)。比如,假设点击<div>
之中嵌套一个<p>
节点。
<div>
<p>Click Me</p>
</div>
如果对这两个节点的click
事件都设定监听函数,则click
事件会被触发四次。
var phase = {
1: 'capture',
2: 'target',
3: 'bubble'
};
var div = document.querySelector('div');
var p = document.querySelector('p');
div.addEventListener('click', callback, true); //函数只在捕获阶段被触发
p.addEventListener('click', callback, true);
div.addEventListener('click', callback, false); //函数只在冒泡阶段被触发
p.addEventListener('click', callback, false);
function callback(event){
var tag = event.currentTarget.tagName;
var phase = phases[event.eventPhase];
console.log("Tag: '" + tag + "'. EventPhase: '" + phase + "'");
}
// 点击以后的结果
// Tag: 'DIV'. EventPhase: 'capture'
// Tag: 'P'. EventPhase: 'target'
// Tag: 'P'. EventPhase: 'target'
// Tag: 'DIV'. EventPhase: 'bubble'
上面的代码表示,click
事件被触发了四次:<p>
节点的捕获阶段和冒泡阶段各一次,<div>
节点的捕获和冒泡阶段各一次。
1、捕获阶段:事件从
<div>
向<p>
传播时,触发<div>
的click
事件;
2、目标阶段:事件从<div>
到达<p>
时,触发<p>
的click
事件;
3、目标阶段:事件离开<p>
时,触发<p>
的click
事件;
4、冒泡阶段:事件从<p>
传回<div>
时,再次触发<div>
的click
事件。
注意,用户点击网页的时候,浏览器总是假定click
事件的目标节点,就是点击位置的嵌套最深的那个节点(嵌套在<div>
节点的<p>
节点)。所以,<p>
节点的捕获阶段和冒泡阶段,都会显示为target
阶段。
事件传播的最上层对象是window
,接着依次是document
,html
(document.documentElement
)和body
(document.dody
)。也就是说,如果<body>
元素中有一个<div>
元素,点击该元素。事件的传播顺序,在捕获阶段依次为window
、document
、html
、body
、div
,在冒泡阶段依次为div
、body
、html
、document
、window
。
3.2、事件的代理
由于事件会在冒泡阶段向上传播到父节点,因此可以把子节点的监听函数定义在父节点上,由父节点的监听函数统一处理多个子元素的事件。这种方法叫做事件的代理(delegation)。
var ul = document.querySelector('ul');
ul.addEventListener('click', function(event) {
if (event.target.tagName.toLowerCase() === 'li') {
// some code
}
});
上面代码的click
事件的监听函数定义在<ul>
节点上,但是实际上,它处理的是子节点<li>
的click
事件。这样做的好处是,只要定义一个监听函数,就能处理多个子节点的事件,而且以后再添加子节点,监听函数依然有效。
如果希望事件到某个节点为止,不再传播,可以使用事件对象的stopPropagation
方法。
p.addEventListener('click', function(event) {
event.stopPropagation();
});
使用上面的代码以后,click
事件在冒泡阶段到达<p>
节点以后,就不再向上(父节点的方向)传播了。
但是,stopPropagation
方法只会阻止当前监听函数的传播,不会阻止<p>
节点上的其他click
事件的监听函数。如果想要不再触发那些监听函数,可以使用stopImmediatePropagation
方法。
p.addEventListener('click', function(event) {
event.stopImmediatePropagation();
});
p.addEventListener('click', function(event) {
// 不会被触发
});
四、Event对象
事件发生以后,会生成一个事件对象,作为参数传给监听函数。浏览器原生提供一个Event
对象,所有的事件都是这个对象的实例,或者说继承了Event.prototype
对象。
Event
对象本身就是一个构造函数,可以用来生成新的实例。
event = new Event(typeArg, eventInit);
4.1、event.bubbles,event.eventPhase
以下属性与事件的阶段有关。
(1)、bubbles
bubbles
属性返回一个布尔值,表示当前事件是否会冒泡。该属性为只读属性,只能在新建事件时改变。除非显示声明,Event
构造函数生成的事件,默认是不冒泡的。
function goInput(e) {
if (!e.bubbles) {
passItOn(e);
} else {
doOutput(e);
}
}
上面代码根据事件是否冒泡,调用不同的函数。
(2)、eventPhase
eventPhase
属性返回一个整数值,表示事件目前所处的节点。
var phase = event.eventPhase;
0,事件目前没有发生。
1,事件目前处于捕获阶段,即处于从祖先节点向目标节点的传播过程中。该过程是从window
对象到document
节点,再到HTMLHtmlElement
节点,直到目标节点的父节点为止。
2,事件到达目标节点,即target
属性指向的那个节点。
3,事件处于冒泡阶段,即处于从目标节点向祖先节点的反向传播过程中。该过程是从父节点一直到window
对象。只有bubbles
属性为true
时,这个阶段才可能发生。
4.2、event.cancelable,event.defaultPrevented
以下属性与事件的默认行为有关。
(1)、cancelable
cancelable
属性返回一个布尔值,表示事件是否可以取消。该属性为只读属性,只能在新建事件时改变。除非显示声明,Event
构造函数生成的事件,默认是不可以取消的。
var bool = event.cancelable;
如果要取消某个事件,需要在这个事件上面调用preventDefault
方法,这会阻止浏览器对某种事件部署的默认行为。
(2)、defaultPrevented
defaultPrevented
属性返回一个布尔值,表示该事件是否调用过defaultPrevented
方法。
if (e.defaultPrevented) {
// ...
}
4.3、event.currentTarget,event.target
以下属性与事件的目标节点有关。
(1)、currentTarget
currentTarget
属性返回事件当前所在的节点,即正在执行的监听函数所绑定的那个节点。作为比较,target
属性返回事件发生的节点。
如果监听函数在捕获阶段和冒泡阶段触发,那么这两个属性返回值是不一样的。
function hide(e){
console.log(this === e.currentTarget); // true
e.currentTarget.style.visibility = "hidden";
}
para.addEventListener('click', hide, false);
上面代码中,点击para
节点,该节点会不可见。另外,在监听函数中,currentTarget
属性实际上等同于this
对象。
(2)、target
target
属性返回触发事件的那个节点,即事件最初发生的节点。如果监听函数不在该节点触发,那么它与currentTarget
属性返回的值是不一样的。
function hide(e){
console.log(this === e.target); // 有可能不是true
e.target.style.visibility = "hidden";
}
// HTML代码为
// <p id="para">Hello <em>World</em></p>
para.addEventListener('click', hide, false);
4.4、event.type,event.detail,event.timeStamp,event.isTrusted
以下属性与事件对象的其他信息相关。
(1)、type
type
属性返回一个字符串,表示事件类型,大小写敏感。
var string = event.type;
(2)、detail
detail
属性返回一个数值,表示事件的某种信息。具体含义与事件类型有关,对于鼠标事件,表示鼠标按键在某个位置按下的次数,比如对于dbclick
事件,detail
属性的值总是2。
(3)、timeStamp
timeStamp
属性返回一个毫秒时间戳,表示事件发生的时间。
var number = event.timeStamp;
(4)、isTrusted
isTrusted
属性返回一个布尔值,表示该事件是否为真实用户触发。
var bool = event.isTrusted;
用户触发的事件返回true
,脚本触发的事件返回false
。
4.5、event.preventDefault()
preventDefault
方法取消浏览器对当前事件的默认行为,比如点击链接后,浏览器跳转到指定页面,或者按一下空格键,页面向下滚动一段距离。该方法生效的前提是,事件的cancelable
属性为true
,如果为false
,则调用该方法没有任何效果。
该方法不会阻止事件的进一步传播(stopPropagation
方法可用于这个目的)。只要在事件的传播过程中(捕获阶段、目标阶段、冒泡阶段皆可),使用了preventDefault
方法,该事件的默认方法就不会执行。
// HTML代码为
// <input type="checkbox" id="my-checkbox" />
var cb = document.getElementById('my-checkbox');
cb.addEventListener(
'click',
function (e){ e.preventDefault(); },
false
);
上面代码为点击单选框的事件,设置监听函数,取消默认行为。由于浏览器的默认行为是选中单选框,所以这段代码会导致无法选中单选框。
如果监听函数最后返回布尔值false(即return false),浏览器也不会触发默认行为,与preventDefault
方法有等同效果。
4.6、event.stopPropagation()
stopPropagation
方法阻止事件在DOM中继续传播,防止再触发定义在别的节点上的监听函数,但是不包括在当前节点上新定义的事件监听函数。
function stopEvent(e) {
e.stopPropagation();
}
el.addEventListener('click', stopEvent, false);
将上面函数指定为监听函数,会阻止事件进一步冒泡到el节点的父节点。
4.7、event.stopImmediatePropagation()
stopImmediatePropagation
方法阻止同一个事件的其他监听函数被调用。
如果同一个节点对于同一个事件指定了多个监听函数,这些函数会根据添加的顺序依次调用。只要其中一个监听函数调用了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
调用了stopImmediatePropagation
方法,所以l2
不会被调用。