什么是Service Worker
Service Worker
本质上充当Web应用程序与浏览器之间的代理服务器,也可以在网络可用时作为浏览器和网络间的代理。它们旨在(除其他之外)使得能够创建有效的离线体验,拦截网络请求并基于网络是否可用以及更新的资源是否驻留在服务器上来采取适当的动作。他们还允许访问推送通知和后台同步API
。
Service Worker
的本质是一个Web Worker
,它独立于JavaScript
主线程,因此它不能直接访问DOM
,也不能直接访问window
对象,但是,Service Worker
可以访问navigator
对象,也可以通过消息传递的方式(postMessage)与JavaScript
主线程进行通信。Service Worker
是一个网络代理,它可以控制Web
页面的所有网络请求。Service Worker
具有自身的生命周期,使用好Service Worker
的关键是灵活控制其生命周期。
Service Worker
的作用
- 用于浏览器缓存
- 实现离线
Web APP
- 消息推送
Service Worker
兼容性
Service Worker
是现代浏览器的一个高级特性,它依赖于fetch API
、Cache Storage
、Promise
等,其中,Cache
提供了Request / Response
对象对的存储机制,Cache Storage
存储多个Cache
。
示例
在了解Service Worker
的原理之前,先来看一段Service Worker
的示例:
self.importScripts('./serviceworker-cache-polyfill.js');
var urlsToCache = [
'/',
'/index.js',
'/style.css',
'/favicon.ico',
];
varCACHE_NAME='counterxing';
self.addEventListener('install', function(event) {
self.skipWaiting();
event.waitUntil(
caches.open(CACHE_NAME)
.then(function(cache) {
returncache.addAll(urlsToCache);
})
);
});
self.addEventListener('fetch', function(event) {
event.respondWith(
caches.match(event.request)
.then(function(response) {
if (response) {
return response;
}
returnfetch(event.request);
})
);
});
self.addEventListener('activate', function(event) {
var cacheWhitelist = ['counterxing'];
event.waitUntil(
caches.keys().then(function(cacheNames) {
returnPromise.all(
cacheNames.map(function(cacheName) {
if (cacheWhitelist.indexOf(cacheName) ===-1) {
returncaches.delete(cacheName);
}
})
);
})
);
});
下面开始逐段逐段地分析,揭开Service Worker
的神秘面纱:
polyfill
首先看第一行:self.importScripts('./serviceworker-cache-polyfill.js');
,这里引入了Cache API的一个polyfill,这个polyfill
支持使得在较低版本的浏览器下也可以使用Cache Storage API
。想要实现Service Worker
的功能,一般都需要搭配Cache API
代理网络请求到缓存中。
在Service Worker
线程中,使用importScripts
引入polyfill
脚本,目的是对低版本浏览器的兼容。
Cache Resources List
And Cache Name
之后,使用一个urlsToCache
列表来声明需要缓存的静态资源,再使用一个变量CACHE_NAME
来确定当前缓存的Cache Storage Name
,这里可以理解成Cache Storage
是一个DB
,而CACHE_NAME
则是DB
名:
var urlsToCache = [
'/',
'/index.js',
'/style.css',
'/favicon.ico',
];
varCACHE_NAME='counterxing';
Lifecycle
Service Worker
独立于浏览器JavaScript
主线程,有它自己独立的生命周期。
如果需要在网站上安装Service Worker
,则需要在JavaScript
主线程中使用以下代码引入Service Worker
。
if ('serviceWorker'innavigator) {
navigator.serviceWorker.register('/sw.js').then(function(registration) {
console.log('成功安装', registration.scope);
}).catch(function(err) {
console.log(err);
});
}
此处,一定要注意sw.js
文件的路径,在我的示例中,处于当前域根目录下,这意味着,Service Worker
和网站是同源的,可以为当前网站的所有请求做代理,如果Service Worker
被注册到/imaging/sw.js
下,那只能代理/imaging
下的网络请求。
可以使用Chrome
控制台,查看当前页面的Service Worker
情况:
安装完成后,Service Worker
会经历以下生命周期:
- 下载(
download
) - 安装(
install
) - 激活(
activate
)
用户首次访问
Service Worker
控制的网站或页面时,Service Worker
会立刻被下载。之后至少每24
小时它会被下载一次。它可能被更频繁地下载,不过每24
小时一定会被下载一次,以避免不良脚本长时间生效。在下载完成后,开始安装
Service Worker
,在安装阶段,通常需要缓存一些我们预先声明的静态资源,在我们的示例中,通过urlsToCache
预先声明。在安装完成后,会开始进行激活,浏览器会尝试下载
Service Worker
脚本文件,下载成功后,会与前一次已缓存的Service Worker
脚本文件做对比,如果与前一次的Service Worker
脚本文件不同,证明Service Worker
已经更新,会触发activate
事件。完成激活。
如图所示,为Service Worker
大致的生命周期:
install
在安装完成后,尝试缓存一些静态资源:
self.addEventListener('install', function(event) {
self.skipWaiting();
event.waitUntil(
caches.open(CACHE_NAME)
.then(function(cache) {
returncache.addAll(urlsToCache);
})
);
});
首先,self.skipWaiting()
执行,告知浏览器直接跳过等待阶段,淘汰过期的sw.js
的Service Worker
脚本,直接开始尝试激活新的Service Worker
。
然后使用caches.open
打开一个Cache
,打开后,通过cache.addAll
尝试缓存我们预先声明的静态文件。
监听fetch
,代理网络请求
页面的所有网络请求,都会通过Service Worker
的fetch
事件触发,Service Worker
通过caches.match
尝试从Cache
中查找缓存,缓存如果命中,则直接返回缓存中的response
,否则,创建一个真实的网络请求。
self.addEventListener('fetch', function(event) {
event.respondWith(
caches.match(event.request)
.then(function(response) {
if (response) {
return response;
}
returnfetch(event.request);
})
);
});
如果我们需要在请求过程中,再向Cache Storage
中添加新的缓存,可以通过cache.put
方法添加,看以下例子:
self.addEventListener('fetch', function(event) {
event.respondWith(
caches.match(event.request)
.then(function(response) {
// 缓存命中if (response) {
return response;
}
// 注意,这里必须使用clone方法克隆这个请求// 原因是response是一个Stream,为了让浏览器跟缓存都使用这个response// 必须克隆这个response,一份到浏览器,一份到缓存中缓存。// 只能被消费一次,想要再次消费,必须clone一次var fetchRequest =event.request.clone();
returnfetch(fetchRequest).then(
function(response) {
// 必须是有效请求,必须是同源响应,第三方的请求,因为不可控,最好不要缓存if (!response ||response.status!==200||response.type!=='basic') {
return response;
}
// 消费过一次,又需要再克隆一次var responseToCache =response.clone();
caches.open(CACHE_NAME)
.then(function(cache) {
cache.put(event.request, responseToCache);
});
return response;
}
);
})
);
});
在项目中,一定要注意控制缓存,接口请求一般是不推荐缓存的。所以在我自己的项目中,并没有在这里做动态的缓存方案。
activate
Service Worker
总有需要更新的一天,随着版本迭代,某一天,我们需要把新版本的功能发布上线,此时需要淘汰掉旧的缓存,旧的Service Worker
和Cache Storage
如何淘汰呢?
self.addEventListener('activate', function(event) {
var cacheWhitelist = ['counterxing'];
event.waitUntil(
caches.keys().then(function(cacheNames) {
returnPromise.all(
cacheNames.map(function(cacheName) {
if (cacheWhitelist.indexOf(cacheName) ===-1) {
returncaches.delete(cacheName);
}
})
);
})
);
});
- 首先有一个白名单,白名单中的
Cache
是不被淘汰的。 - 之后通过
caches.keys()
拿到所有的Cache Storage
,把不在白名单中的Cache
淘汰。 - 淘汰使用
caches.delete()
方法。它接收cacheName
作为参数,删除该cacheName
所有缓存。
sw-precache-webpack-plugin
sw-precache-webpack-plugin是一个webpack plugin
,可以通过配置的方式在webpack
打包时生成我们想要的sw.js
的Service Worker
脚本。
一个最简单的配置如下:
var path =require('path');
var SWPrecacheWebpackPlugin =require('sw-precache-webpack-plugin');
constPUBLIC_PATH='https://www.my-project-name.com/'; // webpack needs the trailing slash for output.publicPathmodule.exports= {
entry: {
main:path.resolve(__dirname, 'src/index'),
},
output: {
path:path.resolve(__dirname, 'src/bundles/'),
filename:'[name]-[hash].js',
publicPath:PUBLIC_PATH,
},
plugins: [
newSWPrecacheWebpackPlugin(
{
cacheId:'my-project-name',
dontCacheBustUrlsMatching:/\.\w{8}\./,
filename:'service-worker.js',
minify:true,
navigateFallback:PUBLIC_PATH+'index.html',
staticFileGlobsIgnorePatterns: [/\.map$/,/asset-manifest\.json$/],
}
),
],
}
在执行webpack
打包后,会生成一个名为service-worker.js
文件,用于缓存webpack
打包后的静态文件。
一个最简单的示例。
Service Worker Cache
VS Http Cache
对比起Http Header
缓存,Service Worker
配合Cache Storage
也有自己的优势:
- 缓存与更新并存:每次更新版本,借助
Service Worker
可以立马使用缓存返回,但与此同时可以发起请求,校验是否有新版本更新。 - 无侵入式:
hash
值实在是太难看了。 - 不易被冲掉:
Http
缓存容易被冲掉,也容易过期,而Cache Storage
则不容易被冲掉。也没有过期时间的说法。 - 离线:借助
Service Worker
可以实现离线访问应用。
但是缺点是,由于Service Worker
依赖于fetch API
、依赖于Promise
、Cache Storage
等,兼容性不太好。
后话
本文只是简单总结了Service Worker
的基本使用和使用Service Worker
做客户端缓存的简单方式,然而,Service Worker
的作用远不止于此,例如:借助Service Worker
做离线应用、用于做网络应用的推送(可参考push-notifications)等。
甚至可以借助Service Worker
,对接口进行缓存,在我所在的项目中,其实并不会做的这么复杂。不过做接口缓存的好处是支持离线访问,对离线状态下也能正常访问我们的Web
应用。
Cache Storage
和Service Worker
总是分不开的。Service Worker
的最佳用法其实就是配合Cache Storage
做离线缓存。借助于Service Worker
,可以轻松实现对网络请求的控制,对于不同的网络请求,采取不同的策略。例如对于Cache
的策略,其实也是存在多种情况。例如可以优先使用网络请求,在网络请求失败时再使用缓存、亦可以同时使用缓存和网络请求,一方面检查请求,一方面有检查缓存,然后看两个谁快,就用谁。
Progressive Web Apps(PWA)
Progressive Web App
, 简称 PWA,是提升Web App
的体验的一种新方法,能给用户原生应用的体验。
PWA
能做到原生应用的体验不是靠特指某一项技术,而是经过应用一些新技术进行改进,在安全、性能和体验三个方面都有很大提升,PWA
本质上是Web App
,借助一些新技术也具备了Native App
的一些特性,兼具Web App
和Native App
的优点。
PWA
的主要特点包括下面三点:
可靠 - 即使在不稳定的网络环境下,也能瞬间加载并展现
体验 - 快速响应,并且有平滑的动画响应用户的操作
粘性 - 像设备上的原生应用,具有沉浸式的用户体验,用户可以添加到桌面PWA
本身强调渐进式,并不要求一次性达到安全、性能和体验上的所有要求,开发者可以通过PWA Checklist查看现有的特征。
通过上面的PWA Checklist
,总结起来,PWA
大致有以下的优势:
- 体验:通过
Service Worker
配合Cache Storage API
,保证了PWA
首屏的加载效率,甚至配合本地存储可以支持离线应用; - 粘性:
PWA
是可以安装的,用户点击安装到桌面后,会在桌面创建一个 PWA 应用,并且不需要从应用商店下载,可以借助Web App Manifest
提供给用户和Native App
一样的沉浸式体验,可以通过给用户发送离线通知,让用户回流; - 渐进式:适用于大多数现代浏览器,随着浏览器版本的迭代,其功能是渐进增强的;
- 无版本问题:如
Web
应用的优势,更新版本只需要更新应用程序对应的静态文件即可,Service Worker
会帮助我们进行更新; - 跨平台:
Windows
、Mac OSX
、Android
、IOS
,一套代码,多处使用; - 消息推送:即使用户已经关闭应用程序,仍然可以对用户进行消息推送;
总的说来,只要Web
应用支持的功能,对于PWA
而言,基本都支持,此外,还提供了原生能力。
使用PWA manifest
添加桌面入口
注意这里说的manifest
不是指的manifest
缓存,这个manifest
是一个JSON
文件,开发者可以利用它控制在用户想要看到应用的区域(例如移动设备主屏幕)中如何向用户显示网络应用或网站,指示用户可以启动哪些功能,以及定义其在启动时的外观。
manifest
提供了将网站书签保存到设备主屏幕的功能。当网站以这种方式启动时:
- 它具有唯一的图标和名称,以便用户将其与其他网站区分开来。
- 它会在下载资源或从缓存恢复资源时向用户显示某些信息。
- 它会向浏览器提供默认显示特性,以避免网站资源可用时的过渡过于生硬。
下面是我的博客网站的manifest.json
文件,作为桌面入口配置文件的示例:
{
"name": "Counterxing",
"short_name": "Counterxing",
"description": "Why did you encounter me?",
"start_url": "/index.html",
"display": "standalone",
"orientation": "any",
"background_color": "#ACE",
"theme_color": "#ACE",
"icons": [{
"src": "/images/logo/logo072.png",
"sizes": "72x72",
"type": "image/png"
}, {
"src": "/images/logo/logo152.png",
"sizes": "152x152",
"type": "image/png"
}, {
"src": "/images/logo/logo192.png",
"sizes": "192x192",
"type": "image/png"
}, {
"src": "/images/logo/logo256.png",
"sizes": "256x256",
"type": "image/png"
}, {
"src": "/images/logo/logo512.png",
"sizes": "512x512",
"type": "image/png"
}]
}
上面的字段含义也不用多解释了,大致就是启动的icon
样式,应用名称、简写名称与描述等,其中必须确保有short_name
和name
。此外,最好设定好start_url
,表示启动的根页面路径,如果不添加,则是使用当前路径。
display
为standalone
,则会隐藏浏览器的UI
界面,如果设置display
为browser
,则启动时保存浏览器的UI
界面。
orientation
表示启动时的方向,横屏、竖屏等,具体参数值可参考文档。
background_color
和theme_color
表示应用程序的背景颜色和主题颜色。
在创建好manifest.json
后,将、使用link
标签添加到应用程序的所有页面上,<link rel="manifest" href="/manifest.json">
安装到桌面
桌面端(以Mac OSX
为例)
只有注册、激活了Service Worker
的网站才能够安装到桌面,在Chrome 70
版本之前,需要手动开启实验性功能,步骤如下:
- 进入
chrome://flags
- 找到
Desktop PWAs
,选择Enabled
此时,进入一个支持PWA
的网站(例如Google I/O),在Chrome
浏览器右上角,点击安装。即可安装到桌面。这里以我的博客为例:
可以到awesome-pwa查找目前支持
PWA
的网站列表
接着点击安装:
这样,一个PWA
应用就安装到你的机器上了,这里我的操作系统为Mac OSX
,应用程序可以通过Launchpad
打开,在Windows
也是同理的,会被安装到桌面上,可通过开始菜单找到应用程序。
打开应用程序,发现其与原始应用几乎没有任何差距:
Windows与上述方法类似,这里就不做过多阐述
移动端(以IOS
为例)
由于当初苹果推出PWA
时,并没有一个统一的manifest
的规范,最开始的设计是通过meta
和link
标签来设定应用的对应参数的,所以,在移动端上的PWA
应用,为了兼容Windows Phone
和iPhone
,需要在所有页面的HTML
的head
中添加以下的标签:
<metaname="msapplication-TileImage"content="./images/logo/logo152.png">
<metaname="msapplication-TileColor"content="#2F3BA2">
<metaname="apple-mobile-web-app-capable"content="yes">
<metaname="apple-mobile-web-app-status-bar-style"content="black">
<metaname="apple-mobile-web-app-title"content="Counterxing">
<linkrel="apple-touch-icon"href="./images/logo/logo152.png">
添加好后,就可以体验我们的PWA
了!
IOS
在11.3
版本之后也支持PWA
了,知道这一消息的我,卸载了手机上很多软件,立刻体验上了PWA
。
这里以豆瓣移动端为例使用Safiri
浏览器打开一个网站,点击下方分享图标,选择添加到主屏幕。
然后在新弹出的一个浏览器页面,选择添加:
就以上简短的步骤,移动端上的一个PWA
桌面应用就添加好了,赶紧体验吧!
小结
本文是笔者写的Service Worker
学习与实践系列文章的第二篇,主要讲述的是配合Service Worker
使用的PWA
的优势,如何配置manifest.json
文件来实现将PWA
安装到桌面,并通过Mac OSX
和IOS
如何安装PWA
到桌面的详细步骤,阐述了如何配置PWA
,使其方便地安装到桌面上。
下一篇文章中,主要讲述Service Worker
在PWA
实践中的重要能力:Web Push
。
Notification
说到底,PWA
的消息推送也是服务端推送的一种,常见的服务端推送方法,例如广泛使用的轮询、长轮询、Web Socket
等,说到底,都是客户端与服务端之间的通信,在Service Worker
中,客户端接收到通知,是基于Notification来进行推送的。
那么,我们来看一下,如何直接使用Notification
来发送一条推送呢?下面是一段示例代码:
// 在主线程中使用let notification =newNotification('您有新消息', {
body:'Hello Service Worker',
icon:'./images/logo/logo152.png',
});
notification.onclick=function() {
console.log('点击了');
};
在控制台敲下上述代码后,则会弹出以下通知:
然而,Notification
这个API
,只推荐在Service Worker
中使用,不推荐在主线程中使用,在Service Worker
中的使用方法为:
// 添加notificationclick事件监听器,在点击notification时触发self.addEventListener('notificationclick', function(event) {
// 关闭当前的弹窗event.notification.close();
// 在新窗口打开页面event.waitUntil(
clients.openWindow('https://google.com')
);
});
// 触发一条通知self.registration.showNotification('您有新消息', {
body:'Hello Service Worker',
icon:'./images/logo/logo152.png',
});
读者可以在MDN Web Docs关于Notification
在Service Worker
中的相关用法,在本文就不浪费大量篇幅来进行较为详细的阐述了。
申请推送的权限
如果浏览器直接给所有开发者开放向用户推送通知的权限,那么势必用户会受到大量垃圾信息的骚扰,因此这一权限是需要申请的,如果用户禁止了消息推送,开发者是没有权利向用户发起消息推送的。我们可以通过serviceWorkerRegistration.pushManager.getSubscription方法查看用户是否已经允许推送通知的权限。修改sw-register.js
中的代码:
if ('serviceWorker'innavigator) {
navigator.serviceWorker.register('/sw.js').then(function (swReg) {
swReg.pushManager.getSubscription()
.then(function(subscription) {
if (subscription) {
console.log(JSON.stringify(subscription));
} else {
console.log('没有订阅');
subscribeUser(swReg);
}
});
});
}
上面的代码调用了swReg.pushManager
的getSubscription
,可以知道用户是否已经允许进行消息推送,如果swReg.pushManager.getSubscription
的Promise
被reject
了,则表示用户还没有订阅我们的消息,调用subscribeUser
方法,向用户申请消息推送的权限:
functionsubscribeUser(swReg) {
constapplicationServerKey=urlB64ToUint8Array(applicationServerPublicKey);
swReg.pushManager.subscribe({
userVisibleOnly:true,
applicationServerKey: applicationServerKey
})
.then(function(subscription) {
console.log(JSON.stringify(subscription));
})
.catch(function(err) {
console.log('订阅失败: ', err);
});
}
上面的代码通过serviceWorkerRegistration.pushManager.subscribe向用户发起订阅的权限,这个方法返回一个Promise
,如果Promise
被resolve
,则表示用户允许应用程序推送消息,反之,如果被reject
,则表示用户拒绝了应用程序的消息推送。如下图所示:
serviceWorkerRegistration.pushManager.subscribe
方法通常需要传递两个参数:
userVisibleOnly
,这个参数通常被设置为true
,用来表示后续信息是否展示给用户。applicationServerKey
,这个参数是一个Uint8Array
,用于加密服务端的推送信息,防止中间人攻击,会话被攻击者篡改。这一参数是由服务端生成的公钥,通过urlB64ToUint8Array
转换的,这一函数通常是固定的,如下所示:functionurlB64ToUint8Array(base64String) {
constpadding='='.repeat((4-base64String.length%4) %4); constbase64= (base64String + padding) .replace(/\-/g, '+') .replace(/_/g, '/'); constrawData=window.atob(base64); constoutputArray=newUint8Array(rawData.length); for (let i =0; i <rawData.length; ++i) { outputArray[i] =rawData.charCodeAt(i); } return outputArray;
}
关于服务端公钥如何获取,在文章后续会有相关阐述。
处理拒绝的权限
如果在调用serviceWorkerRegistration.pushManager.subscribe
后,用户拒绝了推送权限,同样也可以在应用程序中,通过Notification.permission获取到这一状态,Notification.permission
有以下三个取值,:
granted
:用户已经明确的授予了显示通知的权限。denied
:用户已经明确的拒绝了显示通知的权限。default
:用户还未被询问是否授权,在应用程序中,这种情况下权限将视为denied
。if (Notification.permission===’granted’) {
// 用户允许消息推送
} else {
// 还不允许消息推送,向用户申请消息推送的权限
}
密钥生成
上述代码中的applicationServerPublicKey
通常情况下是由服务端生成的公钥,在页面初始化的时候就会返回给客户端,服务端会保存每个用户对应的公钥与私钥,以便进行消息推送。
在我的示例演示中,我们可以使用Google
配套的实验网站web-push-codelab生成公钥与私钥,以便发送消息通知:
发送推送
在Service Worker
中,通过监听push
事件来处理消息推送:
self.addEventListener('push', function(event) {
consttitle=event.data.text();
constoptions= {
body:event.data.text(),
icon:'./images/logo/logo512.png',
};
event.waitUntil(self.registration.showNotification(title, options));
});
在上面的代码中,在push
事件回调中,通过event.data.text()
拿到消息推送的文本,然后调用上面所说的self.registration.showNotification
来展示消息推送。
服务端发送
那么,如何在服务端识别指定的用户,向其发送对应的消息推送呢?
在调用swReg.pushManager.subscribe
方法后,如果用户是允许消息推送的,那么该函数返回的Promise
将会resolve
,在then
中获取到对应的subscription
。
subscription
一般是下面的格式:
{
"endpoint": "https://fcm.googleapis.com/fcm/send/cSEJGmI_x2s:APA91bHzRHllE6tNoEHqjHQSlLpcQHeiGr7X78EIa1QrUPFqDGDM_4RVKNxoLPV3_AaCCejR4uwUawBKYcQLmLpUrCUoZetQ9pVzQCJSomB5BvoFZBzkSnUb-ALm4D1lqwV9w_uP3M0E",
"expirationTime": null,
"keys": {
"p256dh": "BDOx1ZTtsFL2ncSN17Bu7-Wl_1Z7yIiI-lKhtoJ2dAZMToGz-XtQOe6cuMLMa3I8FoqPfcPy232uAqoISB4Z-UU",
"auth": "XGWy-wlmrAw3Be818GLZ8Q"
}
}
使用Google
配套的实验网站web-push-codelab,发送消息推送。
web-push
在服务端,使用web-push-libs,实现公钥与私钥的生成,消息推送功能,Node.js版本。
constwebpush=require('web-push');
// VAPID keys should only be generated only once.constvapidKeys=webpush.generateVAPIDKeys();
webpush.setGCMAPIKey('<Your GCM API Key Here>');
webpush.setVapidDetails(
'mailto:example@yourdomain.org',
vapidKeys.publicKey,
vapidKeys.privateKey
);
// pushSubscription是前端通过swReg.pushManager.subscribe获取到的subscriptionconstpushSubscription= {
endpoint:'.....',
keys: {
auth:'.....',
p256dh:'.....'
}
};
webpush.sendNotification(pushSubscription, 'Your Push Payload Text');
上面的代码中,GCM API Key
需要在Firebase console中申请,申请教程可参考这篇博文。
在这个我写的示例Demo
中,我把subscription
写死了:
constwebpush=require('web-push');
webpush.setVapidDetails(
'mailto:503908971@qq.com',
'BCx1qqSFCJBRGZzPaFa8AbvjxtuJj9zJie_pXom2HI-gisHUUnlAFzrkb-W1_IisYnTcUXHmc5Ie3F58M1uYhZU',
'g5pubRphHZkMQhvgjdnVvq8_4bs7qmCrlX-zWAJE9u8'
);
constsubscription= {
"endpoint":"https://fcm.googleapis.com/fcm/send/cSEJGmI_x2s:APA91bHzRHllE6tNoEHqjHQSlLpcQHeiGr7X78EIa1QrUPFqDGDM_4RVKNxoLPV3_AaCCejR4uwUawBKYcQLmLpUrCUoZetQ9pVzQCJSomB5BvoFZBzkSnUb-ALm4D1lqwV9w_uP3M0E",
"expirationTime":null,
"keys": {
"p256dh":"BDOx1ZTtsFL2ncSN17Bu7-Wl_1Z7yIiI-lKhtoJ2dAZMToGz-XtQOe6cuMLMa3I8FoqPfcPy232uAqoISB4Z-UU",
"auth":"XGWy-wlmrAw3Be818GLZ8Q"
}
};
webpush.sendNotification(subscription, 'Counterxing');
交互响应
默认情况下,推送的消息点击后是没有对应的交互的,配合clients API可以实现一些类似于原生应用的交互,这里参考了这篇博文的实现:
Service Worker
中的self.clients
对象提供了Client
的访问,Client
接口表示一个可执行的上下文,如Worker
或SharedWorker
。Window
客户端由更具体的WindowClient
表示。 你可以从Clients.matchAll()
和Clients.get()
等方法获取Client/WindowClient
对象。
新窗口打开
使用clients.openWindow
在新窗口打开一个网页:
self.addEventListener('notificationclick', function(event) {
event.notification.close();
// 新窗口打开event.waitUntil(
clients.openWindow('https://google.com/')
);
});
聚焦已经打开的页面
利用cilents
提供的相关API
获取,当前浏览器已经打开的页面URLs
。不过这些URLs
只能是和你SW
同域的。然后,通过匹配URL
,通过matchingClient.focus()
进行聚焦。没有的话,则新打开页面即可。
self.addEventListener('notificationclick', function(event) {
event.notification.close();
consturlToOpen=self.location.origin+'/index.html';
constpromiseChain=clients.matchAll({
type:'window',
includeUncontrolled:true
})
.then((windowClients) => {
let matchingClient =null;
for (let i =0; i <windowClients.length; i++) {
constwindowClient= windowClients[i];
if (windowClient.url=== urlToOpen) {
matchingClient = windowClient;
break;
}
}
if (matchingClient) {
returnmatchingClient.focus();
} else {
returnclients.openWindow(urlToOpen);
}
});
event.waitUntil(promiseChain);
});
检测是否需要推送
如果用户已经停留在当前的网页,那我们可能就不需要推送了,那么针对于这种情况,我们应该怎么检测用户是否正在网页上呢?
通过
windowClient.focused
可以检测到当前的Client
是否处于聚焦状态。
self.addEventListener('push', function(event) {
constpromiseChain=clients.matchAll({
type:'window',
includeUncontrolled:true
})
.then((windowClients) => {
let mustShowNotification =true;
for (let i =0; i <windowClients.length; i++) {
constwindowClient= windowClients[i];
if (windowClient.focused) {
mustShowNotification =false;
break;
}
}
return mustShowNotification;
})
.then((mustShowNotification) => {
if (mustShowNotification) {
consttitle=event.data.text();
constoptions= {
body:event.data.text(),
icon:'./images/logo/logo512.png',
};
returnself.registration.showNotification(title, options);
} else {
console.log('用户已经聚焦于当前页面,不需要推送。');
}
});
});
合并消息
该场景的主要针对消息的合并。比如,当只有一条消息时,可以直接推送,那如果该用户又发送一个消息呢? 这时候,比较好的用户体验是直接将推送合并为一个,然后替换即可。 那么,此时我们就需要获得当前已经展示的推送消息,这里主要通过registration.getNotifications() API
来进行获取。该API
返回的也是一个Promise
对象。通过Promise
在resolve
后拿到的notifications
,判断其length
,进行消息合并。
self.addEventListener('push', function(event) {
// ...
.then((mustShowNotification) => {
if (mustShowNotification) {
returnregistration.getNotifications()
.then(notifications=> {
let options = {
icon:'./images/logo/logo512.png',
badge:'./images/logo/logo512.png'
};
let title =event.data.text();
if (notifications.length) {
options.body=`您有${notifications.length}条新消息`;
} else {
options.body=event.data.text();
}
returnself.registration.showNotification(title, options);
});
} else {
console.log('用户已经聚焦于当前页面,不需要推送。');
}
});
// ...
});
服务端推送的几种方式
服务端推送是现今Web
开发过程中最常见的需求。例如:
- 即时聊天工具
- H5网络游戏
- 消息通知
一般的服务器推送包括:
- 最简单的是客户端轮询的方式,在客户端创建一个定时器,每隔一定的时间去请求服务端,每次请求检查状态变化以判断服务端是否有新数据更新。
- 基于 AJAX 的长轮询(
long-polling
)方式,服务器在一段时间后再返回信息; HTTP Streaming
,通过iframe
和<script>
标签完成数据的传输;TCP
长连接/WebSocket
,可以实现服务器主动发送数据至网页端,它和HTTP
一样,是一个基于HTTP
的应用层协议,跑的是TCP
,所以本质上还是个长连接,双向通信,意味着服务器端和客户端可以同时发送并响应请求,而不再像HTTP
的请求和响应SSE: Server-Sent Events
,这是通过http
协议变通实现的,通过服务端向客户端声明,接下来是要发送的是流信息,本质上就是完成一次耗时长的下载。
小结
本文通过一个简单的例子,讲述了Service Worker
中消息推送的原理。Service Worker
中的消息推送是基于Notification API
的,这一API
的使用首先需要用户授权,通过在Service Worker
注册时的serviceWorkerRegistration.pushManager.subscribe
方法来向用户申请权限,如果用户拒绝了消息推送,应用程序也需要相关处理。
消息推送是基于谷歌云服务的,因此,在国内,收到GFW
的限制,这一功能的支持并不好,Google
提供了一系列推送相关的库,例如Node.js
中,使用web-push来实现。一般原理是:在服务端生成公钥和私钥,并针对用户将其公钥和私钥存储到服务端,客户端只存储公钥。Service Worker
的swReg.pushManager.subscribe
可以获取到subscription
,并发送给服务端,服务端利用subscription
向指定的用户发起消息推送。
消息推送功能可以配合clients API
做特殊处理。
如果用户安装了PWA
应用,即使用户关闭了应用程序,Service Worker
也在运行,即使用户未打开应用程序,也会收到消息通知。