Page Visibility API 教程

作者: 阮一峰

日期: 2018年10月25日

一、简介

有时候,开发者需要知道,用户正在离开页面。常用的方法是监听下面三个事件。

  • pagehide
  • beforeunload
  • unload

但是,这些事件在手机上可能不会触发,页面就直接关闭了。因为手机系统可以将一个进程直接转入后台,然后杀死。

  • 用户点击了一条系统通知,切换到另一个 App。
  • 用户进入任务切换窗口,切换到另一个 App。
  • 用户点击了 Home 按钮,切换回主屏幕。
  • 操作系统自动切换到另一个 App(比如,收到一个电话)。

上面这些情况,都会导致手机将浏览器进程切换到后台,然后为了节省资源,可能就会杀死浏览器进程。

以前,页面被系统切换,以及系统清除浏览器进程,是无法监听到的。开发者想要指定,任何一种页面卸载情况下都会执行的代码,也是无法做到的。为了解决这个问题,就诞生了 Page Visibility API。不管手机或桌面电脑,所有情况下,这个 API 都会监听到页面的可见性发生变化。

这个新的 API 的意义在于,通过监听网页的可见性,可以预判网页的卸载,还可以用来节省资源,减缓电能的消耗。比如,一旦用户不看网页,下面这些网页行为都是可以暂停的。

  • 对服务器的轮询
  • 网页动画
  • 正在播放的音频或视频

二、document.visibilityState

这个 API 主要在document对象上,新增了一个document.visibilityState属性。该属性返回一个字符串,表示页面当前的可见性状态,共有三个可能的值。

  • hidden:页面彻底不可见。
  • visible:页面至少一部分可见。
  • prerender:页面即将或正在渲染,处于不可见状态。

其中,hidden状态和visible状态是所有浏览器都必须支持的。prerender状态只在支持"预渲染"的浏览器上才会出现,比如 Chrome 浏览器就有预渲染功能,可以在用户不可见的状态下,预先把页面渲染出来,等到用户要浏览的时候,直接展示渲染好的网页。

只要页面可见,哪怕只露出一个角,document.visibilityState属性就返回visible。只有以下四种情况,才会返回hidden

  • 浏览器最小化。
  • 浏览器没有最小化,但是当前页面切换成了背景页。
  • 浏览器将要卸载(unload)页面。
  • 操作系统触发锁屏屏幕。

可以看到,上面四种场景涵盖了页面可能被卸载的所有情况。也就是说,页面卸载之前,document.visibilityState属性一定会变成hidden。事实上,这也是设计这个 API 的主要目的。

另外,早期版本的 API,这个属性还有第四个值unloaded,表示页面即将卸载,现在已经被废弃了。

注意,document.visibilityState属性只针对顶层窗口,内嵌的<iframe>页面的document.visibilityState属性由顶层窗口决定。使用 CSS 属性隐藏<iframe>页面(比如display: none;),并不会影响内嵌页面的可见性。

三、document.hidden

由于历史原因,这个 API 还定义了document.hidden属性。该属性只读,返回一个布尔值,表示当前页面是否可见。

document.visibilityState属性返回visible时,document.hidden属性返回false;其他情况下,都返回true

该属性只是出于历史原因而保留的,只要有可能,都应该使用document.visibilityState属性,而不是使用这个属性。

四、visibilitychange 事件

只要document.visibilityState属性发生变化,就会触发visibilitychange事件。因此,可以通过监听这个事件(通过document.addEventListener()方法或document.onvisibilitychange属性),跟踪页面可见性的变化。


document.addEventListener('visibilitychange', function () {
  // 用户离开了当前页面
  if (document.visibilityState === 'hidden') {
    document.title = '页面不可见';
  }

  // 用户打开或回到页面
  if (document.visibilityState === 'visible') {
    document.title = '页面可见';
  }
});

上面代码是 Page Visibility API 的最基本用法,可以监听可见性变化。

下面是另一个例子,一旦页面不可见,就暂停视频播放。


var vidElem = document.getElementById('video-demo');
document.addEventListener('visibilitychange', startStopVideo);

