菜单

运用 Service worker 创制二个卓殊简单的离线页面

2019年4月17日 - Ajax

采用Service worker达成加速/离线访问静态blog网址

2017/02/19 · JavaScript
· Service Worker

初稿出处: Yang
Bo
   

最近相当流行基于Github
page和markdown的静态blog,至极适合技术的思虑和习惯,针对区别的言语都有局地特出的静态blog系统出现,如Jekyll/Ruby,Pelican/Python,Hexo/NodeJs,由于静态内容的特征万分适合做缓存来增长速度页面包车型大巴造访,就利用Service
worker
来贯彻加速,结果是除了PageSpeed,CDN那一个大规模的服务器和网络加快之外,通过客户端达成了更加好的走访体验。

选拔 Service worker 成立二个非凡轻松的离线页面

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

本文由 伯乐在线
刘健超-J.c
翻译,艾凌风
校稿。未经许可,禁止转发!
英文出处:Dean
Hume
。欢迎到场翻译组

让大家想像以下情状:大家那时候在壹辆通往农村的列车上,用运动设备望着1篇很棒的小说。与此同时,当您点击“查看越来越多”的链接时,火车忽然进入了隧道,导致移动设备失去了互连网,而
web 页面会显示出类似以下的内容:

图片 1

那是卓殊令人懊恼的感受!幸运的是,web
开垦者们能透过某个新性子来改进那类的用户体验。作者多年来直接在折腾 瑟维斯Workers,它给 web 带来的不知凡三可能性总能给本人欣喜。Service Workers
的名特别优惠特质之壹是同意你检验网络请求的光景,并让你作出相应的响应。

在那篇文章里,小编打算用此天性检查用户的脚下网络连接情状,假如没连接则赶回3个至上轻巧的离线页面。即使那是二个百般基础的案例,但它能给你带来启迪,让您通晓运维并运转该本性是何其的简要!假如你没精晓过
Service Worker,小编提出您看看此 Github
repo
,掌握越多相关的新闻。

在本案例发轫前,让我们先简单地探访它的劳作流程:

  1. 在用户第二次访问大家的页面时,大家会安装 ServiceWorker,并向浏览器的缓存增添大家的离线 HTML 页面
  2. 下一场,假诺用户打算导航到另一个 web
    页面(同一个网址下),但此刻已断网,那么大家将再次回到已被缓存的离线
    HTML 页面
  3. 只是,假使用户打算导航到其它贰个 web
    页面,而那时候网络已接连,则能照常浏览页面

增速/离线访问只需三步

JavaScript

<script> if (‘serviceWorker’ in navigator) {
navigator.serviceWorker.register(‘/sw.js’); } </script>

1
2
3
4
5
<script>
if (‘serviceWorker’ in navigator) {
navigator.serviceWorker.register(‘/sw.js’);
}
</script>

https://alphayang.github.io/sw.js保留到您的网址根目录下

在你的sw.js中修改

JavaScript

const ignoreFetch = [ /https?:\/\/cdn.bootcss.com\//,
/https?:\/\/static.duoshuo.com\//,
/https?:\/\/www.google-analytics.com\//,
/https?:\/\/dn-lbstatics.qbox.me\//, ];

1
2
3
4
5
6
const ignoreFetch = [
  /https?:\/\/cdn.bootcss.com\//,
  /https?:\/\/static.duoshuo.com\//,
  /https?:\/\/www.google-analytics.com\//,
  /https?:\/\/dn-lbstatics.qbox.me\//,
];

打开Chrome Dev Tools->Source,看看自个儿的blog都引用了怎么第壹方能源,各个加到忽略列表里。

图片 2

在根目录下增多offline.html,在未曾互联网且缓存中也未有时利用,效果如下:

图片 3

在根目录下增添offline.svg,在无网络时图片能源请求重临该公文。

让大家开头吧

假若你有以下 HTML 页面。那尽管1二分基础,但能给你完全思路。

XHTML

<!DOCTYPE html>

1
<!DOCTYPE html>

随之,让大家在页面里登记 瑟维斯 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>

然后,大家需求创建 瑟维斯 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
时,向缓存增加了离线页面。假诺大家将代码分为几小块,可看出前几行代码中,笔者为离线页面钦命了缓存版本和UOdysseyL。借使你的缓存有例外版本,那么您只需立异版本号即可简单地解除缓存。在大致在第三2行代码,我向那一个离线页面及其财富(如:图片)发出请求。在获得成功的响应后,我们将离线页面和血脉相通财富丰硕到缓存。

到现在,离线页面已存进缓存了,大家可在急需的时等候检查索它。在同3个 ServiceWorker 中,大家要求对无互联网时再次来到的离线页面增加相应的逻辑代码。

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 访问互联网)

