菜单

选择Service worker达成加速/离线访问静态blog网站

2019年4月12日 - JavaScript

利用Service worker实现加速/离线访问静态blog网址

2017/02/19 · JavaScript
· Service Worker

原著出处: Yang
Bo
   

当今很盛行基于Github
page和markdown的静态blog,分外适合技术的思想和习惯,针对不一致的语言都有1部分一箭双雕的静态blog系统出现,如Jekyll/Ruby,Pelican/Python,Hexo/NodeJs,由于静态内容的天性13分适合做缓存来加快页面的走访,就应用Service
worker
来落到实处加快,结果是除了PageSpeed,CDN那些科学普及的服务器和互联网加快之外,通过客户端实现了更加好的拜访体验。

动用 Service worker 成立二个格外不难的离线页面

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

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

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

图片 1

那是壹对壹让人衰颓的经验!幸运的是,web
开发者们能经过1些新性子来创新那类的用户体验。小编多年来一贯在折腾 ServiceWorkers,它给 web 带来的无尽大概性总能给作者惊喜。Service Workers
的理想特质之1是同意你检查实验网络请求的场地,并让你作出相应的响应。

在那篇文章里,小编打算用此本性检查用户的当下互联网连接情形,假诺没连接则赶回三个一流级不难的离线页面。固然这是一个11分基础的案例,但它能给您带来启发,让你领悟运营并运维该脾性是何等的回顾!假诺您没领会过
Service Worker,作者提议你看看此 Github
repo
,掌握越来越多相关的音信。

在此案例早先前,让我们先简单地看望它的办事流程:

  1. 在用户首次访问大家的页面时,大家会设置 ServiceWorker,并向浏览器的缓存添加大家的离线 HTML 页面
  2. 然后,假使用户打算导航到另贰个 web
    页面(同三个网址下),但此时已断网,那么大家将回到已被缓存的离线
    HTML 页面
  3. 不过,假若用户打算导航到此外一个 web
    页面,而那时网络已再而3,则能照常浏览页面

加紧/离线访问只需三步

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 页面。那就算12分基础,但能给您完全思路。

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
时,向缓存添加了离线页面。假如大家将代码分为几小块,可看出前几行代码中,作者为离线页面钦赐了缓存版本和UGL450L。若是你的缓存有差异版本,那么您只需创新版本号即可不难地铲除缓存。在大概在第2二行代码,笔者向这一个离线页面及其能源(如:图片)发出请求。在获取成功的响应后,大家将离线页面和有关财富足够到缓存。

近期,离线页面已存进缓存了,咱们可在急需的时等候检查索它。在同四个 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降为1,加载时间从二.2玖陆s降为0.65肆s,获得了一下加载的结果。

图片 6

基于webpagetest

查看测试结果

举行阅读

其余,还有多少个很棒的离线功效案例。如:Guardian 营造了一个具有 crossword
puzzle
(填字游戏)的离线
web 页面 –
由此,就算等待互联网重连时(即已在离线状态下),也能找到一点乐趣。作者也援引看看
Google Chrome Github
repo
,它包括了成都百货上千例外的
Service Worker 案例 – 个中壹部分运用案例也在那!

可是,假设你想跳过上述代码,只是想大约地通过2个库来拍卖相关操作,那么本人推荐您看看
UpUp。那是3个轻量的剧本,能让你更轻松地行使离线功用。

打赏协助作者翻译更加多好文章,多谢!


打赏译者

加紧/离线原理探索

打赏扶助小编翻译越多好小说,感激!

任选1种支付格局

图片 7
图片 8

1 赞 3 收藏 1
评论

什么是 Service worker

图片 9

如上图,Service
worker

是壹种由Javascript编写的浏览器端代理脚本,位于你的浏览器和服务器之间。当三个页面注册了2个
Service
worker
,它就能够登记1雨后鞭笋事件处理器来响应如互联网请求和音讯推送这几个事件。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的支配从第一回页面访问开始

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

在首次加载时不会取得控制网络响应,它只会在继承访问页面时起效果。

图片 13

页面第1次加载时成功install,并进入idle状态。

图片 14

页面第1遍加载时,进入activated状态,准备处理全部的风浪,同时
浏览器会向服务器发送3个异步 请求来检查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>

万1浏览器支持serviceWorker就注册它,不扶助依然健康浏览,未有Service
worker
所提供的提升功用。

瑟维斯 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及其余双核浏览器同谷歌 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及其余双核浏览器同谷歌(Google) 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地图