workers标准让在Web App上拥有这些功能成为可能,原

作者: 前端  发布:2019-09-22

选用 Service Worker 做三个 PWA 离线网页应用

2017/10/09 · JavaScript · PWA, Service Worker

原作出处: 人人网FED博客   

在上一篇《自己是哪些让网址用上HTML5 Manifest》介绍了怎么用Manifest做叁个离线网页应用,结果被广大网络好友调侃说这几个事物已经被deprecated,移出web标准了,未来被ServiceWorker代替了,不管如何,Manifest的部分心想仍是可以借用的。小编又将网址进级到了瑟维斯Worker,假诺是用Chrome等浏览器就用ServiceWorker做离线缓存,借使是Safari浏览器就照旧用Manifest,读者能够打开这么些网址感受一下,断网也是能符合规律展开。

渐进式Web应用(PWA)入门教程(下)

2018/05/25 · 基本功技艺 · PWA

初稿出处: Craig Buckler   译文出处:葡萄城控件   

上篇小说大家对渐进式Web应用(PWA)做了一部分主导的牵线。

渐进式Web应用(PWA)入门教程(上)

在这一节中,我们将介绍PWA的原理是什么样,它是什么样开头职业的。

选拔 Service worker 成立二个特别简单的离线页面

2016/06/07 · JavaScript · 1 评论 · Service Worker

本文由 伯乐在线 - 刘健超-J.c 翻译,艾凌风 校稿。未经许可,禁止转发!
意大利共和国语出处:Dean Hume。款待加入翻译组。

让我们想像以下情状:我们那时候在一辆通往农村的列车的里面,用运动道具瞧着一篇很棒的稿子。与此同一时间,当你点击“查看更加多”的链接时,火车忽地步向了隧道,导致移动设备失去了互联网,而 web 页面会呈现出类似以下的开始和结果:

图片 1

那是一对一令人寒心的体会!幸运的是,web 开荒者们能通过有个别新特征来改革那类的客户体验。我多年来一贯在折腾 ServiceWorkers,它给 web 带来的数不清或许性总能给自家惊奇。Service Workers 的可观特质之一是允许你检验互联网伏乞的情景,并让您作出相应的响应。

在那篇小说里,小编筹算用此本性检查顾客的如今网络连接处境,如果没连接则赶回多个一级级简单的离线页面。就算这是多个特别基础的案例,但它能给您带来启迪,让你了解运维并运转该性格是何其的粗略!要是您没了然过 Service Worker,我建议你看看此 Github repo,掌握越多相关的音信。

在本案例初始前,让大家先轻便地走访它的行事流程:

  1. 在客户第叁遍访谈大家的页面时,大家会安装 ServiceWorker,并向浏览器的缓存增加我们的离线 HTML 页面
  2. 接下来,假使顾客筹划导航到另二个 web 页面(同一个网址下),但那时已断网,那么我们将回来已被缓存的离线 HTML 页面
  3. 唯独,如若客户准备导航到别的贰个 web 页面,而那时候网络已接连,则能照常浏览页面

Service Worker入门

2015/03/26 · JavaScript · Service Worker

原来的小说出处: Matt Gaunt   译文出处:[w3ctech

  • 十年踪迹]()   

原生App具有Web应用一般所不富有的富离线体验,定时的沉默更新,音信公告推送等效果。而新的Serviceworkers规范让在Web App上具有那些功用成为也许。

1. 什么是Service Worker

Service Worker是Google倡导的贯彻PWA(Progressive Web App)的三个第一剧中人物,PWA是为着消除守旧Web 应用程式的败笔:

(1)未有桌面入口

(2)不能够离线使用

(3)没有Push推送

那Service Worker的具体表现是何许的啊?如下图所示:

图片 2

ServiceWorker是在后台运行的一条服务Worker线程,上海教室作者开了多少个标签页,所以显示了三个Client,可是不管开多少个页面都唯有一个Worker在担负管理。那几个Worker的干活是把某个财富缓存起来,然后拦截页面的央求,先看下缓存Curry有未有,假使局地话就从缓存里取,响应200,反之未有的话就走正规的伸手。具体来讲,ServiceWorker结合Web App Manifest能成功以下职业(那也是PWA的检查测量检验职业):

图片 3

包蕴能够离线使用、断网时重返200、能唤起顾客把网址增多三个Logo到桌面上等。

第一步:使用HTTPS

渐进式Web应用程序要求运用HTTPS连接。纵然选取HTTPS会令你服务器的开销变多,但运用HTTPS能够让你的网址变得更安全,HTTPS网址在Google上的排行也会更靠前。

出于Chrome浏览器会私下认可将localhost以及127.x.x.x地址视为测量试验地方,所以在本示例中你并无需开启HTTPS。另外,出于调节和测量试验目标,您能够在开发银行Chrome浏览器的时候利用以下参数来关闭其对网址HTTPS的自己商量:

  • –user-data-dir
  • –unsafety-treat-insecure-origin-as-secure

让大家初步吧

假如你有以下 HTML 页面。这尽管拾分基础,但能给你完整思路。

XHTML

<!DOCTYPE html>

1
<!DOCTYPE html>

继之,让我们在页面里登记 Service Worker,这里仅创制了该对象。向正要的 HTML 里增加以下代码。

JavaScript

<script> // Register the service worker // 注册 service worker if ('serviceWorker' in navigator) { navigator.serviceWorker.register('/service-worker.js').then(function(registration) { // Registration was successful // 注册成功 console.log('ServiceWorker registration successful with scope: ', registration.scope); }).catch(function(err) { // registration failed :( // 注册战败 :( console.log('ServiceWorker registration failed: ', err); }); } </script>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<script>
// Register the service worker
// 注册 service worker
if ('serviceWorker' in navigator) {
    navigator.serviceWorker.register('/service-worker.js').then(function(registration) {
    // Registration was successful
    // 注册成功
    console.log('ServiceWorker registration successful with scope: ', registration.scope);
}).catch(function(err) {
    // registration failed :(
    // 注册失败 :(
    console.log('ServiceWorker registration failed: ', err);
   });
}
</script>

然后,大家须求创制 Service Worker 文件并将其取名叫‘service-worker.js‘。大家筹算用那几个 Service Worker 拦截任何互连网央求,以此检查互连网的连接性,并基于检查结果向客户重回最符合的内容。

JavaScript