图片 4

假设您刷新页面,你应该能观察相应的离线页面!

图片 5

假如您只想大约地质衡量试该效用而不想写任何代码,那么你能够访问笔者已开立好的
demo。此外,上述任何代码能够在
Github repo 找到。

自家明白用在此案例中的页面很不难,但你的离线页面则取决于你自身!要是您想长远该案例的始末,你可感到离线页面增添缓存破坏(
cache busting),如:
此案例

加快效果

首页加速后,网络请求从1陆降为1,加载时间从二.2九6s降为0.65肆s,获得了须臾间加载的结果。

图片 6

基于webpagetest

查看测试结果

进展阅读

另外,还有多少个很棒的离线功效案例。如:Guardian 构建了三个具有 crossword
puzzle
(填字游戏)的离线
web 页面 –
因而,即便等待互联网重连时(即已在离线状态下),也能找到一点乐趣。作者也推荐看看
Google Chrome Github
repo
,它包涵了许多见仁见智的
瑟维斯 Worker 案例 – 其中1部分施用案例也在那!

不过,即使您想跳过上述代码,只是想大致地通过三个库来拍卖相关操作,那么小编引入您看看
UpUp。那是1个轻量的脚本,能让你更轻便地接纳离线成效。

打赏扶助笔者翻译越来越多好小说,谢谢!


打赏译者

加快/离线原理查究

打赏帮衬笔者翻译越来越多好小说,感谢!

任选一种支付办法

图片 7
图片 8

1 赞 3 收藏 1
评论

什么是 Service worker

图片 9

如上图,Service
worker

是一种由Javascript编写的浏览器端代理脚本,位于你的浏览器和服务器之间。当2个页面注册了贰个
Service
worker
,它就能够登记一名目多数事件处理器来响应如网络请求和信息推送这几个事件。Service
worker

能够被用来管理缓存,当响应一个网络请求时方可陈设为回到缓存照旧从互联网得到。由于Service
worker

是依照事件的,所以它只在拍卖那么些事件的时候被调入内部存款和储蓄器,不用顾忌常驻内部存储器占用能源导致系统变慢。

有关小编:刘健超-J.c

图片 10

前端,在路上…http://jchehe.github.io
个人主页
·
作者的篇章
·
19
·
    

图片 11

Service worker生命周期

图片 12

Service
worker

为网页增多二个像样于APP的生命周期,它只会响应系统事件,固然浏览器关闭时操作系统也足以唤起Service
worker
,那点越发重要,让web
app与native app的工夫变得近乎了。

Service
worker
在Register时会触发Install事件,在Install时能够用来预先获取和缓存应用所需的财富并设置每一个文件的缓存计策。

一旦Service
worker
处在activated状态,就足以完全调节应用的财富,对互连网请求举办反省,修改互连网请求,从网络上收获并回到内容大概重回由已设置的Service
worker
预示获取并缓存好的能源,甚至还足以扭转内容并再次来到给互联网语法。

有着的那么些都用户都是晶莹的,事实上,一个规划精良的Service
worker
就好像二个智能缓存系统,加强了互连网和缓存效率,采纳最优办法来响应网络请求,让动用越来越平静的运作,尽管未有互联网也没涉及,因为您能够完全调控互连网响应。

