创制一个分外不难的离线页面,离线网页应用

by admin on 2019年2月1日

动用 Service Worker 做一个 PWA 离线网页应用

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

初稿出处:
创制一个分外不难的离线页面,离线网页应用。人人网FED博客   

在上一篇《自己是何许让网站用上HTML5
Manifest》介绍了怎么用Manifest做一个离线网页应用,结果被大面积网友吐槽说这么些事物已经被deprecated,移出web标准了,现在被ServiceWorker替代了,不管什么,Manifest的一对思想依旧得以借用的。小编又将网站升级到了ServiceWorker,倘使是用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 页面会突显出类似以下的情节:

必发88 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 APP的通病:

(1)没有桌面入口

(2)无法离线使用

(3)没有Push推送

那Service Worker的具体表现是什么的吗?如下图所示:

必发88 2

ServiceWorker是在后台启动的一条服务Worker线程,上图我开了多个标签页,所以突显了四个Client,可是不管开多少个页面都只有一个Worker在负责管理。这一个Worker的办事是把有些资源缓存起来,然后拦截页面的请求,先看下缓存库里有没有,如果局地话就从缓存里取,响应200,反之没有的话就走正常的呼吁。具体来说,ServiceWorker结合Web App Manifest能成功以下工作(那也是PWA的检测专业):

必发88 3

包罗可以离线使用、断网时回来200、能唤起用户把网站添加一个图标到桌面上等。

第一步:使用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
时,向缓存添加了离线页面。假使咱们将代码分为几小块,可看到前几行代码中,我为离线页面指定了缓存版本和URL。借使您的缓存有例外版本,那么你只需创新版本号即可不难地清除缓存。在大约在第
12
行代码,我向那个离线页面及其资源(如:图片)发出请求。在收获成功的响应后,大家将离线页面和血脉相通资源丰裕到缓存。

现今,离线页面已存进缓存了,我们可在急需的时候检索它。在同一个 瑟维斯Worker 中,大家需求对无互连网时重回的离线页面添加相应的逻辑代码。

JavaScript

this.add伊夫ntListener(‘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 访问互联网)

必发88 4

比方你刷新页面,你应有能看到相应的离线页面!

必发88 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帮衬:

必发88 6

Safari和Edge也在备选扶助Service Worker,由于ServiceWorker是谷歌(谷歌(Google))中央的一项正式,对于生态相比封闭的Safari来说也是迫于时局初步准备协助了,在Safari
TP版本,可以看来:

必发88 7

在尝试成效(Experimental Features)里早已有ServiceWorker的菜单项了,只是固然打开也是不可能用,会唤醒您还未曾完成:

必发88 8

但不管什么,至少讲明Safari已经准备协助ServiceWorker了。其余还足以看到在当年二〇一七年10月宣布的Safari
11.0.1版本已经支撑WebRTC了,所以Safari依旧一个发展的孩子。

Edge也准备协助,所以Service Worker的前景格外美好。

其次步:创建一个应用程序清单(Manifest)

应用程序清单提供了和当前渐进式Web应用的连带音信,如:

  • 应用程序名
  • 描述
  • 具备图片(包括主显示屏图标,启动屏幕页面和用的图纸或者网页上用的图形)

本质上讲,程序清单是页面上用到的图标和大旨等资源的元数据。

程序清单是一个放在您使用根目录的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” :
“72×72”, “type” : “image/png” }, { “src” : “/images/logo/logo152.png”,
“sizes” : “152×152”, “type” : “image/png” }, { “src” :
“/images/logo/logo192.png”, “sizes” : “192×192”, “type” : “image/png” },
{ “src” : “/images/logo/logo256.png”, “sizes” : “256×256”, “type” :
“image/png” }, { “src” : “/images/logo/logo512.png”, “sizes” :
“512×512”, “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"         : "72×72",
      "type"          : "image/png"
    },
    {
      "src"           : "/images/logo/logo152.png",
      "sizes"         : "152×152",
      "type"          : "image/png"
    },
    {
      "src"           : "/images/logo/logo192.png",
      "sizes"         : "192×192",
      "type"          : "image/png"
    },
    {
      "src"           : "/images/logo/logo256.png",
      "sizes"         : "256×256",
      "type"          : "image/png"
    },
    {
      "src"           : "/images/logo/logo512.png",
      "sizes"         : "512×512",
      "type"          : "image/png"
    }
  ]
}

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

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

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

