菜单

运用 Service worker 创制三个分外不难的离线页面

2019年4月2日 - Bootstrap

采纳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 创立1个分外不难的离线页面

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

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

让我们想像以下场景:大家那儿在1辆通往农村的高铁上,用移动装备瞧着壹篇很棒的篇章。与此同时,当你点击“查看越来越多”的链接时,火车忽然进入了隧道,导致运动装备失去了网络,而
web 页面会显示出类似以下的剧情:

图片 1

那是1二分令人懊恼的感受!幸运的是,web
开发者们能经过一些新特点来改良那类的用户体验。作者近期直接在折腾 ServiceWorkers,它给 web 带来的无尽或者性总能给本人惊喜。Service Workers
的脍炙人口特质之1是允许你检查测试互连网请求的景观,并让您作出相应的响应。

在那篇小说里,作者打算用此天性检查用户的脚下网络连接处境,尽管没连接则赶回一个特级不难的离线页面。固然这是二个12分基础的案例,但它能给你带来启迪,让您通晓运行并运转该本性是何其的不难!假若你没领会过
Service Worker,笔者提出您看看此 Github
repo
,精通越多相关的新闻。

在本案例初阶前,让大家先简单地探访它的劳作流程:

  1. 在用户第一遍访问大家的页面时,大家会安装 ServiceWorker,并向浏览器的缓存添加我们的离线 HTML 页面
  2. 下一场,假使用户打算导航到另一个 web
    页面(同2个网址下),但此刻已断网,那么大家将赶回已被缓存的离线
    HTML 页面
  3. 可是,尽管用户打算导航到其余1个 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 页面。那固然万分基础,但能给你完全思路。

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本田CR-VL。假若你的缓存有例外版本,那么您只需立异版本号即可简单地解除缓存。在大致在第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六降为一,加载时间从2.2九6s降为0.65四s,获得了弹指间加载的结果。

图片 6

基于webpagetest

查看测试结果

拓展阅读

除此以外,还有几个很棒的离线功效案例。如:Guardian 营造了1个负有 crossword
puzzle
(填字游戏)的离线
web 页面 –
因而,固然等待互连网重连时(即已在离线状态下),也能找到一点乐趣。作者也引进看看
Google Chrome Github
repo
,它包括了众多两样的
Service Worker 案例 – 当中有个别行使案例也在那!

唯独,假使您想跳过上述代码,只是想差不离地经过2个库来处理有关操作,那么小编引进您看看
UpUp。那是多个轻量的本子,能让您更自在地选拔离线功用。

打赏接济自个儿翻译更多好小说,多谢!


打赏译者

加速/离线原理探索

打赏支持本身翻译越来越多好小说,感谢!

任选1种支付办法

图片 7
图片 8

1 赞 3 收藏 1
评论

什么是 Service worker

图片 9

如上图,Service
worker

是1种由Javascript编写的浏览器端代理脚本,位于你的浏览器和服务器之间。当3个页面注册了三个
Service
worker
,它就足以登记一文山会海事件处理器来响应如网络请求和新闻推送这几个事件。Service
worker

能够被用来治本缓存,当响应3个互联网请求时能够布署为回到缓存照旧从互联网获得。由于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
预示获取并缓存好的能源,甚至还能变动内容并赶回给网络语法。

具有的这个都用户皆以晶莹的,事实上,3个统一筹划精美的Service
worker
就像是三个智能缓存系统,抓好了网络和缓存作用,选取最优办法来响应网络请求,让使用越发安宁的运维,固然未有网络也没提到,因为你能够完全控制网络响应。

Service worker的控制从第三遍页面访问初始

在首次加载页面时,全数能源都以从网络载的,Service
worker

在第三遍加载时不会博得控制互连网响应,它只会在持续访问页面时起功效。

图片 13

页面第3回加载时形成install,并跻身idle状态。

图片 14

页面第三回加载时,进入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
是阻塞性,所以不应该在 Service 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

在此地还有四个11分实惠的复选框:

宪章断网状态

  1. Firefox

除非在Settings里有二个得以在HTTP环境中应用Service
worker
的选项,适应于调节和测试,未有单独网址下的Service
worker
管理。

图片 18

  1. Opera及别的双核浏览器同谷歌 Chrome
    假若见到四个壹样范围内的多少个Service
    worker
    ,说明Service
    woker
    更新后,而原有Service
    worker
    还不曾被terminated。

浏览器全局

探访你的浏览器里都有哪些Service worker已经存在了

  1. Google Chrome

在地址栏里输入:

JavaScript

chrome://serviceworker-internals/

1
chrome://serviceworker-internals/

能够见到曾经有22个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地图