Page Visibility(页面可见性) API介绍、微拓展 « 张鑫旭-鑫空间-鑫生活

by zhangxinxu from https://www.zhangxinxu.com
本文地址：https://www.zhangxinxu.com/wordpress/?p=2790

一、网页君的悲情谁来懂

唉，突然想到了一首悲情诗：

泪湿罗巾梦不成，夜深前殿按歌声。
红颜未老恩先断，斜倚薰笼坐到明。

学生时代学过的一首诗，已还给老师不知所云的诸位可参见下面释义：

诗的主人公是一位不幸的宫女。她一心盼望君王的临幸而终未盼得，时已深夜，只好上床，已是一层怨怅。宠幸不可得，退而求之好梦；辗转反侧，竟连梦也难成，见出两层怨怅。梦既不成，索性揽衣推枕，挣扎坐起。正当她愁苦难忍，泪湿罗巾之时，前殿又传来阵阵笙歌，原来君王正在那边寻欢作乐，这就有了三层怨怅。倘使人老珠黄，犹可解说；偏偏她盛鬓堆鸦，红颜未老，生出四层怨怅。要是君王一直没有发现她，那也罢了；事实是她曾受过君王的恩宠，而现在这种恩宠却无端断绝，见出五层怨怅。夜已深沉，濒于绝望，但一转念，犹翼君王在听歌赏舞之后，会记起她来。于是，斜倚熏笼，浓熏翠袖，以待召幸。不料，一直坐到天明，幻想终归破灭，见出六层怨怅。

为何在这阳光和煦，安静惬意的温暖冬日会有如此感伤呢？

唉，只因自己想到了可怜的网页君，其命运就跟深宫的宫女一般，令人唏嘘。

某君王啪啪啪啪打开了十几二十个选项卡（就像他当初啪啪啪啪宠幸后宫那十几二十个宫女一样）；但是，鞭长莫及，其一次只能浏览一个选项卡（就像他每晚只能宠幸一个宫女一样）；可是，其他的选项卡并不知道君王何时会再过来（就像其他的宫女并不清楚君王今晚会不会来宠幸一样）；于是，其他选项卡依然在不停地运行，守候（就像宫女依然留有希望，等待召幸）；然而，最后，君王直接啪一下浏览器关掉了，N多不停忠心守候的选项卡被无情漠视了（就像宫女们苦守整夜，结果却是一场空，只能以泪洗面）！

此番悲情怎能不让人同情怜悯，是不是啊，诸位！

哼，请不要摆出这样或这样的表情。
那个谁谁，说的就是你！你应该这样子或这样子。

您应该像扎西拉姆·多多一样，为悲情网页君赋诗一首——《见与不见》：

你见，或者不见我
我就在那里
不悲不喜
你念，或者不念我
情就在那里
不来不去……

时代在发展，制度也会进步。比方说明代吧，每日天渐黑时，嫔妃所住的宫门前，都挂起两只红纱笼灯。皇帝临幸某宫，则该宫门上的灯卸下来，表示皇帝已选定寝宿的地方。于是，负责巡街的宦官，传令其他各宫均卸灯寝息。失意的嫔妃们只得灭掉希求宠幸的红纱笼，明晚再重新挂上。

这就避免了嫔妃们彻夜苦等，哀怨泪雨的情形。

那网页君这边呢？

好在，就最近几年，网页君也有了相应的东西，可以告知网页你是“宠幸”了呢还是不被“宠幸”，这样，可以让网页君在不被“宠幸”时候安心睡觉，或者养个小白。这个东西就是Page Visibility API，翻译成简体中文就是“页面可见性应用程序接口”。

于是乎，网页君的悲情程度可以lower一点了，从这点来说，Page Visibility API是个很人性化的设计，感动！

//zxx: 为接地气，下”Page Visibility API”均称呼为“页面可见性API”。

二、页面可见性API究竟为何物？

CSS中有个有用且有趣且个人比较喜欢的属性 – visibility. 其有两个常用属性值：hidden与visible. 分别表示不可见与可见。OK，本文所说的API中也有Visibility这个单词，那他们表意一致？

回答是：YES! //众人：妹啊，你以为是中国达人秀啊！

页面可见性API就是表示网页可见还是不可见的，巧的是，hidden与visible就是该API的两个状态值。

举个通俗的例子：
如果你在xxxxx.com上浏览提神的图片，则当前你所看的这个网页的visibility就是visible.

此时，如果你老妈子突然进来给你送香蕉，出现下图所示场景：
总是在看桌面

则，此时之前提神的网页的visibility就是hidden – 最小化。

或者老妈子进来的时候，切换到人民网，提神网页的visibility也是hidden – 切换选项卡。

老妈子送的香蕉~~啦啦啦啦啦~~

这就是页面可见性API的直观认识，至于其身上哪里有麻子，下面会指出.

三、页面可见性API属性和事件

目前页面可见性API有两个属性，一个事件，如下：

document.hidden: Boolean值，表示当前页面可见还是不可见
document.visibilityState: 返回当前页面的可见状态。
1. “hidden“
2. “visible“
3. “prerender” 这个表示纳尼呢~~恩，我也不确定，字面意思是“预渲染”。莫非指的是啪啪啪一下子开了很多个选项卡，之前选项卡依然在加载渲染的状态？或者说是浏览器新打开时记住的上一次关闭选项卡的状态？求达人指明！
4. “preview” 预览。根据部分2011年底相关国外部分文章的说法，这种状态出现在，如window7系统下，鼠标放在底部（一般是）任务栏的图标上（预览）的时候。见下截图：
  
  但是根据自己的实际测试，似乎并没有这种状态的改变——包括IE10浏览器。可能是时代改变，一切都遵循规范了吧。因此，我们重点关注前面三个状态值就可以了。
visibilitychange: 当可见状态改变时候触发的事件。

四、浏览器支持与私有前缀

我写了个如下的页面可见性API支持性的测试代码：

var isPageVisibilitySupport = (function() {
    var support = false;
    if (typeof window.screenX === "number") {
        ["webkit", "moz", "ms", "o", ""].forEach(function(prefix) {
            if (support == false && document[prefix + (prefix? "H": "h") + "idden"] + "" !== "undefined") {
                support = true;
            }
        });        
    }
    return support;
})();

测试发现，如下浏览器都是支持的：

Chrome 21
FireFox 16.0.2
Opera 12.11
IE10

不支持的浏览器：

IE9
Safari 5.1

因此，typeof document.msHidden != "undefined"可以用来区分IE9浏览器还是IE10浏览器。

正如上面的code所展示的，页面可见性API的所有属性以及事件，目前是需要使用私有前缀的（如果没有这些前缀，浏览器就不认识这些属性或方法了）。
一旦有了前缀，实际应用的时候代码就有些啰哩吧嗦了（可见参见文章底部参考文章中展示的代码）！

因为要一个前缀一个前缀判断——oh, my! 我这个懒人最不喜欢这等麻烦事了，于是，捞起袖子，啪啪啪啪整个一个兼容性的Page Visibility API相关对象，正好包含API中的两个属性以及一个事件。完整代码如下（节省篇幅，滚动显示。如果您发现没有滚动效果啊？可能是由于在其他网站或是RSS中阅读本文，本文原地址：https://www.zhangxinxu.com/wordpress/?p=2790，本文作者：张鑫旭，来自张鑫旭-鑫空间-鑫生活，访问原出处阅读体验更佳。
）：

var pageVisibility = (function() {
    var prefixSupport, keyWithPrefix = function(prefix, key) {
        if (prefix !== "") {
            // 首字母大写
            return prefix + key.slice(0,1).toUpperCase() + key.slice(1);    
        }
        return key;
    };
    var isPageVisibilitySupport = (function() {
        var support = false;
        if (typeof window.screenX === "number") {
            ["webkit", "moz", "ms", "o", ""].forEach(function(prefix) {
                if (support == false && document[keyWithPrefix(prefix, "hidden")] != undefined) {
                    prefixSupport = prefix;
                    support = true;   
                }
            });        
        }
        return support;
    })();
    
    var isHidden = function() {
        if (isPageVisibilitySupport) {
            return document[keyWithPrefix(prefixSupport, "hidden")];
        }
        return undefined;
    };
    
    var visibilityState = function() {
        if (isPageVisibilitySupport) {
            return document[keyWithPrefix(prefixSupport, "visibilityState")];
        }
        return undefined;
    };
    
    return {
        hidden: isHidden(),
        visibilityState: visibilityState(),
        visibilitychange: function(fn, usecapture) {
            usecapture = undefined || false;
            if (isPageVisibilitySupport && typeof fn === "function") {
                return document.addEventListener(prefixSupport + "visibilitychange", function(evt) {
                    this.hidden = isHidden();
                    this.visibilityState = visibilityState();
                    fn.call(this, evt);
                }.bind(this), usecapture);
            }
            return undefined;
        }
    };    
})(undefined);