以下属性在程序清单中不时选拔,介绍说明如下:

  • name: 用户阅览的行使名称
  • short_创制一个分外不难的离线页面,离线网页应用。name: 应用短名称。当突显应用名称的地方不够时,将接纳该名称。
  • description: 选择描述。
  • start_url: 行使开首路径,相对路径,默许为/。
  • scope: URL范围。比如:假如您将“/app/”设置为URL范围时,那一个动用就会直接在这么些目录中。
  • background_color: 欢迎页面的背景颜色和浏览器的背景颜色(可选)
  • theme_color: 应用的主旨颜色,一般都会和背景颜色相同。这一个装置决定了使用如何显示。
  • orientation: 预先旋转方向,可选的值有:any, natural, landscape,
    landscape-primary, landscape-secondary, portrait, portrait-primary,
    and portrait-secondary
  • 必发88,display: 突显方式——fullscreen(无Chrome),standalone(和原生应用相同),minimal-ui(最小的一套UI控件集)或者browser(最古老的运用浏览器标签突显)
  • icons: 一个富含所有图片的数组。该数组中每个元素包括了图片的URL,大小和种类。

进行阅读

其余,还有多少个很棒的离线功能案例。如:Guardian 创设了一个独具 crossword
puzzle(填字游戏)的离线
web 页面 –
由此,即使等待互联网重连时(即已在离线状态下),也能找到一点乐趣。我也援引看看
Google Chrome Github
repo,它含有了广大两样的
Service 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初次安装的生命周期:

必发88 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。

打赏接济我翻译越来越多好小说,谢谢!

任选一种支付办法

必发88 10
必发88 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文件就是瑟维斯Worker的运转环境,若是不可以得逞注册的话就会抛格外,如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. 一个离线的页面地址(offlineURL):当用户访问了前边并未访问过的地方时,该页面将会展现。
  3. 一个涵盖了颇具必须文件的数组,包涵保持页面正常功效的CSS和JavaScript。在本示例中,我还添加了主页和logo。当有例外的URL指向同一个资源时,你也可以将这一个URL分别写到那么些数组中。offlineURL将会加盟到这几个数组中。
  4. 咱俩也可以将一些非要求的缓存文件(installFilesDesirable)。那么些文件在设置进程旅长会被下载,但借使下载失利,不会接触安装败北。

// 配置文件 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’ ];

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

必发88 12

前端,在路上…
个人主页 ·
我的篇章 ·
19 ·
    

必发88 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控制台所示:

必发88 14

ServiceWorker的API基本上都是回到Promise对象幸免堵塞,所以要用Promise的写法。上面在安装ServiceWorker的时候就把首页的伸手给缓存起来了。在ServiceWorker的运作条件之中它有一个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文件。其他请求将会重返offlineURL 页面。

Chrome开发者工具中的瑟维斯Worker部分提供了关于当前页面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是否对你的网站启用了。

必发88 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,假如跨域的资源支撑CORS,那么可以把request的mod改成cors。假诺请求退步了,如404或者是过期等等的,那么也直接重临response让主页面处理,否则的话表明加载成功,把那个response克隆一个松开cache里面,然后再重回response给主页面线程。注意能舒缓存里的资源一般只好是GET,通过POST获取的是不可能缓存的,所以要做个判断(当然你也得以手动把request对象的method改成get),还有把有些个体不指望缓存的资源也做个判断。

如此那般如若用户打开过四回页面,瑟维斯Worker就安装好了,他刷新页面或者打开第一个页面的时候就可以把请求的资源一一做缓存,包蕴图片、CSS、JS等,只要缓存里有了不管用户在线或者离线都可以健康访问。那样大家当然会有一个标题,那几个缓存空间到底有多大?上一篇大家提到Manifest也终于地方存储,PC端的Chrome是5Mb,其实那么些说法在新本子的Chrome已经不标准了,在Chrome
61版本可以看来当地存储的半空中和接纳情状:

必发88 16

其间Cache Storage是指ServiceWorker和Manifest占用的空中大小和,上图可以看来总的空间尺寸是20GB,大约是unlimited,所以基本上不用担心缓存会不够用。

第四步:制造可用的离线页面

离线页面可以是静态的HTML,一般用来提示用户眼前恳请的页面暂时不可能使用。但是,我们可以提供一些得以翻阅的页面链接。

Cache
API可以在main.js中动用。然则,该API使用Promise,在不扶助Promise的浏览器中会失利,所有的JavaScript执行会就此遭到震慑。为了幸免那种情况,在拜访/js/offlinepage.js的时候大家添加了一段代码来检查当前是不是在离线环境中:

/js/offlinepage.js 中以版本号为名称保存了近年的缓存,获取具有URL,删除不是页面的URL,将那个URL排序然后将拥有缓存的URL显示在页面上:

// 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。那咋办吧?谷歌的开发者文档它只是提到会存在那一个题材,但并没有阐明怎么化解这几个标题。这些的标题标缓解就要求大家要有一个编制能知道html更新了,从而把缓存里的html给替换掉。