Service worker的主宰从第3遍页面访问早先

在第壹遍加载页面时,全部财富都以从网络载的,Service
worker

在第3遍加载时不会获得调节网络响应,它只会在此起彼伏访问页面时起成效。

图片 13

页面第2遍加载时做到install,并跻身idle状态。

图片 14

页面第2遍加载时,进入activated状态,准备处理全体的事件,同时
浏览器会向服务器发送二个异步 请求来检查Service
worker
本身是还是不是有新的版本,构成了Service
worker
的更新机制。

图片 15

Service
worker
处理完全数的风浪后,进入idle状态,最后进入terminated状态能源被放出,当有新的事件产生时再一次被调用。

特点

谷歌(Google) Chrome,Firefox,Opera以及境内的各类双核浏览器都协理,但是 safari
不帮忙,那么在不帮忙的浏览器里Service
worker
不工作。

网址必须启用https来保险使用Service
worker
页面包车型大巴安全性,开采时localhost暗中同意以为是高枕而卧的。

Service
worker

中的 Javascript 代码必须是非阻塞的,因为 localStorage
是阻塞性,所以不应当在 瑟维斯 Worker 代码中运用 localStorage。

Service
worker
运作在祥和的大局环境中,平日也运营在和谐独立的线程中。

service work能操纵它所加载的满贯范围内的财富。

跟DOM所处的环境是互相隔断的。

图片 16

接纳系统事件,后台运营

按需施行,只在须求时加载到内存

实行时会异步获取最新的版本

福如东海加快/离线

Cache

网页缓存有那一个,如HTTP缓存,localStorage,sessionStorage和cacheStorage都得以灵活搭配举行缓存,但操作太繁琐,直接动用更加尖端Service
worker

–本文的东道主。

添加Service worker入口

在web app的首页增加以下代码

JavaScript

<script> if (‘serviceWorker’ in navigator) {
navigator.serviceWorker.register(‘/sw.js’); } </script>

1
2
3
4
5
<script>
if (‘serviceWorker’ in navigator) {
navigator.serviceWorker.register(‘/sw.js’);
}
</script>

比方浏览器援救serviceWorker就登记它,不协理照旧好端端浏览,未有Service
worker
所提供的加强功能。

Service worker调节范围:
粗略景况下,将sw.js身处网址的根目录下,那样Service
worker
能够操纵网址有着的页面,,同理,假若把sw.js放在/my-app/sw.js那正是说它只可以调整my-app目录下的页面。
sw.js放在/js/目录呢?越来越好的目录结构和限量调整呢?
在注册时钦定js地方并设置限制。

JavaScript

navigator.serviceWorker.register(‘/js/sw.js’, {scope:
‘/sw-test/’}).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
navigator.serviceWorker.register(‘/js/sw.js’, {scope: ‘/sw-test/’}).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实现

监听八个事件:

JavaScript

self.addEventListener(‘install’, onInstall);
self.addEventListener(‘fetch’, onFetch);
self.addEventListener(“activate”, onActivate);

1
2
3
self.addEventListener(‘install’, onInstall);
self.addEventListener(‘fetch’, onFetch);
self.addEventListener("activate", onActivate);

install

JavaScript

////////// // Install ////////// function onInstall(event) {
log(‘install event in progress.’); event.waitUntil(updateStaticCache());
} function updateStaticCache() { return caches
.open(cacheKey(‘offline’)) .then((cache) => { return
cache.addAll(offlineResources); }) .then(() => { log(‘installation
complete!’); }); }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
//////////
// Install
//////////
function onInstall(event) {
  log(‘install event in progress.’);
  event.waitUntil(updateStaticCache());
}
function updateStaticCache() {
  return caches
    .open(cacheKey(‘offline’))
    .then((cache) => {
      return cache.addAll(offlineResources);
    })
    .then(() => {
      log(‘installation complete!’);
    });
}

install时将有着符合缓存战术的财富拓展缓存。

fetch

JavaScript

//////// // Fetch //////// function onFetch(event) { const request =
event.request; if (shouldAlwaysFetch(request)) {
event.respondWith(networkedOrOffline(request)); return; } if
(shouldFetchAndCache(request)) {
event.respondWith(networkedOrCached(request)); return; }
event.respondWith(cachedOrNetworked(request)); }
onFetch做为浏览器互联网请求的代理,依照须要再次回到互连网或缓存内容,如果获得了网络内容,重临网络请求时还要拓展缓存操作。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
////////
// Fetch
////////
function onFetch(event) {
  const request = event.request;
  if (shouldAlwaysFetch(request)) {
    event.respondWith(networkedOrOffline(request));
    return;
  }
  if (shouldFetchAndCache(request)) {
    event.respondWith(networkedOrCached(request));
    return;
  }
  event.respondWith(cachedOrNetworked(request));
}
onFetch做为浏览器网络请求的代理,根据需要返回网络或缓存内容,如果获取了网络内容,返回网络请求时同时进行缓存操作。

activate

JavaScript

/////////// // Activate /////////// function onActivate(event) {
log(‘activate event in progress.’); event.waitUntil(removeOldCache()); }
function removeOldCache() { return caches .keys() .then((keys) => {
return Promise.all( // We return a promise that settles when all
outdated caches are deleted. keys .filter((key) => { return
!key.startsWith(version); // Filter by keys that don’t start with the
latest version prefix. }) .map((key) => { return caches.delete(key);
// Return a promise that’s fulfilled when each outdated cache is
deleted. }) ); }) .then(() => { log(‘removeOldCache completed.’); });
}

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
///////////
// Activate
///////////
function onActivate(event) {
  log(‘activate event in progress.’);
  event.waitUntil(removeOldCache());
}
function removeOldCache() {
  return caches
    .keys()
    .then((keys) => {
      return Promise.all( // We return a promise that settles when all outdated caches are deleted.
        keys
         .filter((key) => {
           return !key.startsWith(version); // Filter by keys that don’t start with the latest version prefix.
         })
         .map((key) => {
           return caches.delete(key); // Return a promise that’s fulfilled when each outdated cache is deleted.
         })
      );
    })
    .then(() => {
      log(‘removeOldCache completed.’);
    });
}

在activate时依据version值来删除过期的缓存。

管理 Service worker

一定网址

  1. Google Chrome

Developer Tools->Application->Service Workers

图片 17

在那边还有多少个尤其有效的复选框:

依样葫芦断网状态

  1. Firefox

唯有在Settings里有3个方可在HTTP环境中接纳Service
worker
的选项,适应于调试,未有单独网址下的Service
worker
管理。

图片 18

  1. Opera及任何双核浏览器同谷歌(Google) Chrome
    设若见到五个同样范围内的多个Service
    worker
    ,说明Service
    woker
    更新后,而原有Service
    worker
    还尚未被terminated。

浏览器全局

探望你的浏览器里都有啥Service worker已经存在了

  1. Google Chrome

在地址栏里输入:

JavaScript

chrome://serviceworker-internals/

1
chrome://serviceworker-internals/

可以看看曾经有二四个Serviceworker了,在此地能够手动Start让它职业,也能够Unregister卸载掉。

图片 19

  1. Firefox

有三种办法进入Service
worker
治本分界面来手动Start或unregister。

JavaScript

about:debugging#workers

1
about:debugging#workers

图片 20

  1. Opera及其他双核浏览器同谷歌 Chrome

更多

TODO:

Ref links

Service Worker Cookbook

Is service worker
ready?

Chrome service worker status
page

Firefox service worker status
page

MS Edge service worker status
page

WebKit service worker status
page

1 赞 2 收藏
评论

图片 21

相关文章

发表评论

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

网站地图xml地图