或者直接调用：

<script src="https://www.zhangxinxu.com/study/201211/pageVisibility.js"></script>

其中具体细节无需关心，实际上上面这么多代码本质上就是下面这点：

var pageVisibility = {
    hidden: Boolean
    visibilityState: String
    visibilitychange: Function
};

与_原生属性事件_对应关系如下：

pageVisibility.hidden === document.hidden（兼容处理）
pageVisibility.visibilityState=== document.visibilityState（兼容处理）
pageVisibility.visibilitychange(function() { /* this指的就是pageVisibility */ }); === document.addEventListener("visibilitychange", function() {});（兼容处理）

于是，要判断一个浏览器是否支持页面可见性API如下代码就可以了（无需什么webkit或moz或ms等前缀一个个判断了）：

var isSupport = typeof pageVisibility.hidden !== "undefined"

测试demo
您可以狠狠地点击这里：兼容性的网页可见性API属性与事件demo

网页可见性 API基本属性与事件实例页面截图张鑫旭-鑫空间-鑫生活

对于不支持的浏览器，如IE9浏览器，显示的则是”undefined“：
不支持网页可见性API浏览器显示undefined 张鑫旭-鑫空间-鑫生活

OK，万屎具备，只欠草纸了！下面，看看，页面可见性API都有些可以有的实际应用。

五、页面可见性API实际应用

先来看看老外给的一个例子，我觉得很有实际应用价值的。

首先是链接地址：http://www.samdutton.com/pageVisibility/ //zxx: 希望不要明年这个时候被墙掉

进去后，会有一个HTML5 video显示的Google Chrome浏览器广告的30秒funny视频，如下图所示：
视频截图

直接浏览你是看不出什么玄乎的，请切换一个选项卡，让该页面置于后面，结果，您会发现这个选项卡的标题栏变成了这样：

看出来没？视频播放被中断了——当page不可见的时候，视频会自动暂停！

此时，您再进入该选项卡，视频又从刚才的地方继续播放了，如下截图：
页面可见视频继续播放张鑫旭-鑫空间-鑫生活

个人愚见，国内的一些视频站点是不是可以应用下这个API呢！这样当妈妈进来送香蕉的时候，直接win+D显示桌面就可以了，声音啊什么的会自动关掉，振奋视频自动暂停，多赞的一个功能啊！以前的暂停视频+最小化浏览器直接变成了一步→最小化，节约了大量的宝贵时间，极大了提升了用户体验，恩！不错！！

上面的例子毕竟长在外人田啊，一旦建起了围墙就看不到了，因此，自己折腾了一个简单的10秒钟低质量的猫猫版本。//zxx: 上面例子视频3M+，我估算了下，1000次访问的话，我勒个去，差不多3个G的流量去了，我现在每月流量都岌岌可危，因此，大家将就下下这个百来K的视频（Chrome浏览器以及IE10下可访问，或者谁给我尺寸小一点的ogv格式任意视频，让FireFox也能OK）~~

您可以狠狠地点击这里：10秒钟妈妈来自动暂停视频demo

操作同上，进入页面播放，离开页面暂停。
Chrome浏览器下效果截图张鑫旭-鑫空间-鑫生活

登录同步
这是我想的一个觉得蛮实用的应用。有如下场景：
1. 去淘宝买东西，未登录状态下，进入首页。
2. 然后新窗口打开任意页面，登录并成功返回。
淘宝网成功登录张鑫旭-鑫空间-鑫生活
3. 再次访问刚才打开的首页，发现页面还是未登录状态（见下图），实际上用户已经登录了。
之前的首页仍然是未登录状态