'use strict'; var cacheVersion = 1; var currentCache = { offline: 'offline-cache' + cacheVersion }; const offlineUrl = 'offline-page.html'; this.addEventListener('install', event => { event.waitUntil( caches.open(currentCache.offline).then(function(cache) { return cache.addAll([ './img/offline.svg', offlineUrl ]); }) ); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
'use strict';
 
var cacheVersion = 1;
var currentCache = {
  offline: 'offline-cache' + cacheVersion
};
const offlineUrl = 'offline-page.html';
 
this.addEventListener('install', event => {
  event.waitUntil(
    caches.open(currentCache.offline).then(function(cache) {
      return cache.addAll([
          './img/offline.svg',
          offlineUrl
      ]);
    })
  );
});

在上边包车型大巴代码中,我们在装置 Service Worker 时,向缓存增多了离线页面。借使大家将代码分为几小块,可观望前几行代码中,作者为离线页面钦点了缓存版本和U福睿斯L。假若您的缓存有例外版本,那么你只需立异版本号就可以轻松地扫除缓存。在大意在第 12 行代码,作者向这些离线页面及其财富(如:图片)发出诉求。在赢得成功的响应后,大家将离线页面和连锁能源丰裕到缓存。

前天,离线页面已存进缓存了,大家可在要求的时等候检查索它。在同三个 ServiceWorker 中,我们必要对无互连网时重临的离线页面加多相应的逻辑代码。

JavaScript

this.addEventListener('fetch', event => { // request.mode = navigate isn't supported in all browsers // request.mode = naivgate 并从未取得全部浏览器的支撑 // so include a check for Accept: text/html header. // 由此对 header 的 Accept:text/html 进行把关 if (event.request.mode === 'navigate' || (event.request.method === 'GET' && event.request.headers.get('accept').includes('text/html'))) { event.respondWith( fetch(event.request.url).catch(error => { // Return the offline page // 再次回到离线页面 return caches.match(offlineUrl); }) ); } else{ // Respond with everything else if we can // 重返任何大家能回来的东西 event.respondWith(caches.match(event.request) .then(function (response) { return response || fetch(event.request); }) ); } });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
this.addEventListener('fetch', event => {
  // request.mode = navigate isn't supported in all browsers
  // request.mode = naivgate 并没有得到所有浏览器的支持
  // so include a check for Accept: text/html header.
  // 因此对 header 的 Accept:text/html 进行核实
  if (event.request.mode === 'navigate' || (event.request.method === 'GET' && event.request.headers.get('accept').includes('text/html'))) {
        event.respondWith(
          fetch(event.request.url).catch(error => {
              // Return the offline page
              // 返回离线页面
              return caches.match(offlineUrl);
          })
    );
  }
  else{
        // Respond with everything else if we can
        // 返回任何我们能返回的东西
        event.respondWith(caches.match(event.request)
                        .then(function (response) {
                        return response || fetch(event.request);
                    })
            );
      }
});

为了测量试验该作用,你能够应用 Chrome 内置的开拓者工具。首先,导航到你的页面,然后一旦设置上了 ServiceWorker,就张开 Network 标签并将节流(throttling)改为 Offline。(译者注:若将节流设置为 Offline 没效果,则可经过关闭网络大概经过360莱芜警卫禁止 Chrome 访谈网络)

图片 4

要是您刷新页面,你应该能观看相应的离线页面!

图片 5

假定你只想大致地质度量试该意义而不想写任何代码,那么你能够访谈笔者已成立好的 demo。别的,上述全部代码能够在 Github repo 找到。

自家知道用在此案例中的页面非常粗略,但你的离线页面则在于你自个儿!假设您想深切该案例的剧情,你可感觉离线页面增添缓存破坏( cache busting),如: 此案例。

Service Worker 是什么?

贰个 service worker 是一段运营在浏览器后台进程里的台本,它独自于前段时间页面,提供了那多少个无需与web页面交互的功力在网页背后悄悄实践的技艺。在前日,基于它能够兑现信息推送,静默更新以及地理围栏等服务,可是近来它首先要享有的效应是挡住和处理互联网央浼,包含可编制程序的响应缓存管理。

怎么说这一个API是一个那多少个棒的API呢?因为它使得开垦者能够支撑相当好的离线体验,它赋予开垦者完全调控离线数据的本领。

在service worker提议此前,别的八个提供开采者离线体验的API叫做App Cache。不过App Cache某些局限性,譬喻它能够很轻松地消除单页应用的难点,然而在多页应用上会很麻烦,而Serviceworkers的出现正是为了消除App Cache的痛点。

上边详细说一下service worker有哪些必要专一的地方:

  • 它是JavaScript Worker,所以它不能够一向操作DOM。可是service worker能够透过postMessage与页面之间通讯,把音讯布告给页面,假如供给的话,让页面自个儿去操作DOM。
  • Serviceworker是三个可编制程序的网络代理,允许开采者调控页面上拍卖的网络央求。
  • 在不被接纳的时候,它会本人终止,而当它再一次被用到的时候,会被再次激活,所以您不能够注重于service worker的onfecth和onmessage的管理函数中的全局状态。假设你想要保存一些长久化的音讯,你能够在service worker里使用IndexedDB API。
  • Serviceworker大量使用promise,所以只要你不打听怎么是promise,那您需求先读书这篇文章。

2. Service Worker的支撑景况

Service Worker近些日子独有Chrome/Firfox/Opera协助:

图片 6

Safari和Edge也在筹划支持Service Worker,由于ServiceWorker是Google着力的一项规范,对于生态比较密封的Safari来说也是迫于时势伊始准备扶助了,在Safari TP版本,能够见到:

图片 7

在试验成效(Experimental Features)里曾经有ServiceWorker的菜单项了,只是就算张开也是无法用,会提示您还尚无完成:

图片 8

但不论是什么样,至少表明Safari已经准备协理ServiceWorker了。别的还是可以见见在今年二零一七年11月揭露的Safari 11.0.1本子现已支撑WebRTC了,所以Safari如故三个更进一步的孩子。

Edge也筹算援助,所以Service Worker的前景特别美好。

其次步:创造四个应用程序清单(Manifest)

应用程序清单提供了和如今渐进式Web应用的相干音讯,如:

  • 应用程序名
  • 描述
  • 怀有图片(满含主显示屏Logo,运维显示器页面和用的图片恐怕网页上用的图纸)

实为上讲,程序清单是页面上用到的Logo和主旨等财富的元数据。

程序清单是三个身处您使用根目录的JSON文件。该JSON文件再次来到时必得抬高Content-Type: application/manifest+json 或者 Content-Type: application/jsonHTTP头音信。程序清单的文本名不限,在本文的演示代码中为manifest.json

{ "name" : "PWA Website", "short_name" : "PWA", "description" : "An example PWA website", "start_url" : "/", "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" } ] }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
  "name"              : "PWA Website",
  "short_name"        : "PWA",
  "description"       : "An example PWA website",
  "start_url"         : "/",
  "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"
    }
  ]
}

程序清单文件创立完之后,你要求在各类页面上引用该公文:

<link rel="manifest" href="/manifest.json">

1
<link rel="manifest" href="/manifest.json">

以下属性在程序清单中日常利用,介绍表明如下:

  • name: 顾客观望的施用名称
  • short_name: 应用短名称。当呈现选用名称的地点相当不足时,将应用该名称。
  • description: 利用描述。
  • start_url: 运用开始路线,绝对路线,默感觉/。
  • scope: URubiconL范围。比如:如若你将“/app/”设置为U奥迪Q3L范围时,那个动用就能够直接在这些目录中。
  • background_color: 款待页面包车型客车背景颜色和浏览器的背景颜色(可选)
  • theme_color: 使用的主旨颜色,一般都会和背景颜色同样。那几个装置决定了动用怎么样体现。
  • orientation: 事先旋转方向,可选的值有:any, natural, landscape, landscape-primary, landscape-secondary, portrait, portrait-primary, and portrait-secondary
  • display: 显示格局——fullscreen(无Chrome),standalone(和原生应用同样),minimal-ui(最小的一套UI控件集)可能browser(最古老的施用浏览器标签呈现)
  • icons: 三个暗含全部图片的数组。该数组中各类成分包罗了图片的UHighlanderL,大小和类别。

拓宽阅读

除此以外,还只怕有多少个很棒的离线效能案例。如:Guardian 创设了一个独具 crossword puzzle(填字游戏)的离线 web 页面 – 因而,纵然等待互连网重连时(即已在离线状态下),也能找到一点野趣。我也推荐看看 Google Chrome Github repo,它含有了重重两样的 瑟维斯 Worker 案例 – 在那之中有的采用案例也在那!

唯独,倘让你想跳过上述代码,只是想大约地通过叁个库来管理有关操作,那么本身推荐你看看 UpUp。那是八个轻量的本子,能令你更轻易地运用离线功用。

打赏帮衬我翻译越多好小说,多谢!

打赏译者

Service Worker的生命周期

Service worker具备四个全然独立于Web页面包车型地铁生命周期。

要让七个service worker在您的网址上生效,你须要先在你的网页中注册它。注册一个service worker之后,浏览器会在后台默默运行叁个service worker的安装进度。

在安装进程中,浏览器会加载并缓存一些静态能源。假诺持有的公文被缓存成功,service worker就安装成功了。如若有别的公文加载或缓存战败,那么安装进度就能失利,service worker就不能够被激活(也即未能安装成功)。假诺产生这样的主题素材,别担忧,它会在后一次再尝试安装。

当安装达成后,service worker的下一步是激活,在这一品级,你还足以荣升叁个service worker的版本,具体内容大家会在背后讲到。

在激活之后,service worker将接管全部在友好管辖域范围内的页面,可是只要一个页面是刚刚注册了service worker,那么它这一遍不会被接管,到下一遍加载页面包车型大巴时候,service worker才会生效。

当service worker接管了页面之后,它可能有二种景况:要么被停止以节外省部存款和储蓄器,要么会管理fetch和message事件,那三个事件分别产生于三个网络央浼出现依旧页面上发送了八个新闻。

下图是四个简化了的service worker初次安装的生命周期:

图片 9

3. 使用Service Worker

ServiceWorker的利用套路是先注册贰个Worker,然后后台就能够运维一条线程,能够在那条线程运维的时候去加载一些能源缓存起来,然后监听fetch事件,在那几个事件里拦截页面包车型地铁呼吁,先看下缓存里有未有,假若有一直重临,不然符合规律加载。大概是一早先不缓存,每一个能源诉求后再拷贝一份缓存起来,然后下二回呼吁的时候缓存里就有了。

其三步:创制二个 Service Worker

Service Worker 是多个可编制程序的服务器代理,它可以阻挡或然响应网络央浼。Service Worker 是坐落应用程序根目录的贰个个的JavaScript文件。

您必要在页面前遇到应的JavaScript文件中登记该ServiceWorker:

