菜单

运用 Service worker 创设三个十分不难的离线页面

2019年4月8日 - jQuery

使用Service worker完毕加速/离线访问静态blog网址

2017/02/19 · JavaScript
· Service Worker

初稿出处: Yang
Bo
   

近期非常流行基于Github
page和markdown的静态blog,相当适合技术的思虑和习惯,针对区别的语言都有1对优良的静态blog系统出现,如Jekyll/Ruby,Pelican/Python,Hexo/NodeJs,由于静态内容的特色格外适合做缓存来增长速度页面包车型大巴访问,就选取Service
worker
来完毕加速,结果是除了PageSpeed,CDN那些相近的服务器和网络加快之外,通过客户端实现了越来越好的拜会体验。

运用 Service worker 成立1个10分简单的离线页面

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

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

让大家想像以下场景:我们那时候在一辆通往农村的火车上,用运动装备望着一篇很棒的篇章。与此同时,当你点击“查看更多”的链接时,火车忽然进入了隧道,导致运动装备失去了网络,而
web 页面会呈现出类似以下的情节:

图片 1

那是一定令人心寒的体会!幸运的是,web
开发者们能因此一些新特色来革新那类的用户体验。我近期直接在折腾 ServiceWorkers,它给 web 带来的无尽恐怕性总能给自身惊喜。Service Workers
的卓绝特质之1是允许你检查实验互连网请求的风貌,并让您作出相应的响应。

在那篇小说里,笔者打算用此性格检查用户的此时此刻网络连接境况,倘诺没连接则赶回二个一级不难的离线页面。就算那是三个不胜基础的案例,但它能给您带来启发,让你理解运行并运营该天性是多么的简练!借使你没掌握过
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都引用了什么样第1方财富,每一种加到忽略列表里。

图片 2

在根目录下添加offline.html,在未曾网络且缓存中也不曾时采取,效果如下:

图片 3

在根目录下添加offline.svg,在无互连网时图片能源请求重临该文件。

让大家起首吧

一经你有以下 HTML 页面。那尽管13分基础,但能给您完整思路。

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。假如你的缓存有两样版本,那么您只需立异版本号即可简单地铲除缓存。在大致在第2贰行代码,笔者向这么些离线页面及其能源(如:图片)发出请求。在获取成功的响应后,大家将离线页面和血脉相通资源丰盛到缓存。

今昔,离线页面已存进缓存了,大家可在急需的时等候检查索它。在同1个 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
内置的开发者工具。首先,导航到你的页面,然后1旦设置上了 ServiceWorker,就打开 Network 标签并将节流(throttling)改为
Offline。(译者注:若将节流设置为 Offline
没意义,则可经过关闭网络或许通过360鹤岗警卫禁止 Chrome 访问互联网)

图片 4

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

图片 5

只要您只想大致地质衡量试该成效而不想写任何代码,那么您能够访问小编已创设好的
demo。此外,上述任何代码能够在
Github repo 找到。

本人清楚用在此案例中的页面很简短,但您的离线页面则在于你协调!要是你想深切该案例的内容,你能够为离线页面添加缓存破坏(
cache busting),如:
此案例

增加速度效果

首页加快后,网络请求从1六降为1,加载时间从二.2玖6s降为0.65四s,获得了一晃加载的结果。

图片 6

基于webpagetest

查看测试结果

举行阅读

别的,还有多少个很棒的离线功用案例。如:Guardian 营造了八个持有 crossword
puzzle
(填字游戏)的离线
web 页面 –
因而,即便等待网络重连时(即已在离线状态下),也能找到一点乐趣。作者也引进看看
Google Chrome Github
repo
,它蕴涵了众多两样的
瑟维斯 Worker 案例 – 当中有的采纳案例也在那!

唯独,要是你想跳过上述代码,只是想大约地经过2个库来拍卖相关操作,那么本身推荐你看看
UpUp。那是3个轻量的脚本,能让你更轻松地采纳离线功用。

打赏协助小编翻译越多好小说,多谢!


打赏译者

加快/离线原理探索

打赏援救笔者翻译更加多好作品,多谢!

任选1种支付办法

图片 7
图片 8

1 赞 3 收藏 1
评论

什么是 Service worker

图片 9

如上图,Service
worker

是一种由Javascript编写的浏览器端代理脚本,位于你的浏览器和服务器之间。当二个页面注册了3个
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
预报获取并缓存好的财富,甚至仍是能够转变内容并赶回给互联网语法。

负有的那几个都用户都以晶莹的,事实上,1个统一筹划精美的Service
worker
就如1个智能缓存系统,抓实了网络和缓存功效,选拔最优办法来响应互联网请求,让动用越来越平稳的周转,尽管未有互联网也没涉及,因为你可以完全控制网络响应。

Service worker的操纵从第三回页面访问先导

在第1遍加载页面时,全部资源都以从互联网载的,Service
worker

在第一回加载时不会博得控制网络响应,它只会在三番八回访问页面时起成效。

图片 13

页面第三遍加载时成功install,并跻身idle状态。

图片 14

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

图片 15

Service
worker
处理完全体的轩然大波后,进入idle状态,最后进入terminated状态能源被假释,当有新的风云发生时再度被调用。

特点

谷歌 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

在此地还有七个要命实用的复选框:

宪章断网状态

  1. Firefox

只有在Settings里有一个可以在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/

能够看到曾经有23个瑟维斯worker了,在那里能够手动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地图