function startStopVideo() {
  if (document.visibilityState === 'hidden') {
    vidElem.pause();
  } else if (document.visibilityState === 'visible') {
    vidElem.play();
  }
}

五、页面卸载

下面专门讨论一下,如何正确监听页面卸载。

页面卸载可以分成三种情况。

  • 页面可见时,用户关闭 Tab 页或浏览器窗口。
  • 页面可见时,用户在当前窗口前往另一个页面。
  • 页面不可见时,用户或系统关闭浏览器窗口。

这三种情况,都会触发visibilitychange事件。前两种情况,该事件在用户离开页面时触发;最后一种情况,该事件在页面从可见状态变为不可见状态时触发。

由此可见,visibilitychange事件比pagehidebeforeunloadunload事件更可靠,所有情况下都会触发(从visible变为hidden)。因此,可以只监听这个事件,运行页面卸载时需要运行的代码,不用监听后面那三个事件。

甚至可以这样说,unload事件在任何情况下都不必监听,beforeunload事件只有一种适用场景,就是用户修改了表单,没有提交就离开当前页面。另一方面,指定了这两个事件的监听函数,浏览器就不会缓存当前页面。

六、参考链接

(完)

留言(17条)

正要用到相关的功能,教程就来了,多谢阮老师

visibilitychange 无法区分页面是真正关闭了还是只是切换tab变成不可见,这个怎么处理呢?有些逻辑需要区分这两种状态

感谢分享

引用tomwang1013的发言:

visibilitychange 无法区分页面是真正关闭了还是只是切换tab变成不可见,这个怎么处理呢?有些逻辑需要区分这两种状态

请看下一篇教程 Page lifecycle API,下周发布。

如果页面关闭触发了visibilitychange,需要执行一个时间比较长的操作,这时页面是等待执行完关闭,还是马上关闭?

页面不可见时,用户或系统关闭浏览器窗口。
这种情况下,页面不可见时的document.visibilityState已经是hidden,用户关闭浏览器窗口不会触发visibilitychange吧?

感谢分享

引用tsdd的发言:

如果页面关闭触发了visibilitychange,需要执行一个时间比较长的操作,这时页面是等待执行完关闭,还是马上关闭?

我试了一下, 发一个网络请求是可以的,太长估计不会预期的结果

微信浏览器左上角有一个关闭按钮, 这个事件可以做到像京东那样子, 在关闭的时候做一个阻断, 然后弹窗提示信息么?
而且现在微信做页面返回的时候, 可以直接左滑动返回到微信, 这样子的操作是否也可以实现一个阻断, 显示弹窗提示.

引用阮一峰的发言:

请看下一篇教程 Page lifecycle API,下周发布。

跳票

多谢阮老师

您好,阮老师,我在chrome 72上试,为什么浏览器窗口的最大化和最小化不会触发visibilitychange事件呢

引用多拉斯基的发言:

页面不可见时,用户或系统关闭浏览器窗口。
这种情况下,页面不可见时的document.visibilityState已经是hidden,用户关闭浏览器窗口不会触发visibilitychange吧?

你好,我对这种情况,也没有理解,还麻烦解释下,非常感谢

老师你好,我在vue里面进行跳转到新页面后就无法触发visibilitychange事件了
有没有什么方式解决这个问题呢,需求到时候是大屏,必须要在新页面做可视化展示


main.js和新页面(同时注册和分开注册都没法触发事件,不跳转到新页面就可以触发)

我在app的webview中,A页面加上这个visibilitychange的监听,然后我打了一个新的webview到了页面B,当我在B页面待上超过5分钟后,关闭B的webview返回A页面,这个时候visibilitychange没有触发,然而5分钟内返回都是可以的,请教下这是什么原因?

浏览器没有最小化,但是当前页面切换成了背景页。这句的意思是不是切换窗口比如从idea切到浏览器时也能监听到hidden状态?我需要在这种场景下拿到这个状态,但是并没有取到,请赐教

我们发现Chrome Webview 能够正确触发visibilitychange监听的极少,这是因为什么,我们做了webkit兼容

我要发表看法

«-必填

«-必填,不公开

«-我信任你,不会填写广告链接