if ('serviceWorker' in navigator) { // register service worker navigator.serviceWorker.register('/service-worker.js'); }

1
2
3
4
if ('serviceWorker' in navigator) {
  // register service worker
  navigator.serviceWorker.register('/service-worker.js');
}

假如你没有要求离线的连锁职能,您能够只创造三个 /service-worker.js文件,这样顾客就能够平素设置您的Web应用了!

ServiceWorker这些概念也许相比较难懂,它实际是一个办事在任何线程中的标准的Worker,它不得以访问页面上的DOM元素,未有页面上的API,不过足以阻碍全部页面上的网络乞求,富含页面导航,乞求财富,Ajax央浼。

地点便是选拔全站HTTPS的入眼原因了。倘若你未有在您的网站中采用HTTPS,三个第三方的剧本就能够从别的的域名注入他本人的瑟维斯Worker,然后篡改全部的央浼——那如实是非常惊恐的。

Service Worker 会响应多少个事件:install,activate和fetch。

打赏援救笔者翻译更加的多好小说,多谢!

任选一种支付办法

图片 10 图片 11

1 赞 3 收藏 1 评论

在大家开端写码以前

从这个体系地址拿到chaches polyfill。

这个polyfill支持CacheStorate.match,Cache.add和Cache.addAll,而现在Chrome M40实现的Cache API还不曾协理这么些艺术。

将dist/serviceworker-cache-polyfill.js放到你的网址中,在service worker中通过importScripts加载进来。被service worker加载的脚本文件会被活动缓存。

JavaScript

importScripts('serviceworker-cache-polyfill.js');

1
importScripts('serviceworker-cache-polyfill.js');

需要HTTPS

在开辟阶段,你能够透过localhost使用service worker,但是倘使上线,就必要您的server支持HTTPS。

您能够经过service worker威胁连接,伪造和过滤响应,特别逆天。就算你能够约束自个儿不干坏事,也可以有人想干坏事。所感到了堤防旁人使坏,你不得不在HTTPS的网页上注册service workers,那样大家才足以堤防加载service worker的时候不被歹徒篡改。(因为service worker权限不小,所以要幸免它自身被渣男篡改利用——译者注)

Github Pages恰巧是HTTPS的,所以它是一个美丽的原始实验田。

假设您想要让您的server援救HTTPS,你供给为你的server获得八个TLS证书。不一致的server安装方法不一致,阅读帮忙文档并通过Mozilla’s SSL config generator精晓最棒实践。

(1)注册八个Service Worker

Service Worker对象是在window.navigator里面,如下代码:

JavaScript

window.addEventListener("load", function() { console.log("Will the service worker register?"); navigator.serviceWorker.register('/sw-3.js') .then(function(reg){ console.log("Yes, it did."); }).catch(function(err) { console.log("No it didn't. This happened: ", err) }); });

1
2
3
4
5
6
7
8
9
window.addEventListener("load", function() {
    console.log("Will the service worker register?");
    navigator.serviceWorker.register('/sw-3.js')
    .then(function(reg){
        console.log("Yes, it did.");
    }).catch(function(err) {
        console.log("No it didn't. This happened: ", err)
    });
});

在页面load完事后注册,注册的时候传一个js文件给它,这么些js文件正是ServiceWorker的运营景况,假设无法学有所成注册的话就能够抛格外,如Safari TP即使有那么些指标,可是会抛格外无法采取,就足以在catch里面管理。这里有个难点是干吗供给在load事件运维呢?因为您要特别运营一个线程,运营今后你或许还也许会让它去加载财富,那么些都以索要占用CPU和带宽的,我们应当保障页面能健康加载完,然后再开发银行大家的后台线程,无法与正规的页面加载发生竞争,那么些在低等移动器具意义非常大。

还会有少数须求留神的是ServiceWorker和Cookie同样是有Path路线的定义的,尽管你设定二个cookie假如叫time的path=/page/A,在/page/B这一个页面是不可见得到到那一个cookie的,假若设置cookie的path为根目录/,则有着页面都能博取到。类似地,要是注册的时候利用的js路径为/page/sw.js,那么这一个ServiceWorker只可以管理/page路径下的页面和资源,而无法管理/api路线下的,所以一般把ServiceWorker注册到一流目录,如上边代码的”/sw-3.js”,那样那么些ServiceWorker就会接管页面包车型地铁兼具财富了。

Install事件

该事件将要使用设置到位后触发。大家一般在这里运用Cache API缓存一些少不了的文件。

第一,大家供给提供如下配置

  1. 缓存名称(CACHE)以及版本(version)。应用可以有三个缓存存款和储蓄,可是在行使时只会选取当中二个缓存存款和储蓄。每当缓存存款和储蓄有变化时,新的本子号将会钦定到缓存存款和储蓄中。新的缓存存款和储蓄将会作为当前的缓存存款和储蓄,从前的缓存存款和储蓄将会被作废。
  2. 三个离线的页面地址(offlineULacrosseL):当顾客访谈了之前未曾访问过的地点时,该页面将会议及展览示。
  3. 四个分包了独具必需文件的数组,包涵保持页面寻常作用的CSS和JavaScript。在本示例中,作者还增添了主页和logo。当有例外的U奥迪Q5L指向同贰个财富时,你也能够将那个UPAJEROL分别写到这几个数组中。offlineU本田UR-VL将会步向到这一个数组中。
  4. 作者们也能够将一部分非须求的缓存文件(installFilesDesirable)。这个文件在装置进程上校会被下载,但只要下载失败,不会接触安装退步。

// 配置文件 const version = '1.0.0', CACHE = version + '::PWAsite', offlineUQashqaiL = '/offline/', installFilesEssential = [ '/', '/manifest.json', '/css/styles.css', '/js/main.js', '/js/offlinepage.js', '/images/logo/logo152.png' ].concat(offlineURL), installFilesDesirable = [ '/favicon.ico', '/images/logo/logo016.png', '/images/hero/power-pv.jpg', '/images/hero/power-lo.jpg', '/images/hero/power-hi.jpg' ];

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// 配置文件
const
  version = '1.0.0',
  CACHE = version + '::PWAsite',
  offlineURL = '/offline/',
  installFilesEssential = [
    '/',
    '/manifest.json',
    '/css/styles.css',
    '/js/main.js',
    '/js/offlinepage.js',
    '/images/logo/logo152.png'
  ].concat(offlineURL),
  installFilesDesirable = [
    '/favicon.ico',
    '/images/logo/logo016.png',
    '/images/hero/power-pv.jpg',
    '/images/hero/power-lo.jpg',
    '/images/hero/power-hi.jpg'
  ];

installStaticFiles() 方法运用基于Promise的点子使用Cache API将文件存款和储蓄到缓存中。

// 安装静态财富 function installStaticFiles() { return caches.open(CACHE) .then(cache => { // 缓存可选文件 cache.addAll(installFilesDesirable); // 缓存必得文件 return cache.addAll(installFilesEssential); }); }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// 安装静态资源
function installStaticFiles() {
  return caches.open(CACHE)
    .then(cache => {
      // 缓存可选文件
      cache.addAll(installFilesDesirable);
      // 缓存必须文件
      return cache.addAll(installFilesEssential);
    });
}

最后,我们增多二个install的平地风波监听器。waitUntil办法保险了service worker不会安装直到其相关的代码被实行。这里它会施行installStaticFiles()方法,然后self.skipWaiting()格局来激活service worker:

// 应用设置 self.add伊芙ntListener('install', event => { console.log('service worker: install'); // 缓存首要文件 event.waitUntil( installStaticFiles() .then(() => self.skipWaiting()) ); });

1
2
3
4
5
6
7
8
9
10
11
12
// 应用安装
self.addEventListener('install', event => {
  console.log('service worker: install');
  // 缓存主要文件
  event.waitUntil(
    installStaticFiles()
    .then(() => self.skipWaiting())
  );
});

至于笔者:刘健超-J.c

图片 12

前端,在路上... 个人主页 · 作者的稿子 · 19 ·     

图片 13

使用Service Worker

明天大家有了polyfill,并且化解了HTTPS,让大家看看到底怎么用service worker。

(2)Service Worker安装和激活

挂号完事后,ServiceWorker就能进展设置,那一年会触发install事件,在install事件之中能够缓存一些能源,如下sw-3.js:

JavaScript

const CACHE_NAME = "fed-cache"; this.add伊夫ntListener("install", function(event) { this.skipWaiting(); console.log("install service worker"); // 创设和开荒贰个缓存库 caches.open(CACHE_NAME); // 首页 let cacheResources = ["]; event.waitUntil( // 央求能源并增添到缓存里面去 caches.open(CACHE_NAME).then(cache => { cache.addAll(cacheResources); }) ); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
const CACHE_NAME = "fed-cache";
this.addEventListener("install", function(event) {
    this.skipWaiting();
    console.log("install service worker");
    // 创建和打开一个缓存库
    caches.open(CACHE_NAME);
    // 首页
    let cacheResources = ["https://fed.renren.com/?launcher=true"];
    event.waitUntil(
        // 请求资源并添加到缓存里面去
        caches.open(CACHE_NAME).then(cache => {
            cache.addAll(cacheResources);
        })
    );
});

因而地点的操作,创制和增添了三个缓存库叫fed-cache,如下Chrome调控台所示:

图片 14

ServiceWorker的API基本上都以回来Promise对象防止堵塞,所以要用Promise的写法。上边在装置ServiceWorker的时候就把首页的恳求给缓存起来了。在瑟维斯Worker的运营情状之中它有贰个caches的大局对象,那几个是缓存的进口,还会有四个常用的clients的大局对象,三个client对应三个标签页。

在ServiceWorker里面能够利用fetch等API,它和DOM是隔开的,没有windows/document对象,不能够直接操作DOM,无法间接和页面交互,在ServiceWorker里面不可能获悉当前页面张开了、当前页面包车型大巴url是何许,因为八个ServiceWorker管理当前打开的几个标签页,能够因而clients知道全数页面包车型地铁url。还应该有可以通过postMessage的艺术和主页面互相传送消息和多少,进而做些调控。

install完未来,就能触发Service Worker的active事件:

JavaScript

this.addEventListener("active", function(event) { console.log("service worker is active"); });

1
2
3
this.addEventListener("active", function(event) {
    console.log("service worker is active");
});

ServiceWorker激活之后就能够监听fetch事件了,我们愿意每得到二个财富就把它缓存起来,就绝不像上一篇涉嫌的Manifest需求先生成一个列表。

你恐怕会问,当自家刷新页面包车型客车时候不是又再度注册安装和激活了一个ServiceWorker?即使又调了一遍注册,但并不会再次登记,它发掘”sw-3.js”那些曾经注册了,就不会再登记了,进而不会触发install和active事件,因为脚下ServiceWorker已经是active状态了。当须求立异ServiceWorker时,如产生”sw-4.js”,恐怕改造sw-3.js的文书内容,就能另行挂号,新的ServiceWorker会先install然后步入waiting状态,等到重启浏览器时,老的ServiceWorker就能够被替换掉,新的ServiceWorker走入active状态,倘诺不想等到再次开动浏览器能够像上面同样在install里面调skipWaiting:

JavaScript

this.skipWaiting();

1
this.skipWaiting();

Activate 事件

本条事件会在service worker被激活时发生。你或许没有须求以那件事件,但是在示范代码中,大家在该事件发生时将老的缓存全部清理掉了:

// clear old caches function clearOldCaches() { return caches.keys() .then(keylist => { return Promise.all( keylist .filter(key => key !== CACHE) .map(key => caches.delete(key)) ); }); } // application activated self.addEventListener('activate', event => { console.log('service worker: activate'); // delete old caches event.waitUntil( clearOldCaches() .then(() => self.clients.claim()) ); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
// clear old caches
function clearOldCaches() {
  return caches.keys()
    .then(keylist => {
      return Promise.all(
        keylist
          .filter(key => key !== CACHE)
          .map(key => caches.delete(key))
      );
    });
}
// application activated
self.addEventListener('activate', event => {
  console.log('service worker: activate');
    // delete old caches
  event.waitUntil(
    clearOldCaches()
    .then(() => self.clients.claim())
    );
});

注意self.clients.claim()施行时将会把当前service worker作为被激活的worker。

Fetch 事件 该事件将会在网络开头诉求时发起。该事件管理函数中,我们得以采取respondWith()方式来威吓HTTP的GET乞请然后重返:

  1. 从缓存中取到的财富文件
  2. 一旦第一步失利,财富文件将会从网络中运用Fetch API来猎取(和service worker中的fetch事件非亲非故)。获取到的财富将会加盟到缓存中。
  3. 要是第一步和第二步均退步,将会从缓存中回到正确的财富文件。

// application fetch network data self.addEventListener('fetch', event => { // abandon non-GET requests if (event.request.method !== 'GET') return; let url = event.request.url; event.respondWith( caches.open(CACHE) .then(cache => { return cache.match(event.request) .then(response => { if (response) { // return cached file console.log('cache fetch: ' + url); return response; } // make network request return fetch(event.request) .then(newreq => { console.log('network fetch: ' + url); if (newreq.ok) cache.put(event.request, newreq.clone()); return newreq; }) // app is offline .catch(() => offlineAsset(url)); }); }) ); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
// application fetch network data
self.addEventListener('fetch', event => {
  // abandon non-GET requests
  if (event.request.method !== 'GET') return;
  let url = event.request.url;
  event.respondWith(
    caches.open(CACHE)
      .then(cache => {
        return cache.match(event.request)
          .then(response => {
            if (response) {
              // return cached file
              console.log('cache fetch: ' + url);
              return response;
            }
            // make network request
            return fetch(event.request)
              .then(newreq => {
                console.log('network fetch: ' + url);
                if (newreq.ok) cache.put(event.request, newreq.clone());
                return newreq;
              })
              // app is offline
              .catch(() => offlineAsset(url));
          });
      })
  );
});

offlineAsset(url)措施中动用了有的helper方法来回到正确的数码:

// 是或不是为图片地址? let iExt = ['png', 'jpg', 'jpeg', 'gif', 'webp', 'bmp'].map(f => '.' + f); function isImage(url) { return iExt.reduce((ret, ext) => ret || url.endsWith(ext), false); } // return 重临离线能源 function offlineAsset(url) { if (isImage(url)) { // 重临图片 return new Response( '<svg role="img" viewBox="0 0 400 300" xmlns=" d="M0 0h400v300H0z" fill="#eee" /><text x="200" y="150" text-anchor="middle" dominant-baseline="middle" font-family="sans-serif" font-size="50" fill="#ccc">offline</text></svg>', { headers: { 'Content-Type': 'image/svg+xml', 'Cache-Control': 'no-store' }} ); } else { // return page return caches.match(offlineURL); } }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// 是否为图片地址?
let iExt = ['png', 'jpg', 'jpeg', 'gif', 'webp', 'bmp'].map(f => '.' + f);
function isImage(url) {
  
  return iExt.reduce((ret, ext) => ret || url.endsWith(ext), false);
  
}
  
  
// return 返回离线资源
function offlineAsset(url) {
  
  if (isImage(url)) {
  
    // 返回图片
    return new Response(
      '<svg role="img" viewBox="0 0 400 300" xmlns="http://www.w3.org/2000/svg"><title>offline</title><path d="M0 0h400v300H0z" fill="#eee" /><text x="200" y="150" text-anchor="middle" dominant-baseline="middle" font-family="sans-serif" font-size="50" fill="#ccc">offline</text></svg>',
      { headers: {
        'Content-Type': 'image/svg+xml',
        'Cache-Control': 'no-store'
      }}
    );
  
  }
  else {
  
    // return page
    return caches.match(offlineURL);
  
  }
  
}

offlineAsset()办法检查诉求是还是不是为五个图纸,然后回到一个包罗“offline”文字的SVG文件。其余诉求将会重返offlineU福特ExplorerL 页面。

Chrome开采者工具中的ServiceWorker部分提供了关于当前页面worker的新闻。当中会显得worker中发生的谬误,仍可以够强制刷新,也得以让浏览器进入离线格局。

Cache Storage 部分例举了当前怀有曾经缓存的财富。你能够在缓存须求更新的时候点击refresh开关。

哪些注册和装置service worker

要设置service worker,你供给在你的页面上注册它。这几个手续告诉浏览器你的service worker脚本在何地。

JavaScript

if ('serviceWorker' in navigator) { navigator.serviceWorker.register('/sw.js').then(function(registration) { // Registration was successful console.log('ServiceWorker registration successful with scope: ', registration.scope); }).catch(function(err) { // registration failed :( console.log('ServiceWorker registration failed: ', err); }); }

1
2
3
4
5
6
7
8
9
if ('serviceWorker' in navigator) {
  navigator.serviceWorker.register('/sw.js').then(function(registration) {
    // Registration was successful
    console.log('ServiceWorker registration successful with scope: ',    registration.scope);
  }).catch(function(err) {
    // registration failed :(
    console.log('ServiceWorker registration failed: ', err);
  });
}

上边的代码检查service worker API是还是不是可用,假设可用,service worker /sw.js 被注册。

只要这几个service worker已经被登记过,浏览器会自动忽略下边包车型大巴代码。

有五个内需特地表明的是service worker文件的渠道,你势必注意到了在那几个例子中,service worker文件被放在这些域的根目录下,那意味着service worker和网址同源。换句话说,这些service work将会吸纳那几个域下的享有fetch事件。假若本人将service worker文件注册为/example/sw.js,那么,service worker只能收到/example/路径下的fetch事件(例如: /example/page1/, /example/page2/)。

现行反革命您能够到 chrome://inspect/#service-workers 检查service worker是否对你的网站启用了。

图片 15

当service worker第一版被实现的时候,你也足以在chrome://serviceworker-internals中查看,它很有用,通过它可以最直观地熟悉service worker的生命周期,不过这个功能很快就会被移到chrome://inspect/#service-workers中。

您会发觉那些效果可以异常低价地在二个模仿窗口中测量试验你的service worker,那样您可以关闭和重复展开它,而不会影响到您的新窗口。任何创立在模仿窗口中的注册服务和缓存在窗口被关门时都将熄灭。

(3)fetch资源后cache起来

如下代码,监听fetch事件做些管理:

JavaScript

this.addEventListener("fetch", function(event) { event.respondWith( caches.match(event.request).then(response => { // cache hit if (response) { return response; } return util.fetchPut(event.request.clone()); }) ); });

1
2
3
4
5
6
7
8
9
10
11
12
this.addEventListener("fetch", function(event) {
    event.respondWith(
        caches.match(event.request).then(response => {
            // cache hit
            if (response) {
                return response;
            }
            return util.fetchPut(event.request.clone());
        })
    );
});

先调caches.match看一下缓存里面是不是有了,假设有间接再次来到缓存里的response,不然的话平常乞请财富并把它内置cache里面。放在缓存里能源的key值是Request对象,在match的时候,必要央求的url和header都平等才是千篇一律的财富,能够设定第三个参数ignoreVary:

JavaScript

caches.match(event.request, {ignoreVary: true})

1
caches.match(event.request, {ignoreVary: true})

意味着只要央浼url一样就觉着是同二个资源。

地点代码的util.fetchPut是这么达成的:

JavaScript

let util = { fetchPut: function (request, callback) { return fetch(request).then(response => { // 跨域的财富直接return if (!response || response.status !== 200 || response.type !== "basic") { return response; } util.putCache(request, response.clone()); typeof callback === "function" && callback(); return response; }); }, putCache: function (request, resource) { // 后台不要缓存,preview链接也不用缓存 if (request.method === "GET" && request.url.indexOf("wp-admin") < 0 && request.url.indexOf("preview_id") < 0) { caches.open(CACHE_NAME).then(cache => { cache.put(request, resource); }); } } };

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
let util = {
    fetchPut: function (request, callback) {
        return fetch(request).then(response => {
            // 跨域的资源直接return
            if (!response || response.status !== 200 || response.type !== "basic") {
                return response;
            }
            util.putCache(request, response.clone());
            typeof callback === "function" && callback();
            return response;
        });
    },
    putCache: function (request, resource) {
        // 后台不要缓存,preview链接也不要缓存
        if (request.method === "GET" && request.url.indexOf("wp-admin") < 0
              && request.url.indexOf("preview_id") < 0) {
            caches.open(CACHE_NAME).then(cache => {
                cache.put(request, resource);
            });
        }
    }
};

须求潜心的是跨域的能源不能够缓存,response.status会再次回到0,要是跨域的财富支撑CO帕杰罗S,那么能够把request的mod改成cors。假设乞求战败了,如404照旧是逾期等等的,那么也一贯回到response让主页面处理,否则的话表达加载成功,把那几个response克隆一个内置cache里面,然后再回去response给主页面线程。注意能减缓存里的能源一般只好是GET,通过POST获取的是无法缓存的,所以要做个判别(当然你也得以手动把request对象的method改成get),还可能有把一部分个体不指望缓存的能源也做个剖断。

那般尽管顾客张开过贰次页面,ServiceWorker就设置好了,他刷新页面恐怕展开第2个页面包车型客车时候就能够把央浼的财富一一做缓存,包含图片、CSS、JS等,只要缓存里有了不管客商在线或然离线都能够健康访谈。那样咱们当然会有八个主题材料,这几个缓存空间到底有多大?上一篇大家关系Manifest也终归地方存储,PC端的Chrome是5Mb,其实这一个说法在新本子的Chrome已经不可信了,在Chrome 61版本可以观看地面存款和储蓄的上空和选择景况:

图片 16

当中Cache Storage是指ServiceWorker和Manifest占用的半空中尺寸和,上海教室可以见到总的空间大小是20GB,大概是unlimited,所以基本上不用思量缓存会相当不足用。

第四步:创设可用的离线页面

离线页面能够是静态的HTML,一般用于提示顾客近来恳请的页面权且不能利用。不过,大家可以提供部分足以阅读的页面链接。

Cache API能够在main.js中采用。不过,该API使用Promise,在不帮衬Promise的浏览器中会失利,全数的JavaScript实行会为此境遇震慑。为了防止这种处境,在访问/js/offlinepage.js的时候大家加多了一段代码来检查当前是否在离线碰到中:

/js/offlinepage.js 中以版本号为名称保存了最近的缓存,获取具备UEnclaveL,删除不是页面包车型客车URL,将那个UPAJEROL排序然后将具有缓存的ULANDL体现在页面上:

// cache name const CACHE = '::PWAsite', offlineURL = '/offline/', list = document.getElementById('cachedpagelist'); // fetch all caches window.caches.keys() .then(cacheList => { // find caches by and order by most recent cacheList = cacheList .filter(cName => cName.includes(CACHE)) .sort((a, b) => a - b); // open first cache caches.open(cacheList[0]) .then(cache => { // fetch cached pages cache.keys() .then(reqList => { let frag = document.createDocumentFragment(); reqList .map(req => req.url) .filter(req => (req.endsWith('/') || req.endsWith('.html')) && !req.endsWith(offlineURL)) .sort() .forEach(req => { let li = document.createElement('li'), a = li.appendChild(document.createElement('a')); a.setAttribute('href', req); a.textContent = a.pathname; frag.appendChild(li); }); if (list) list.appendChild(frag); }); }) });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
// cache name
const
  CACHE = '::PWAsite',
  offlineURL = '/offline/',
  list = document.getElementById('cachedpagelist');
// fetch all caches
window.caches.keys()
  .then(cacheList => {
    // find caches by and order by most recent
    cacheList = cacheList
      .filter(cName => cName.includes(CACHE))
      .sort((a, b) => a - b);
    // open first cache
    caches.open(cacheList[0])
      .then(cache => {
        // fetch cached pages
        cache.keys()
          .then(reqList => {
            let frag = document.createDocumentFragment();
            reqList
              .map(req => req.url)
              .filter(req => (req.endsWith('/') || req.endsWith('.html')) && !req.endsWith(offlineURL))
              .sort()
              .forEach(req => {
                let
                  li = document.createElement('li'),
                  a = li.appendChild(document.createElement('a'));
                  a.setAttribute('href', req);
                  a.textContent = a.pathname;
                  frag.appendChild(li);
              });
            if (list) list.appendChild(frag);
          });
      })
  });

Service Worker的设置步骤

在页面上做到注册手续之后,让大家把注意力转到service worker的本子里来,在那中间,大家要成功它的设置步骤。

在最基本的例证中,你需求为install事件定义多个callback,并决定哪些文件你想要缓存。

JavaScript

// The files we want to cache var urlsToCache = [ '/', '/styles/main.css', '/script/main.js' ]; // Set the callback for the install step self.addEventListener('install', function(event) { // Perform install steps });

1
2
3
4
5
6
7
8
9
10
11
// The files we want to cache
var urlsToCache = [
  '/',
  '/styles/main.css',
  '/script/main.js'
];
 
// Set the callback for the install step
self.addEventListener('install', function(event) {
    // Perform install steps
});

在大家的install callback中,我们必要进行以下步骤:

  1. 拉开贰个缓存
  2. 缓存大家的文件
  3. 调整是或不是具有的能源是还是不是要被缓存

JavaScript

var CACHE_NAME = 'my-site-cache-v1'; var urlsToCache = [ '/', '/styles/main.css', '/script/main.js' ]; self.addEventListener('install', function(event) { // Perform install steps event.waitUntil( caches.open(CACHE_NAME) .then(function(cache) { console.log('Opened cache'); return cache.addAll(urlsToCache); }) ); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
var CACHE_NAME = 'my-site-cache-v1';
var urlsToCache = [
  '/',
  '/styles/main.css',
  '/script/main.js'
];
 
self.addEventListener('install', function(event) {
  // Perform install steps
  event.waitUntil(
    caches.open(CACHE_NAME)
      .then(function(cache) {
        console.log('Opened cache');
        return cache.addAll(urlsToCache);
      })
  );
});

地方的代码中,我们通过caches.open张开我们内定的cache文件名,然后大家调用cache.addAll并传到大家的文书数组。那是透过层层promise(caches.open 和 cache.addAll)实现的。event.waitUntil得到二个promise并选用它来收获安装花费的时光以及是否安装成功。

如若具有的公文都被缓存成功了,那么service worker就安装成功了。要是别的四个文书下载失利,那么安装步骤就能倒闭。那么些艺术允许你依据于你本身钦命的持有财富,不过那代表你需求丰富谦虚谨严地调控如何文件供给在设置步骤中被缓存。钦点了太多的文书的话,就能够追加设置战败率。

上面只是三个简约的例子,你能够在install事件中实践别的操作还是以致忽视install事件。

(4)cache html

地方第(3)步把图片、js、css缓存起来了,不过只要把页面html也缓存了,比方把首页缓存了,就能够有一个两难的主题材料——ServiceWorker是在页面注册的,不过以往获取页面包车型客车时候是从缓存取的,每回都以完全一样的,所以就招致心有余而力不足革新ServiceWorker,如形成sw-5.js,不过PWA又须要我们能缓存页面html。那怎么做吧?谷歌(Google)的开垦者文书档案它只是提到会存在这么些难点,但并从未表达怎么化解那一个题目。那些的标题标减轻将要求大家要有贰个建制能明白html更新了,进而把缓存里的html给替换掉。

Manifest更新缓存的编制是去看Manifest的公文内容有未有产生变化,若是发生变化了,则会去立异缓存,ServiceWorker也是依照sw.js的文本内容有未有发生变化,大家得以借鉴这一个思想,假若伏乞的是html并从缓存里抽出来后,再发个诉求获取叁个文件看html更新时间是否爆发变化,要是产生变化了则证实产生变动了,进而把缓存给删了。所以能够在服务端通过垄断(monopoly)这一个文件进而去革新客商端的缓存。如下代码:

JavaScript

this.add伊夫ntListener("fetch", function(event) { event.respondWith( caches.match(event.request).then(response => { // cache hit if (response) { //假如取的是html,则看发个须要看html是还是不是更新了 if (response.headers.get("Content-Type").indexOf("text/html") >= 0) { console.log("update html"); let url = new U本田UR-VL(event.request.url); util.updateHtmlPage(url, event.request.clone(), event.clientId); } return response; } return util.fetchPut(event.request.clone()); }) ); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
this.addEventListener("fetch", function(event) {
 
    event.respondWith(
        caches.match(event.request).then(response => {
            // cache hit
            if (response) {
                //如果取的是html,则看发个请求看html是否更新了
                if (response.headers.get("Content-Type").indexOf("text/html") >= 0) {
                    console.log("update html");
                    let url = new URL(event.request.url);
                    util.updateHtmlPage(url, event.request.clone(), event.clientId);
                }
                return response;
            }
 
            return util.fetchPut(event.request.clone());
        })
    );
});

经过响应头header的content-type是或不是为text/html,要是是的话就去发个要求获取一个文件,根据这几个文件的剧情决定是还是不是要求删除缓存,那么些立异的函数util.updateHtmlPage是那样完毕的:

JavaScript

let pageUpdateTime = { }; let util = { updateHtmlPage: function (url, htmlRequest) { let pageName = util.getPageName(url); let jsonRequest = new Request("/html/service-worker/cache-json/" + pageName + ".sw.json"); fetch(jsonRequest).then(response => { response.json().then(content => { if (pageUpdateTime[pageName] !== content.updateTime) { console.log("update page html"); // 假诺有更新则再次获得html util.fetchPut(htmlRequest); pageUpdateTime[pageName] = content.updateTime; } }); }); }, delCache: function (url) { caches.open(CACHE_NAME).then(cache => { console.log("delete cache "

  • url); cache.delete(url, {ignoreVary: true}); }); } };
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
let pageUpdateTime = {
 
};
let util = {
    updateHtmlPage: function (url, htmlRequest) {
        let pageName = util.getPageName(url);
        let jsonRequest = new Request("/html/service-worker/cache-json/" + pageName + ".sw.json");
        fetch(jsonRequest).then(response => {
            response.json().then(content => {
                if (pageUpdateTime[pageName] !== content.updateTime) {
                    console.log("update page html");
                    // 如果有更新则重新获取html
                    util.fetchPut(htmlRequest);
                    pageUpdateTime[pageName] = content.updateTime;
                }
            });
        });
    },
    delCache: function (url) {
        caches.open(CACHE_NAME).then(cache => {
            console.log("delete cache " + url);
            cache.delete(url, {ignoreVary: true});
        });
    }
};

代码先去赢得二个json文件,多少个页面会对应一个json文件,这几个json的内容是这么的:

JavaScript

{"updateTime":"10/2/2017, 3:23:57 PM","resources": {img: [], css: []}}

1
{"updateTime":"10/2/2017, 3:23:57 PM","resources": {img: [], css: []}}

当中根本有贰个updateTime的字段,倘使地点内存未有那几个页面包车型大巴updateTime的数码如故是和新星updateTime差异样,则再度去得到html,然后放到缓存里。接着须要通告页面线程数据产生变化了,你刷新下页面吗。那样就不要等客户刷新页面手艺奏效了。所以当刷新完页面后用postMessage通告页面:

JavaScript

let util = { postMessage: async function (msg) { const allClients = await clients.matchAll(); allClients.forEach(client => client.postMessage(msg)); } }; util.fetchPut(htmlRequest, false, function() { util.postMessage({type: 1, desc: "html found updated", url: url.href}); });

1
2
3
4
5
6
7
8
9
let util = {
    postMessage: async function (msg) {
        const allClients = await clients.matchAll();
        allClients.forEach(client => client.postMessage(msg));
    }
};
util.fetchPut(htmlRequest, false, function() {
    util.postMessage({type: 1, desc: "html found updated", url: url.href});
});

并明确type: 1就表示那是叁个革新html的音讯,然后在页面监听message事件:

JavaScript

if("serviceWorker" in navigator) { navigator.serviceWorker.addEventListener("message", function(event) { let msg = event.data; if (msg.type === 1 && window.location.href === msg.url) { console.log("recv from service worker", event.data); window.location.reload(); } }); }

1
2
3
4
5
6
7
8
9
if("serviceWorker" in navigator) {
    navigator.serviceWorker.addEventListener("message", function(event) {
        let msg = event.data;
        if (msg.type === 1 && window.location.href === msg.url) {
            console.log("recv from service worker", event.data);
            window.location.reload();
        }  
    });
}

然后当大家需求革新html的时候就更新json文件,那样顾客就能够看到最新的页面了。只怕是当客户重新起动浏览器的时候会导致ServiceWorker的运维内部存款和储蓄器都被清空了,即存款和储蓄页面更新时间的变量被清空了,那个时候也会再次须要页面。

亟需潜心的是,要把这么些json文件的http cache时间设置成0,那样浏览器就不会缓存了,如下nginx的陈设:

JavaScript

location ~* .sw.json$ { expires 0; }

1
2
3
location ~* .sw.json$ {
    expires 0;
}

因为这一个文件是亟需实时获取的,不可能被缓存,firefox私下认可会缓存,Chrome不会,加上http缓存时间为0,firefox也不会缓存了。

还恐怕有一种更新是客户更新的,比如顾客发布了探讨,供给在页面公告service worker把html缓存删了重新获得,那是叁个扭转的音信通知:

JavaScript

if ("serviceWorker" in navigator) { document.querySelector(".comment-form").addEventListener("submit", function() { navigator.serviceWorker.controller.postMessage({ type: 1, desc: "remove html cache", url: window.location.href} ); } }); }

1
2
3
4
5
6
7
8
9
10
if ("serviceWorker" in navigator) {
    document.querySelector(".comment-form").addEventListener("submit", function() {
            navigator.serviceWorker.controller.postMessage({
                type: 1,
                desc: "remove html cache",
                url: window.location.href}
            );
        }
    });
}

Service Worker也监听message事件:

JavaScript

const messageProcess = { // 删除html index 1: function (url) { util.delCache(url); } }; let util = { delCache: function (url) { caches.open(CACHE_NAME).then(cache => { console.log("delete cache "

  • url); cache.delete(url, {ignoreVary: true}); }); } }; this.addEventListener("message", function(event) { let msg = event.data; console.log(msg); if (typeof messageProcess[msg.type] === "function") { messageProcess[msg.type](msg.url); } });
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const messageProcess = {
    // 删除html index
    1: function (url) {
        util.delCache(url);
    }
};
 
let util = {
    delCache: function (url) {
        caches.open(CACHE_NAME).then(cache => {
            console.log("delete cache " + url);
            cache.delete(url, {ignoreVary: true});
        });
    }
};
 
this.addEventListener("message", function(event) {
    let msg = event.data;
    console.log(msg);
    if (typeof messageProcess[msg.type] === "function") {
        messageProcess[msg.type](msg.url);
    }
});

依照不相同的新闻类型调分裂的回调函数,借使是1的话就是剔除cache。客户发表完商议后会触发刷新页面,刷新的时候缓存已经被删了就能再也去央求了。

如此那般就化解了实时更新的问题。

开辟者工具

Chrome浏览器提供了一多种的工具来赞助你来调度ServiceWorker,日志也会一向突显在调整台上。

你最棒应用匿超级模特式来实行开垦职业,那样可以清除缓存对开垦的干扰。

最后,Chrome的Lighthouse恢宏也可以为您的渐进式Web应用提供部分创新新闻。

怎么着缓存和重临Request

你曾经设置了service worker,你以往能够回去您缓存的伏乞了。

当service worker棉被服装置成功还要客户浏览了另二个页面只怕刷新了当下的页面,service worker将启幕抽出到fetch事件。上面是叁个事例:

JavaScript

self.addEventListener('fetch', function(event) { event.respondWith( caches.match(event.request) .then(function(response) { // Cache hit - return response if (response) { return response; } return fetch(event.request); } ) ); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
self.addEventListener('fetch', function(event) {
  event.respondWith(
    caches.match(event.request)
      .then(function(response) {
        // Cache hit - return response
        if (response) {
          return response;
        }
 
        return fetch(event.request);
      }
    )
  );
});

地点的代码里大家定义了fetch事件,在event.respondWith里,大家传入了三个由caches.match发生的promise.caches.match 查找request中被service worker缓存命中的response。

如若大家有二个命中的response,大家回来被缓存的值,不然大家回去三个实时从网络诉求fetch的结果。这是贰个极其简单的例证,使用具有在install步骤下被缓存的财富。

借使大家想要增量地缓存新的呼吁,大家得以因此管理fetch诉求的response况兼拉长它们到缓存中来兑现,例如:

JavaScript

self.addEventListener('fetch', function(event) { event.respondWith( caches.match(event.request) .then(function(response) { // Cache hit - return response if (response) { return response; } // IMPORTANT: Clone the request. A request is a stream and // can only be consumed once. Since we are consuming this // once by cache and once by the browser for fetch, we need // to clone the response var fetchRequest = event.request.clone(); return fetch(fetchRequest).then( function(response) { // Check if we received a valid response if(!response || response.status !== 200 || response.type !== 'basic') { return response; } // IMPORTANT: Clone the response. A response is a stream // and because we want the browser to consume the response // as well as the cache consuming the response, we need // to clone it so we have 2 stream. var responseToCache = response.clone(); caches.open(CACHE_NAME) .then(function(cache) { cache.put(event.request, responseToCache); }); return response; } ); }) ); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
self.addEventListener('fetch', function(event) {
  event.respondWith(
    caches.match(event.request)
      .then(function(response) {
        // Cache hit - return response
        if (response) {
          return response;
        }
 
        // IMPORTANT: Clone the request. A request is a stream and
        // can only be consumed once. Since we are consuming this
        // once by cache and once by the browser for fetch, we need
        // to clone the response
        var fetchRequest = event.request.clone();
 
        return fetch(fetchRequest).then(
          function(response) {
            // Check if we received a valid response
            if(!response || response.status !== 200 || response.type !== 'basic') {
              return response;
            }
 
            // IMPORTANT: Clone the response. A response is a stream
            // and because we want the browser to consume the response
            // as well as the cache consuming the response, we need
            // to clone it so we have 2 stream.
            var responseToCache = response.clone();
 
            caches.open(CACHE_NAME)
              .then(function(cache) {
                cache.put(event.request, responseToCache);
              });
 
            return response;
          }
        );
      })
    );
});

代码里大家所做业务包蕴:

  1. 拉长一个callback到fetch央浼的 .then 方法中
  2. 设若我们得到了四个response,大家开展如下的反省:
    1. 有限帮助response是有效的
    2. 自己争持response的景色是或不是是200
    3. 管教response的档期的顺序是basic,那象征诉求作者是同源的,非同源(即跨域)的伸手也不能够被缓存。
  3. 要是大家因此了自己斟酌,clone本条伏乞。这么做的由来是假若response是贰个Stream,那么它的body只好被读取一遍,所以大家得将它克隆出来,一份发给浏览器,一份发给缓存。

4. Http/Manifest/Service Worker三种cache的关系

要缓存能够使用二种花招,使用Http Cache设置缓存时间,也得以用Manifest的Application Cache,还是可以用ServiceWorker缓存,如若三者都用上了会什么呢?

会以瑟维斯 Worker为事先,因为ServiceWorker把诉求拦截了,它首先做拍卖,假使它缓存库里有个别话一贯重临,没有的话符合规律必要,就一定于尚未ServiceWorker了,这年就到了Manifest层,Manifest缓存里倘使有的话就取这几个缓存,若无的话就也正是尚未Manifest了,于是就能从Http缓存里取了,假设Http缓存里也从没就能够发乞求去取得,服务端依照Http的etag大概Modified Time恐怕会回去304 Not Modified,不然寻常再次来到200和数量内容。那正是整一个收获的经过。

故而只要既用了Manifest又用ServiceWorker的话应该会导致同八个能源存了五次。可是能够让补助ServiceWorker的浏览器采纳Service Worker,而不援助的施用Manifest.

渐进式Web应用的要领

渐进式Web应用是一种新的技巧,所以采纳的时候料定要小心。也正是说,渐进式Web应用能够令你的网址在多少个钟头内得到勘误,而且在不帮忙渐进式Web应用的浏览器上也不会影响网址的显得。

唯独大家要求思虑以下几点:

怎样翻新三个Service Worker

您的service worker总有须求立异的那一天。当那一天来到的时候,你必要坚守如下步骤来更新:

  1. 立异您的service worker的JavaScript文件
    1. 当客户浏览你的网址,浏览器尝试在后台下载service worker的台本文件。只要服务器上的文本和本土文件有叁个字节分裂,它们就被判别为索要立异。
  2. 更新后的service worker将启幕运维,install event被再次触发。
  3. 在那么些时刻节点上,当前页目生效的还是是老版本的service worker,新的servicer worker将进入”waiting”状态。
  4. 当下页面被关闭之后,老的service worker进程被杀掉,新的servicer worker正式生效。
  5. 一旦新的service worker生效,它的activate事件被触发。

代码更新后,平日须要在activate的callback中推行三个管制cache的操作。因为你会需求破除掉从前旧的数量。大家在activate并非install的时候实行那么些操作是因为假若大家在install的时候登时施行它,那么还是在运行的旧版本的数据就坏了。

之前大家只利用了一个缓存,叫做my-site-cache-v1,其实我们也可以使用多个缓存的,例如一个给页面使用,一个给blog的内容提交使用。这意味着,在install步骤里,我们可以创建两个缓存,pages-cache-v1和blog-posts-cache-v1,在activite步骤里,我们可以删除旧的my-site-cache-v1。

下边的代码能够循环全体的缓存,删除掉全体不在白名单中的缓存。

JavaScript

self.addEventListener('activate', function(event) { var cacheWhitelist = ['pages-cache-v1', 'blog-posts-cache-v1']; event.waitUntil( caches.keys().then(function(cacheNames) { return Promise.all( cacheNames.map(function(cacheName) { if (cacheWhitelist.indexOf(cacheName) === -1) { return caches.delete(cacheName); } }) ); }) ); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
self.addEventListener('activate', function(event) {
 
  var cacheWhitelist = ['pages-cache-v1', 'blog-posts-cache-v1'];
 
  event.waitUntil(
    caches.keys().then(function(cacheNames) {
      return Promise.all(
        cacheNames.map(function(cacheName) {
          if (cacheWhitelist.indexOf(cacheName) === -1) {
            return caches.delete(cacheName);
          }
        })
      );
    })
  );
});

5. 选择Web App Manifest加多桌面入口

瞩目这里说的是别的二个Manifest,那么些Manifest是一个json文件,用来放网址icon名称等音讯以便在桌面加多贰个Logo,以及创设一种展开那个网页就像打开App同样的意义。下面一向讲的Manifest是被丢弃的Application Cache的Manifest。

其一Maifest.json文件能够这么写:

JavaScript

{ "short_name": "人人FED", "name": "人人网FED,潜心于后边二个本领", "icons": [ { "src": "/html/app-manifest/logo_48.png", "type": "image/png", "sizes": "48x48" }, { "src": "/html/app-manifest/logo_96.png", "type": "image/png", "sizes": "96x96" }, { "src": "/html/app-manifest/logo_192.png", "type": "image/png", "sizes": "192x192" }, { "src": "/html/app-manifest/logo_512.png", "type": "image/png", "sizes": "512x512" } ], "start_url": "/?launcher=true", "display": "standalone", "background_color": "#287fc5", "theme_color": "#fff" }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "short_name": "人人FED",
  "name": "人人网FED,专注于前端技术",
  "icons": [
    {
      "src": "/html/app-manifest/logo_48.png",
      "type": "image/png",
      "sizes": "48x48"
    },
    {
      "src": "/html/app-manifest/logo_96.png",
      "type": "image/png",
      "sizes": "96x96"
    },
    {
      "src": "/html/app-manifest/logo_192.png",
      "type": "image/png",
      "sizes": "192x192"
    },
    {
      "src": "/html/app-manifest/logo_512.png",
      "type": "image/png",
      "sizes": "512x512"
    }
  ],
  "start_url": "/?launcher=true",
  "display": "standalone",
  "background_color": "#287fc5",
  "theme_color": "#fff"
}

icon须求未焚徙薪多样尺度,最大要求512px * 512px的,那样Chrome会自动去选拔合适的图纸。如若把display改成standalone,从变化的Logo张开就能够像张开八个App一样,没有浏览器地址栏那个东西了。start_url钦定展开之后的输入链接。

下一场增加八个link标签指向那么些manifest文件:

JavaScript

<link rel="manifest" href="/html/app-manifest/manifest.json">

1
<link rel="manifest" href="/html/app-manifest/manifest.json">

如此组合Service Worker缓存:
图片 17把start_url指向的页面用ServiceWorker缓存起来,那样当客商用Chrome浏览器展开那些网页的时候,Chrome就能在底部弹一个提醒,询问客商是或不是把这么些网页增添到桌面,若是点“增多”就能够转换叁个桌面Logo,从这些Logo点进去就如展开三个App一样。感受如下:

图片 18

正如为难的是Manifest近些日子只有Chrome帮助,並且不得不在安卓系统上采用,IOS的浏览器无法增添三个桌面Logo,因为IOS未有开放这种API,不过小编的Safari却又是可以的。

综上,本文介绍了怎么用瑟维斯 Worker结合Manifest做叁个PWA离线Web 应用软件,首假如用ServiceWorker调整缓存,由于是写JS,相比较灵活,仍是能够与页面举办通讯,其它通过乞求页面包车型客车翻新时间来剖断是还是不是要求更新html缓存。ServiceWorker的包容性不是特别好,可是前景比较光明,浏览器都在预备协理。现阶段得以结合offline cache的Manifest做离线应用。

连带阅读:

  1. 怎么要把网址晋级到HTTPS
  2. 哪些把网址进级到http/2
  3. 自个儿是如何让网址用上HTML5 Manifest

1 赞 1 收藏 评论

图片 19

URL隐藏

当您的应用正是叁个单U奥迪Q7L的应用程序时(比如游戏),小编建议你隐蔽地址栏。除外的意况作者并不提出你隐蔽地址栏。在Manifest中,display: minimal-ui 或者 display: browser对于繁多景况来讲丰盛用了。

拍卖边界和填坑

这一节内容相比较新,有成都百货上千待定细节。希望这一节一点也不慢就没有须要讲了(因为标准会管理这几个主题素材——译者注),可是以往,这一个剧情照旧应该被提一下。

缓存过大

您不能将你网址中的全体故事情节缓存下来。对于小片段的网址以来缓存全数故事情节而不是三个主题材料,可是只要二个网址满含了上千个页面吗?很引人瞩目不是全数人对网站中的全体内容都感兴趣。存款和储蓄是有限定的,假使你将具备访谈过的页面都缓存下来的话,缓存大小会拉长额相当慢。

您能够这么制订你的缓存战术:

  • 只缓存重要的页面,比如主页,联系人页面和多年来浏览小说的页面。
  • 不用缓存任何图片,录制和大文件
  • 定期清理旧的缓存
  • 提供一个“离线阅读”按键,那样客户即可选取供给缓存哪些内容了。

只要设置退步了,未有很优雅的艺术赢得通报

假若三个worker被登记了,不过并未有出现在chrome://inspect/#service-workers或chrome://serviceworker-internals,那么很可能因为异常而安装失败了,或者是产生了一个被拒绝的的promise给event.waitUtil。

要缓慢解决这类难题,首先到 chrome://serviceworker-internals检查。打开开发者工具窗口准备调试,然后在你的install event代码中添加debugger;语句。这样,通过断点调试你更容易找到问题。

缓存刷新

演示代码中在倡议呼吁从前会先查询缓存。当客户处于离线状态时,那很好,不过假使客户处于在线状态,那她只会浏览到相比较老旧的页面。

各类能源比方图片和录像不会转移,所以一般都把那几个静态能源设置为深远缓存。那一个财富得以一向缓存一年(31,536,000秒)。在HTTP Header中,正是:

Cache-Control: max-age=31536000

1
Cache-Control: max-age=31536000

页面,CSS和本子文件大概调换的更频仍一些,所以您能够安装四个很小的缓存超时时间(24小时),并保管在客商互连网连接苏醒时再次从服务器央求:

Cache-Control: must-revalidate, max-age=86400

1
Cache-Control: must-revalidate, max-age=86400

你也得以在历次网址发表时,通过更名的秘诀强制浏览注重新央浼能源。

fetch()前段时间仅帮忙Service Workers

fetch登时补助在页面上利用了,不过当前的Chrome达成,它还只帮忙service worker。cache API也将在在页面上被协助,不过近来停止,cache也还不得不在service worker中用。

小结

迄今,相信您即便依据本文一步一步操作下来,你也得以长足把本身的Web应用转为PWA。在转为了PWA后,假如有选择满足PWA 模型的前端控件的供给,你可以尝试纯前端表格控件SpreadJS,适用于 .NET、Java 和移动端等楼台的报表控件一定不会让你失望的。

初稿链接:

1 赞 1 收藏 评论

图片 20

fetch()的暗中同意参数

当你采纳fetch,缺省级地区级,须求不会带上cookies等证据,要想带上的话,须要:

JavaScript

fetch(url, { credentials: 'include' })

1
2
3
fetch(url, {
  credentials: 'include'
})

那般设计是有理由的,它比XH途睿欧的在同源下默许发送凭据,但跨域时扬弃凭据的准则要来得好。fetch的一举一动更像另外的CO奥迪Q5S央求,比方<img crossorigin>,它默认不发送cookies,除非你指定了<img crossorigin="use-credentials">.。

Non-CO本田UR-VS默许不帮衬

暗中认可景况下,从第三方UGL450L跨域获得多个资源将会倒闭,除非对方援助了COHighlanderS。你可以增加贰个non-CO奥迪Q7S选项到Request去防止战败。代价是这么做会回来贰个“不透明”的response,意味着你无法摸清那么些央求毕竟是打响了依然败诉了。

JavaScript

cache.addAll(urlsToPrefetch.map(function(urlToPrefetch) { return new Request(urlToPrefetch, { mode: 'no-cors' }); })).then(function() { console.log('All resources have been fetched and cached.'); });

1
2
3
4
5
cache.addAll(urlsToPrefetch.map(function(urlToPrefetch) {
  return new Request(urlToPrefetch, { mode: 'no-cors' });
})).then(function() {
  console.log('All resources have been fetched and cached.');
});

fetch()不遵照30x重定向标准

噩运,重定向在fetch()中不会被触发,那是时下版本的bug;

拍卖响应式图片

img的srcset属性也许<picture>标签会根据情况从浏览器或者网络上选择最合适尺寸的图片。

在service worker中,你想要在install步骤缓存四个图形,你有以下二种选用:

  1. 设置具备的<picture>元素或者将被请求的srcset属性。
  2. 设置单一的low-res版本图片
  3. 设置单一的high-res版本图片

比较好的方案是2或3,因为只要把持有的图形都给下载下来存着有一些浪费内部存储器。

借令你将low-res版本在install的时候缓存了,然后在页面加载的时候你想要尝试从互联网上下载high-res的本子,但是要是high-res版本下载失利以来,就照旧用low-res版本。那个主张很好也值得去做,然则有叁个主题素材:

借使大家有下边三种图片:

Screen Density Width Height
1x 400 400
2x 800 800

HTML代码如下:

JavaScript

<img src="image-src.png" srcset="image-src.png 1x, image-2x.png 2x" />

1
<img src="image-src.png" srcset="image-src.png 1x, image-2x.png 2x" />

假定大家在八个2x的彰显方式下,浏览器会下载image-2x.png,如若大家离线,你能够读取从前缓存并重回image-src.png代替,假若以前它曾经被缓存过。就算如此,由于现行反革命的形式是2x,浏览器会把400X400的图样显示有200X200,要防止这几个标题将在要图片的样式上安装宽高。

JavaScript

<img src="image-src.png" srcset="image-src.png 1x, image-2x.png 2x" style="width:400px; height: 400px;" />

1
2
<img src="image-src.png" srcset="image-src.png 1x, image-2x.png 2x"
style="width:400px; height: 400px;" />

图片 21

<picture>标签情况更复杂一些,难度取决于你是如何创建和使用的,但是可以通过与srcset类似的思路去解决。

改变URL Hash的Bug

在M40版本中存在一个bug,它会让页面在转移hash的时候形成service worker结束专门的学业。

你能够在此处找到越来越多相关的音讯: 

越多内容

此间有一对荣辱与共的文书档案能够参见:

得到救助

若果你遇上麻烦,请在Stackoverflow上发帖询问,使用‘service-worker’标签,以便于大家当下跟进和尽恐怕辅助您化解难点。

赞 2 收藏 评论

图片 22

本文由9159.com发布于前端,转载请注明出处:workers标准让在Web App上拥有这些功能成为可能,原

关键词: