菜单

采取 Service worker 创立二个分外简单的离线页面

2019年4月5日 - JavaScript

动用瑟维斯 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那个大规模的服务器和互联网加快之外,通过客户端达成了更加好的造访体验。

采纳 瑟维斯 worker 创造贰个格外简单的离线页面

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

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

让我们想像以下情形:大家这儿在1辆通往农村的列车上,用移动设备瞅着1篇很棒的作品。与此同时,当您点击“查看更加多”的链接时,轻轨忽然进入了隧道,导致移动装备失去了网络,而
web 页面会彰显出类似以下的剧情:

图片 1

那是十分令人悲伤的感受!幸运的是,web
开发者们能透过某些新特色来改革那类的用户体验。小编近年来直接在折腾 ServiceWorkers,它给 web 带来的无尽只怕性总能给自个儿惊喜。Service Workers
的美观特质之1是允许你检查评定网络请求的场景,并让您作出相应的响应。

在那篇小说里,作者打算用此个性检查用户的脚下网络连接境况,要是没连接则赶回多少个一级简单的离线页面。就算那是2个卓绝基础的案例,但它能给您带来启迪,让您驾驭运行并运转该天性是何其的简单!假诺您没了然过
Service Worker,作者提出您看看此 Github
repo
,通晓更加多相关的新闻。

在本案例初始前,让我们先简单地探访它的干活流程:

  1. 在用户第2回访问大家的页面时,我们会安装 ServiceWorker,并向浏览器的缓存添加我们的离线 HTML 页面
  2. 下一场,借使用户打算导航到另2个 web
    页面(同1个网址下),但此刻已断网,那么大家将回来已被缓存的离线
    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 页面。那即便10分基础,但能给你完整思路。

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(‘瑟维斯Worker
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。假如你的缓存有例外版本,那么您只需立异版本号即可简单地消除缓存。在大概在第一贰行代码,笔者向那几个离线页面及其能源(如:图片)发出请求。在获得成功的响应后,大家将离线页面和有关财富丰富到缓存。

今昔,离线页面已存进缓存了,大家可在急需的时等候检查索它。在同一个 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),如:
此案例

加紧效果

首页加快后,互连网请求从16降为一,加载时间从二.29六s降为0.65四s,获得了瞬间加载的结果。

图片 6

基于webpagetest

查看测试结果

拓展阅读

其它,还有多少个很棒的离线成效案例。如:Guardian 创设了2个颇具 crossword
puzzle
(填字游戏)的离线
web 页面 –
因而,就算等待网络重连时(即已在离线状态下),也能找到一点乐趣。小编也引入看看
Google Chrome Github
repo
,它含有了不少例外的
Service Worker 案例 – 当中有的采纳案例也在那!

不过,假如您想跳过上述代码,只是想大概地经过2个库来处理有关操作,那么小编推荐你看看
UpUp。那是二个轻量的本子,能让您更自在地使用离线作用。

打赏协助本身翻译越多好文章,多谢!


打赏译者

加紧/离线原理探索

打赏援助自个儿翻译越来越多好小说,感谢!

任选1种支付格局

图片 7
图片 8

1 赞 3 收藏 1
评论

什么是 Service worker

图片 9

如上图,Service
worker

是一种由Javascript编写的浏览器端代理脚本,位于你的浏览器和服务器之间。当一个页面注册了三个
Service
worker
,它就足以挂号一名目繁多事件处理器来响应如互连网请求和新闻推送那些事件。Service
worker

能够被用来管理缓存,当响应3个网络请求时方可安顿为回到缓存如故从网络得到。由于Service
worker

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

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

图片 10

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

图片 11

瑟维斯 worker生命周期

图片 12

Service
worker

为网页添加3个近似于APP的生命周期,它只会响应系统事件,就算浏览器关闭时操作系统也足以唤起Service
worker
,那一点10分重要,让web
app与native app的能力变得近乎了。

Service
worker
在Register时会触发Install事件,在Install时能够用来预先获取和缓存应用所需的财富并安装种种文件的缓存策略。

一旦Service
worker
处在activated状态,就足以完全控制应用的能源,对互联网请求实行检讨,修改互连网请求,从互连网上收获并回到内容只怕再次来到由已安装的Service
worker
预示获取并缓存好的能源,甚至还足以扭转内容并赶回给网络语法。

不无的那个都用户都是晶莹的,事实上,3个规划赏心悦目的Service
worker
就像贰个智能缓存系统,抓实了网络和缓存效用,选用最优办法来响应互联网请求,让动用越来越安宁的运行,固然未有互联网也没涉及,因为您能够完全控制互连网响应。

Service worker的主宰从第二遍页面访问开始

在第一次加载页面时,全数财富都以从网络载的,Service
worker

在第三回加载时不会拿走控制互联网响应,它只会在后续访问页面时起功能。

图片 13

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

图片 14

页面第一次加载时,进入activated状态,准备处理全部的事件,同时
浏览器会向服务器发送1个异步 请求来检查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里有2个方可在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/

能够看出曾经有二四个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地图