Manifest更新缓存的体制是去看Manifest的文件内容有没有暴发变化,纵然暴发变化了,则会去革新缓存,ServiceWorker也是基于sw.js的文本内容有没有暴发变化,大家得以借鉴这一个考虑,若是请求的是html并从缓存里取出来后,再发个请求获取一个文本看html更新时间是否发生变化,借使暴发变化了则印证爆发转移了,进而把缓存给删了。所以可以在服务端通过操纵那几个文件从而去创新客户端的缓存。如下代码:

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 URL(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); pageUpdate提姆e[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: []}}

个中首要有一个update提姆e的字段,若是当地内存没有这么些页面的update提姆e的数码照旧是和最新update提姆e分歧,则再一次去取得
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缓存,要是三者都用上了会怎么样啊?

会以Service Worker为事先,因为ServiceWorker把请求拦截了,它起首做拍卖,借使它缓存库里部分话向来回到,没有的话正常请求,就约等于尚未ServiceWorker了,那几个时候就到了Manifest层,Manifest缓存里如若部分话就取那么些缓存,如若没有的话就相当于尚未Manifest了,于是就会从Http缓存里取了,要是Http缓存里也绝非就会发请求去取得,服务端按照Http的etag或者Modified
提姆e可能会回去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名称等新闻以便在桌面添加一个图标,以及创立一种打开那几个网页就像是打开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”: “48×48” }, { “src”:
“/html/app-manifest/logo_96.png”, “type”: “image/png”, “sizes”: “96×96”
}, { “src”: “/html/app-manifest/logo_192.png”, “type”: “image/png”,
“sizes”: “192×192” }, { “src”: “/html/app-manifest/logo_512.png”,
“type”: “image/png”, “sizes”: “512×512” } ], “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": "48×48"
    },
    {
      "src": "/html/app-manifest/logo_96.png",
      "type": "image/png",
      "sizes": "96×96"
    },
    {
      "src": "/html/app-manifest/logo_192.png",
      "type": "image/png",
      "sizes": "192×192"
    },
    {
      "src": "/html/app-manifest/logo_512.png",
      "type": "image/png",
      "sizes": "512×512"
    }
  ],
  "start_url": "/?launcher=true",
  "display": "standalone",
  "background_color": "#287fc5",
  "theme_color": "#fff"
}

icon要求准备各类准绳,最大须要512px *
512px的,那样Chrome会自动去选拔合适的图样。就算把display改成standalone,从变化的图标打开就会像打开一个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缓存:
必发88 17把start_url指向的页面用ServiceWorker缓存起来,那样当用户用Chrome浏览器打开那个网页的时候,Chrome就会在尾部弹一个提醒,询问用户是或不是把这些网页添加到桌面,假如点“添加”就会变动一个桌面图标,从这一个图标点进去如同打开一个App一样。感受如下:

必发88 18

正如为难的是Manifest近来唯有Chrome帮助,并且只可以在安卓系统上应用,IOS的浏览器不能添加一个桌面图标,因为IOS没有开放那种API,但是我的Safari却又是可以的。

综上,本文介绍了怎么用Service Worker结合Manifest做一个PWA离线Web
APP,重如果用ServiceWorker控制缓存,由于是写JS,相比灵敏,还足以与页面举办通讯,其它通过请求页面的更新时间来判定是还是不是必要革新html缓存。ServiceWorker的包容性不是特意好,可是前景相比光明,浏览器都在准备辅助。现阶段可以构成offline
cache的Manifest做离线应用。

连锁阅读:

  1. 何以要把网站升级到HTTPS
  2. 什么样把网站升级到http/2
  3. 我是何许让网站用上HTML5
    Manifest

1 赞 1 收藏
评论

必发88 19

URL隐藏

当你的运用就是一个单URL的应用程序时(比如游戏),我提出你隐藏地址栏。除此之外的情况我并不指出你隐藏地址栏。在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 收藏
评论

必发88 20

fetch()的默许参数

当您使用fetch,缺省地,请求不会带上cookies等证据,要想带上的话,需求:

JavaScript

fetch(url, { credentials: ‘include’ })

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

如此设计是有理由的,它比XHR的在同源下默许发送凭据,但跨域时甩掉凭据的平整要来得好。fetch的一举一动更像任何的CORS请求,例如<img crossorigin>,它默认不发送cookies,除非你指定了<img crossorigin="use-credentials">.。

Non-CORS默许不接济

默许情形下,从第三方URL跨域获得一个资源将会失利,除非对方协理了CORS。你能够添加一个non-CORS选项到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;" />

必发88 21

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

改变URL Hash的Bug

在M40版本中设有一个bug,它会让页面在变更hash的时候造成service
worker停止工作。

你可以在此处找到越来越多相关的新闻: 

更加多内容

此间有一对有关的文档可以参考:

取得扶持

假使您遇见麻烦,请在Stackoverflow上发帖询问,使用‘service-worker’标签,以便于大家马上跟进和尽可能帮忙您解决难题。

赞 2 收藏
评论

必发88 22

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图