离线网页应用,入门教程

离线网页应用,入门教程

利用 Service Worker 做一个 PWA 离线网页应用

2017/10/09 · JavaScript
· PWA, Service
Worker

原来的文章出处:
人人网FED博客   

在上朝气蓬勃篇《自个儿是怎么让网址用上HTML5
Manifest》介绍了怎么用Manifest做多个离线网页应用,结果被广泛网络好友奚弄说这么些事物已经被deprecated,移出web规范了,未来被ServiceWorker代替了,不管什么样,Manifest的片段考虑仍然是能够借用的。小编又将网址晋级到了ServiceWorker,假设是用Chrome等浏览器就用ServiceWorker做离线缓存,借使是Safari浏览器就仍然用Manifest,读者能够展开这几个网址心得一下,断网也是能平常展开。

渐进式Web应用(PWA卡塔 尔(英语:State of Qatar)入门教程(下卡塔尔

2018/05/25 · 根底技艺 ·
PWA

原稿出处: Craig
Buckler   译文出处:葡萄干城控件   

上篇随笔我们对渐进式Web应用(PWA卡塔尔做了一些骨干的介绍。

渐进式Web应用(PWA卡塔尔入门教程(上卡塔 尔(英语:State of Qatar)

在此生龙活虎节中,大家将介绍PWA的规律是何等,它是何许起首工业作的。

1. 什么是Service Worker

Service Worker是Google倡导的贯彻PWA(Progressive Web
App卡塔 尔(阿拉伯语:قطر‎的贰个要害剧中人物,PWA是为了化解古板Web 应用软件的劣点:

(1卡塔尔国未有桌面入口

(2卡塔尔不能够离线使用

(3)没有Push推送

这Service Worker的具体表现是什么样的啊?如下图所示:

图片 1

ServiceWorker是在后台运行的一条服务Worker线程,上海教室作者开了七个标签页,所以显得了三个Client,不过不管开多少个页面都独有三个Worker在担当管理。这些Worker的办事是把有些能源缓存起来,然后拦截页面包车型大巴伏乞,先看下缓存Curry有没有,如若局地话就从缓存里取,响应200,反之未有的话就走正规的伸手。具体来讲,ServiceWorker结合Web App Manifest能到位以下专门的工作(那也是PWA的检验专门的工作卡塔尔:

图片 2

回顾能够离线使用、断网时再次回到200、能唤醒客商把网址增加三个Logo到桌面上等。

第一步:使用HTTPS

渐进式Web应用程序供给采纳HTTPS连接。即便接收HTTPS会让您服务器的花费变多,但使用HTTPS能够令你的网址变得更安全,HTTPS网址在Google上的排行也会更靠前。

是因为Chrome浏览器会默许将localhost以至127.x.x.x地方视为测验地方,所以在本示例中您并不供给开启HTTPS。其它,出于调节和测验指标,您能够在运转Chrome浏览器的时候利用以下参数来关闭其对网址HTTPS的检讨:

  • –user-data-dir
  • –unsafety-treat-insecure-origin-as-secure

2. Service Worker的支撑情形

离线网页应用,入门教程。瑟维斯 Worker近些日子独有Chrome/Firfox/Opera帮助:

图片 3

Safari和Edge也在备选支持Service Worker,由于ServiceWorker是谷歌(Google卡塔 尔(英语:State of Qatar)基本的黄金时代项正式,对于生态比较密闭的Safari来讲也是迫于时势发轫策画协助了,在Safari
TP版本,可以看来:

图片 4

在实验成效(Experimental Features卡塔 尔(阿拉伯语:قطر‎里早就有ServiceWorker的菜单项了,只是即便展开也是不可能用,会提醒您还从未落实:

图片 5

但无论是什么样,起码注明Safari已经筹划协助ServiceWorker了。其余还足以看出在当年二〇一七年1月公布的Safari
11.0.1版本已经支持WebRTC了,所以Safari照旧一个前进的男女。

Edge也筹划扶持,所以Service Worker的前途极其美好。

第二步:成立一个应用程序项目清单(Manifest卡塔 尔(阿拉伯语:قطر‎

应用程序清单提供了和脚下渐进式Web应用的连锁音讯,如:

  • 应用程序名
  • 描述
  • 具有图片(包涵主荧屏图标,运行显示器页面和用的图形大概网页上用的图样卡塔尔国

实为上讲,程序项目清单是页面上用到的Logo和核心等财富的元数据。

程序清单是叁个位居您使用根目录的JSON文件。该JSON文件再次来到时必须抬高Content-Type: application/manifest+json 或者 Content-Type: application/jsonHTTP头音信。程序项目清单的文书名不限,在本文的身体力行代码中为manifest.json

{ “name” : “PWA Website”, “short_name” : “PWA”, “description” : “An
example PWA website”, “start_url” : “/”, “display” : “standalone”,
“orientation” : “any”, “background_color” : “#ACE”, “theme_color” :
“#ACE”, “icons”: [ { “src” : “/images/logo/logo072.png”, “sizes” :
“72×72”, “type” : “image/png” }, { “src” : “/images/logo/logo152.png”,
“sizes” : “152×152”, “type” : “image/png” }, { “src” :
“/images/logo/logo192.png”, “sizes” : “192×192”, “type” : “image/png” },
{ “src” : “/images/logo/logo256.png”, “sizes” : “256×256”, “type” :
“image/png” }, { “src” : “/images/logo/logo512.png”, “sizes” :
“512×512”, “type” : “image/png” } ] }

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
26
27
28
29
30
31
32
33
34
35
36
37
{
  "name"              : "PWA Website",
  "short_name"        : "PWA",
  "description"       : "An example PWA website",
  "start_url"         : "/",
  "display"           : "standalone",
  "orientation"       : "any",
  "background_color"  : "#ACE",
  "theme_color"       : "#ACE",
  "icons": [
    {
      "src"           : "/images/logo/logo072.png",
      "sizes"         : "72×72",
      "type"          : "image/png"
    },
    {
      "src"           : "/images/logo/logo152.png",
      "sizes"         : "152×152",
      "type"          : "image/png"
    },
    {
      "src"           : "/images/logo/logo192.png",
      "sizes"         : "192×192",
      "type"          : "image/png"
    },
    {
      "src"           : "/images/logo/logo256.png",
      "sizes"         : "256×256",
      "type"          : "image/png"
    },
    {
      "src"           : "/images/logo/logo512.png",
      "sizes"         : "512×512",
      "type"          : "image/png"
    }
  ]
}

程序清单文件创设完之后,你要求在每一种页面上援用该公文:

<link rel=”manifest” href=”/manifest.json”>

1
<link rel="manifest" href="/manifest.json">

以下属性在程序清单中经常使用,介绍表达如下:

  • name: 客商看到的选取名称
  • short_name: 应用短名称。当展现应用名称的地点相当不够时,将选择该名称。
  • description: 应用描述。
  • start_url: 选择开端路线,相对路线,默感到/。
  • scope: U福特ExplorerL范围。比方:倘若您将“/app/”设置为UEvoqueL范围时,这些应用就能够直接在这里个目录中。
  • background_color: 招待页面包车型客车背景颜色和浏览器的背景颜色(可选卡塔 尔(阿拉伯语:قطر‎
  • theme_color: 选择的核心颜色,平日都会和背景颜色相仿。这一个装置决定了接收如何显示。
  • orientation: 事先旋转方向,可选的值有:any, natural, landscape,
    landscape-primary, landscape-secondary, portrait, portrait-primary,
    and portrait-secondary
  • display: 显示格局——fullscreen(无Chrome卡塔尔,standalone(和原生应用相似卡塔 尔(阿拉伯语:قطر‎,minimal-ui(最小的大器晚成套UI控件集卡塔尔只怕browser(最古老的接收浏览器标签彰显卡塔尔
  • icons: 三个包罗全部图片的数组。该数组中种种成分包括了图片的U福睿斯L,大小和花色。

3. 使用Service Worker

ServiceWorker的采取套路是先挂号一个Worker,然后后台就能够运转一条线程,能够在此条线程运营的时候去加载一些财富缓存起来,然后监听fetch事件,在此个事件里拦截页面包车型大巴乞请,先看下缓存里有未有,借使有直接重返,否则不奇怪加载。恐怕是一齐初不缓存,每种能源央浼后再拷贝风姿罗曼蒂克份缓存起来,然后下一遍号令的时候缓存里就有了。

其三步:成立二个 Service Worker

Service Worker
是三个可编制程序的服务器代理,它能够阻碍可能响应互连网央求。Service Worker
是身处应用程序根目录的二个个的JavaScript文件。

您须要在页面临应的JavaScript文件中登记该ServiceWorker:

if (‘serviceWorker’ in navigator) { // register service worker
navigator.serviceWorker.register(‘/service-worker.js’); }

1
2
3
4
if (‘serviceWorker’ in navigator) {
  // register service worker
  navigator.serviceWorker.register(‘/service-worker.js’);
}

万生机勃勃您没有必要离线的有关效率,您能够只创立叁个 /service-worker.js文件,那样客商就足以一贯设置您的Web应用了!

ServiceWorker这一个定义恐怕相比较难懂,它其实是一个办事在此外线程中的标准的Worker,它不可能访谈页面上的DOM成分,未有页面上的API,不过足以阻挡全数页面上的网络央求,包涵页面导航,须求能源,Ajax央浼。

上面就是选用全站HTTPS的基本点缘由了。假若你未有在您的网址中动用HTTPS,叁个第三方的本子就足以从任何的域名注入他和睦的ServiceWorker,然后点窜全部的乞求——那不容争辩是这几个危急的。

Service Worker 会响应四个事件:install,activate和fetch。

(1卡塔 尔(英语:State of Qatar)注册贰个Service Worker

Service Worker对象是在window.navigator里面,如下代码:

JavaScript

window.addEventListener(“load”, function() { console.log(“Will the
service worker register?”); navigator.serviceWorker.register(‘/sw-3.js’)
.then(function(reg){ console.log(“Yes, it did.”); }).catch(function(err)
{ console.log(“No it didn’t. This happened: “, err) }); });

1
2
3
4
5
6
7
8
9
window.addEventListener("load", function() {
    console.log("Will the service worker register?");
    navigator.serviceWorker.register(‘/sw-3.js’)
    .then(function(reg){
        console.log("Yes, it did.");
    }).catch(function(err) {
        console.log("No it didn’t. This happened: ", err)
    });
});

在页面load完事后注册,注册的时候传一个js文件给它,这么些js文件就是瑟维斯Worker的运转情状,即便不能够得逞注册的话就能够抛十分,如Safari
TP即使有那几个目的,可是会抛相当不或者接收,就足以在catch里面管理。这里有个难点是为啥需求在load事件运转呢?因为您要相当运维三个线程,运维未来你恐怕还有或许会让它去加载能源,那么些都以急需占用CPU和带宽的,大家应有保险页面能符合规律加载完,然后再起步我们的后台线程,无法与健康的页面加载爆发角逐,这几个在低档移动设备意义十分的大。

再有少数急需注意的是ServiceWorker和Cookie相似是有Path路线的概念的,假若您设定几个cookie假使叫time的path=/page/A,在/page/B那几个页面是不可能得到到那些cookie的,假设设置cookie的path为根目录/,则具有页面都能取拿到。肖似地,就算注册的时候利用的js路线为/page/sw.js,那么这些ServiceWorker只好管理/page路径下的页面和财富,而不可以知道管理/api路线下的,所以日常把ServiceWorker注册到超级目录,如下面代码的”/sw-3.js”,那样这几个ServiceWorker就能够接管页面包车型客车保有财富了。

Install事件

该事件就要运用设置实现后触发。我们平时在这里地运用Cache
API缓存一些需要的文件。

第后生可畏,大家要求提供如下配置

  1. 缓存名称(CACHE卡塔 尔(阿拉伯语:قطر‎以致版本(version卡塔尔。应用能够有多少个缓存存储,不过在应用时只会使用当中一个缓存存款和储蓄。每当缓存存款和储蓄有生成时,新的本子号将会内定到缓存存款和储蓄中。新的缓存存款和储蓄将会作为当下的缓存存款和储蓄,以前的缓存存款和储蓄将会被作废。
  2. 一个离线的页面地址(offlineU奥德赛L卡塔 尔(英语:State of Qatar):当客户访谈了前头从没访谈过的地址时,该页面将会展现。
  3. 三个带有了全体必得文件的数组,包涵保持页面平日机能的CSS和JavaScript。在本示例中,笔者还加多了主页和logo。当有两样的U库罗德L指向同八个财富时,你也足以将这几个U路虎极光L分别写到那么些数组中。offlineU凯雷德L将会参加到那些数组中。
  4. 咱俩也足以将一些非供给的缓存文件(installFilesDesirable卡塔 尔(阿拉伯语:قطر‎。那一个文件在安装过程大校会被下载,但借使下载失利,不会触发安装退步。

// 配置文件 const version = ‘1.0.0’, CACHE = version + ‘::PWAsite’,
offlineUEnclaveL = ‘/offline/’, installFilesEssential = [ ‘/’,
‘/manifest.json’, ‘/css/styles.css’, ‘/js/main.js’,
‘/js/offlinepage.js’, ‘/images/logo/logo152.png’ ].concat(offlineURL),
installFilesDesirable = [ ‘/favicon.ico’, ‘/images/logo/logo016.png’,
‘/images/hero/power-pv.jpg’, ‘/images/hero/power-lo.jpg’,
‘/images/hero/power-hi.jpg’ ];

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// 配置文件
const
  version = ‘1.0.0’,
  CACHE = version + ‘::PWAsite’,
  offlineURL = ‘/offline/’,
  installFilesEssential = [
    ‘/’,
    ‘/manifest.json’,
    ‘/css/styles.css’,
    ‘/js/main.js’,
    ‘/js/offlinepage.js’,
    ‘/images/logo/logo152.png’
  ].concat(offlineURL),
  installFilesDesirable = [
    ‘/favicon.ico’,
    ‘/images/logo/logo016.png’,
    ‘/images/hero/power-pv.jpg’,
    ‘/images/hero/power-lo.jpg’,
    ‘/images/hero/power-hi.jpg’
  ];

installStaticFiles() 方法应用基于Promise的不二法门利用Cache
API将文件存款和储蓄到缓存中。

// 安装静态财富 function installStaticFiles() { return
caches.open(CACHE) .then(cache => { // 缓存可选文件
cache.addAll(installFilesDesirable); // 缓存必需文件 return
cache.addAll(installFilesEssential); }); }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// 安装静态资源
function installStaticFiles() {
  return caches.open(CACHE)
    .then(cache => {
      // 缓存可选文件
      cache.addAll(installFilesDesirable);
      // 缓存必须文件
      return cache.addAll(installFilesEssential);
    });
}

提及底,大家抬高三个install的风浪监听器。waitUntil办法保险了service
worker不会设置直到其有关的代码被实行。这里它会施行installStaticFiles()方法,然后self.skipWaiting()艺术来激活service
worker:

// 应用设置 self.add伊夫ntListener(‘install’, event => {
console.log(‘service worker: install’); // 缓存主要文件 event.waitUntil(
installStaticFiles() .then(() => self.skipWaiting()) ); });

1
2
3
4
5
6
7
8
9
10
11
12
// 应用安装
self.addEventListener(‘install’, event => {
  console.log(‘service worker: install’);
  // 缓存主要文件
  event.waitUntil(
    installStaticFiles()
    .then(() => self.skipWaiting())
  );
});

(2卡塔尔国Service Worker安装和激活

挂号完事后,ServiceWorker就能够开展安装,这时候会触发install事件,在install事件之中可以缓存一些财富,如下sw-3.js:

JavaScript

const CACHE_NAME = “fed-cache”; this.addEventListener(“install”,
function(event) { this.skipWaiting(); console.log(“install service
worker”); // 创设和开荒叁个缓存库 caches.open(CACHE_NAME); // 首页 let
cacheResources = [“];
event.waitUntil( // 诉求财富并加多到缓存里面去
caches.open(CACHE_NAME).then(cache => {
cache.addAll(cacheResources); }) ); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
const CACHE_NAME = "fed-cache";
this.addEventListener("install", function(event) {
    this.skipWaiting();
    console.log("install service worker");
    // 创建和打开一个缓存库
    caches.open(CACHE_NAME);
    // 首页
    let cacheResources = ["https://fed.renren.com/?launcher=true"];
    event.waitUntil(
        // 请求资源并添加到缓存里面去
        caches.open(CACHE_NAME).then(cache => {
            cache.addAll(cacheResources);
        })
    );
});

通过上边的操作,创制和增添了一个缓存库叫fed-cache,如下Chrome调控台所示:

图片 6

ServiceWorker的API基本上都以回到Promise对象幸免窒碍,所以要用Promise的写法。上面在装置ServiceWorker的时候就把首页的央浼给缓存起来了。在ServiceWorker的运作情形之中它有三个caches的全局对象,这么些是缓存的进口,还会有三个常用的clients的全局对象,一个client对应三个标签页。

在ServiceWorker里面能够使用fetch等API,它和DOM是隔开的,未有windows/document对象,不能直接操作DOM,无法间接和页面交互作用,在ServiceWorker里面不或许获知当前页面展开了、当前页面包车型大巴url是怎么,因为多个ServiceWorker管理当前开采的几个标签页,能够经过clients知道全体页面包车型客车url。还会有能够透过postMessage的秘技和主页面相互传递音信和数据,从而做些调整。

install完之后,就能够触发Service Worker的active事件:

JavaScript

this.addEventListener(“active”, function(event) { console.log(“service
worker is active”); });

1
2
3
this.addEventListener("active", function(event) {
    console.log("service worker is active");
});

ServiceWorker激活之后就可以监听fetch事件了,大家期望每拿到叁个资源就把它缓存起来,就不用像上后生可畏篇涉嫌的Manifest供给先生成叁个列表。

你只怕会问,当自身刷新页面包车型客车时候不是又再一次登记安装和激活了叁个ServiceWorker?尽管又调了三回注册,但并不会另行挂号,它开采”sw-3.js”那些已经登记了,就不会再登记了,进而不会触发install和active事件,因为日前ServiceWorker已是active状态了。当须要更新ServiceWorker时,如产生”sw-4.js”,或许改换sw-3.js的公文内容,就能够再也注册,新的ServiceWorker会先install然后走入waiting状态,等到重启浏览器时,老的ServiceWorker就能够被轮流掉,新的ServiceWorker步入active状态,假如不想等到再也起动浏览器能够像上面相符在install里面调skipWaiting:

JavaScript

this.skipWaiting();

1
this.skipWaiting();

Activate 事件

本条事件会在service
worker被激活时产生。你大概无需这么些事件,但是在演示代码中,大家在该事件发生时将老的缓存全体清理掉了:

// clear old caches function clearOldCaches() { return caches.keys()
.then(keylist => { return Promise.all( keylist .filter(key => key
!== CACHE) .map(key => caches.delete(key)) ); }); } // application
activated self.addEventListener(‘activate’, event => {
console.log(‘service worker: activate’); // delete old caches
event.waitUntil( clearOldCaches() .then(() => self.clients.claim())
); });

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
26
27
28
// clear old caches
function clearOldCaches() {
  return caches.keys()
    .then(keylist => {
      return Promise.all(
        keylist
          .filter(key => key !== CACHE)
          .map(key => caches.delete(key))
      );
    });
}
// application activated
self.addEventListener(‘activate’, event => {
  console.log(‘service worker: activate’);
    // delete old caches
  event.waitUntil(
    clearOldCaches()
    .then(() => self.clients.claim())
    );
});

注意self.clients.claim()施行时将会把当前service
worker作为被激活的worker。

Fetch 事件
该事件将会在网络初始央浼时发起。该事件管理函数中,大家得以接收respondWith()情势来劫持HTTP的GET必要然后重回:

  1. 从缓存中取到的财富文件
  2. 尽管第一步失利,能源文件将会从互联网中央银行使Fetch API来获取(和service
    worker中的fetch事件无关卡塔 尔(英语:State of Qatar)。获取到的财富将会步入到缓存中。
  3. 若果第一步和第二步均败北,将会从缓存中回到正确的财富文件。

// application fetch network data self.addEventListener(‘fetch’, event
=> { // abandon non-GET requests if (event.request.method !== ‘GET’)
return; let url = event.request.url; event.respondWith(
caches.open(CACHE) .then(cache => { return cache.match(event.request)
.then(response => { if (response) { // return cached file
console.log(‘cache fetch: ‘ + url); return response; } // make network
request return fetch(event.request) .then(newreq => {
console.log(‘network fetch: ‘ + url); if (newreq.ok)
cache.put(event.request, newreq.clone()); return newreq; }) // app is
offline .catch(() => offlineAsset(url)); }); }) ); });

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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
// application fetch network data
self.addEventListener(‘fetch’, event => {
  // abandon non-GET requests
  if (event.request.method !== ‘GET’) return;
  let url = event.request.url;
  event.respondWith(
    caches.open(CACHE)
      .then(cache => {
        return cache.match(event.request)
          .then(response => {
            if (response) {
              // return cached file
              console.log(‘cache fetch: ‘ + url);
              return response;
            }
            // make network request
            return fetch(event.request)
              .then(newreq => {
                console.log(‘network fetch: ‘ + url);
                if (newreq.ok) cache.put(event.request, newreq.clone());
                return newreq;
              })
              // app is offline
              .catch(() => offlineAsset(url));
          });
      })
  );
});

offlineAsset(url)艺术中动用了部分helper方法来回到准确的数量:

// 是还是不是为图片地址? let iExt = [‘png’, ‘jpg’, ‘jpeg’, ‘gif’, ‘webp’,
‘bmp’].map(f => ‘.’ + f); function isImage(url) { return
iExt.reduce((ret, ext) => ret || url.endsWith(ext), false); } //
return 重返离线能源 function offlineAsset(url) { if (isImage(url)) { //
重临图片 return new Response( ‘<svg role=”img” viewBox=”0 0 400 300″
xmlns=”
d=”M0 0h400v300H0z” fill=”#eee” /><text x=”200″ y=”150″
text-anchor=”middle” dominant-baseline=”middle” font-family=”sans-serif”
font-size=”50″ fill=”#ccc”>offline</text></svg>’, {
headers: { ‘Content-Type’: ‘image/svg+xml’, ‘Cache-Control’: ‘no-store’
}} ); } else { // return page return caches.match(offlineURL); } }

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
26
27
28
29
30
31
32
// 是否为图片地址?
let iExt = [‘png’, ‘jpg’, ‘jpeg’, ‘gif’, ‘webp’, ‘bmp’].map(f => ‘.’ + f);
function isImage(url) {
  
  return iExt.reduce((ret, ext) => ret || url.endsWith(ext), false);
  
}
  
  
// return 返回离线资源
function offlineAsset(url) {
  
  if (isImage(url)) {
  
    // 返回图片
    return new Response(
      ‘<svg role="img" viewBox="0 0 400 300" xmlns="http://www.w3.org/2000/svg"><title>offline</title><path d="M0 0h400v300H0z" fill="#eee" /><text x="200" y="150" text-anchor="middle" dominant-baseline="middle" font-family="sans-serif" font-size="50" fill="#ccc">offline</text></svg>’,
      { headers: {
        ‘Content-Type’: ‘image/svg+xml’,
        ‘Cache-Control’: ‘no-store’
      }}
    );
  
  }
  else {
  
    // return page
    return caches.match(offlineURL);
  
  }
  
}

offlineAsset()办法检查央浼是不是为二个图纸,然后回到八个含有“offline”文字的SVG文件。其余央浼将会回到
offlineU中华VL 页面。

Chrome开垦者工具中的ServiceWorker部分提供了关于当前页面worker的信息。当中会显得worker中爆发的失实,还足以强制刷新,也得以让浏览器走入离线情势。

Cache Storage
部分例举了当前怀有曾经缓存的能源。你能够在缓存必要立异的时候点击refresh开关。

(3)fetch资源后cache起来

如下代码,监听fetch事件做些处理:

JavaScript

this.addEventListener(“fetch”, function(event) { event.respondWith(
caches.match(event.request).then(response => { // cache hit if
(response) { return response; } return
util.fetchPut(event.request.clone()); }) ); });

1
2
3
4
5
6
7
8
9
10
11
12
this.addEventListener("fetch", function(event) {
    event.respondWith(
        caches.match(event.request).then(response => {
            // cache hit
            if (response) {
                return response;
            }
            return util.fetchPut(event.request.clone());
        })
    );
});

先调caches.match看一下缓存里面是还是不是有了,假设有直接回到缓存里的response,不然的话平常央求资源并把它放到cache里面。放在缓存里财富的key值是Request对象,在match的时候,供给诉求的url和header都同大器晚成才是生机勃勃律的财富,可以设定第贰个参数ignoreVary:

JavaScript

caches.match(event.request, {ignoreVary: true})

1
caches.match(event.request, {ignoreVary: true})

表示假诺须求url相通就感到是同四个能源。

上边代码的util.fetchPut是那样达成的:

JavaScript

let util = { fetchPut: function (request, callback) { return
fetch(request).then(response => { // 跨域的资源直接return if
(!response || response.status !== 200 || response.type !== “basic”) {
return response; } util.putCache(request, response.clone()); typeof
callback === “function” && callback(); return response; }); }, putCache:
function (request, resource) { // 后台不要缓存,preview链接也毫无缓存 if
(request.method === “GET” && request.url.indexOf(“wp-admin”) < 0 &&
request.url.indexOf(“preview_id”) < 0) {
caches.open(CACHE_NAME).then(cache => { cache.put(request,
resource); }); } } };

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
let util = {
    fetchPut: function (request, callback) {
        return fetch(request).then(response => {
            // 跨域的资源直接return
            if (!response || response.status !== 200 || response.type !== "basic") {
                return response;
            }
            util.putCache(request, response.clone());
            typeof callback === "function" && callback();
            return response;
        });
    },
    putCache: function (request, resource) {
        // 后台不要缓存,preview链接也不要缓存
        if (request.method === "GET" && request.url.indexOf("wp-admin") < 0
              && request.url.indexOf("preview_id") < 0) {
            caches.open(CACHE_NAME).then(cache => {
                cache.put(request, resource);
            });
        }
    }
};

急需专一的是跨域的财富无法缓存,response.status会再次来到0,借使跨域的能源扶植COOdysseyS,那么能够把request的mod改成cors。假若央浼失败了,如404仍为晚点等等的,那么也直接重临response让主页面管理,不然的话表达加载成功,把这些response克隆三个松开cache里面,然后再回来response给主页面线程。注意能舒缓存里的财富日常只好是GET,通过POST获取的是无法缓存的,所以要做个判别(当然你也足以手动把request对象的method改成get卡塔尔国,还应该有把有些民用不期望缓存的财富也做个判定。

这么风流洒脱旦顾客张开过三回页面,ServiceWorker就安装好了,他刷新页面或许展开首个页面包车型地铁时候就能够把央求的财富大器晚成大器晚成做缓存,包含图形、CSS、JS等,只要缓存里有了随意顾客在线或然离线都能够正常访问。那样大家自然会有叁个标题,那一个缓存空间到底有多大?上大器晚成篇大家提到Manifest也总算地方存储,PC端的Chrome是5Mb,其实这么些说法在新本子的Chrome已经不标准了,在Chrome
61本子能够看看本地存储的半空如月动用情形:

图片 7

内部Cache Storage是指ServiceWorker和Manifest占用的上空尺寸和,上海体育场面能够观察总的空间大小是20GB,大概是unlimited,所以基本上不用操心缓存会非常不够用。

第四步:成立可用的离线页面

离线页面能够是静态的HTML,平时用于提醒用户日前央求的页面一时半刻不能利用。然而,大家得以提供一些足以阅读的页面链接。

Cache
API能够在main.js中选取。但是,该API使用Promise,在不帮忙Promise的浏览器中会失利,全数的JavaScript试行会由此面前蒙受震慑。为了制止这种处境,在探访/js/offlinepage.js的时候我们增添了少年老成段代码来检查当前是否在离线情形中:

/js/offlinepage.js 中以版本号为名称保存了多年来的缓存,获取具备U传祺L,删除不是页面的U奥迪Q5L,将这一个UCRUISERL排序然后将装有缓存的U福睿斯L突显在页面上:

// cache name const CACHE = ‘::PWAsite’, offlineURL = ‘/offline/’, list
= document.getElementById(‘cachedpagelist’); // fetch all caches
window.caches.keys() .then(cacheList => { // find caches by and order
by most recent cacheList = cacheList .filter(cName =>
cName.includes(CACHE)) .sort((a, b) => a – b); // open first cache
caches.open(cacheList[0]) .then(cache => { // fetch cached pages
cache.keys() .then(reqList => { let frag =
document.createDocumentFragment(); reqList .map(req => req.url)
.filter(req => (req.endsWith(‘/’) || req.endsWith(‘.html’)) &&
!req.endsWith(offlineURL)) .sort() .forEach(req => { let li =
document.createElement(‘li’), a =
li.appendChild(document.createElement(‘a’)); a.setAttribute(‘href’,
req); a.textContent = a.pathname; frag.appendChild(li); }); if (list)
list.appendChild(frag); }); }) });

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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
// cache name
const
  CACHE = ‘::PWAsite’,
  offlineURL = ‘/offline/’,
  list = document.getElementById(‘cachedpagelist’);
// fetch all caches
window.caches.keys()
  .then(cacheList => {
    // find caches by and order by most recent
    cacheList = cacheList
      .filter(cName => cName.includes(CACHE))
      .sort((a, b) => a – b);
    // open first cache
    caches.open(cacheList[0])
      .then(cache => {
        // fetch cached pages
        cache.keys()
          .then(reqList => {
            let frag = document.createDocumentFragment();
            reqList
              .map(req => req.url)
              .filter(req => (req.endsWith(‘/’) || req.endsWith(‘.html’)) && !req.endsWith(offlineURL))
              .sort()
              .forEach(req => {
                let
                  li = document.createElement(‘li’),
                  a = li.appendChild(document.createElement(‘a’));
                  a.setAttribute(‘href’, req);
                  a.textContent = a.pathname;
                  frag.appendChild(li);
              });
            if (list) list.appendChild(frag);
          });
      })
  });

(4)cache html

上边第(3卡塔尔国步把图片、js、css缓存起来了,可是假诺把页面html也缓存了,举个例子把首页缓存了,就能够有贰个哭笑不得的标题——ServiceWorker是在页面注册的,然则未来拿到页面包车型大巴时候是从缓存取的,每一次都是千篇豆蔻梢头律的,所以就引致心余力绌立异ServiceWorker,如产生sw-5.js,可是PWA又必要大家能缓存页面html。那如何做吧?谷歌(Google卡塔尔的开辟者文书档案它只是提到会存在此个主题素材,但并不曾证实怎么化解这些标题。这些的难点的缓慢解决就要求大家要有四个机制能知道html更新了,进而把缓存里的html给替换掉。

Manifest更新缓存的建制是去看Manifest的文本内容有未有发生变化,假使爆发变化了,则会去更改缓存,ServiceWorker也是根据sw.js的公文内容有未有爆发变化,我们能够借鉴那一个考虑,如若须求的是html并从缓存里收取来后,再发个央求获取二个文件看html更新时间是还是不是产生变化,若是发生变化了则注脚产生更动了,进而把缓存给删了。所以能够在服务端通过决定这几个文件进而去纠正客商端的缓存。如下代码:

JavaScript

this.addEventListener(“fetch”, function(event) { event.respondWith(
caches.match(event.request).then(response => { // cache hit if
(response) { //假使取的是html,则看发个央求看html是还是不是更新了 if
(response.headers.get(“Content-Type”).indexOf(“text/html”) >= 0) {
console.log(“update html”); let url = new U普拉多L(event.request.url);
util.updateHtmlPage(url, event.request.clone(), event.clientId); }
return response; } return util.fetchPut(event.request.clone()); }) );
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
this.addEventListener("fetch", function(event) {
 
    event.respondWith(
        caches.match(event.request).then(response => {
            // cache hit
            if (response) {
                //如果取的是html,则看发个请求看html是否更新了
                if (response.headers.get("Content-Type").indexOf("text/html") >= 0) {
                    console.log("update html");
                    let url = new URL(event.request.url);
                    util.updateHtmlPage(url, event.request.clone(), event.clientId);
                }
                return response;
            }
 
            return util.fetchPut(event.request.clone());
        })
    );
});

因此响应头header的content-type是不是为text/html,借使是的话就去发个伏乞获取一个文本,遵照那么些文件的内容决定是不是须要删除缓存,这一个校订的函数util.updateHtmlPage是如此完毕的:

JavaScript

let pageUpdateTime = { }; let util = { updateHtmlPage: function (url,
htmlRequest) { let pageName = util.getPageName(url); let jsonRequest =
new Request(“/html/service-worker/cache-json/” + pageName + “.sw.json”);
fetch(jsonRequest).then(response => { response.json().then(content
=> { if (pageUpdateTime[pageName] !== content.updateTime) {
console.log(“update page html”); // 假诺有更新则再次拿到html
util.fetchPut(htmlRequest); pageUpdateTime[pageName] =
content.updateTime; } }); }); }, delCache: function (url) {
caches.open(CACHE_NAME).then(cache => { console.log(“delete cache “

  • url); cache.delete(url, {ignoreVary: true}); }); } };
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
let pageUpdateTime = {
 
};
let util = {
    updateHtmlPage: function (url, htmlRequest) {
        let pageName = util.getPageName(url);
        let jsonRequest = new Request("/html/service-worker/cache-json/" + pageName + ".sw.json");
        fetch(jsonRequest).then(response => {
            response.json().then(content => {
                if (pageUpdateTime[pageName] !== content.updateTime) {
                    console.log("update page html");
                    // 如果有更新则重新获取html
                    util.fetchPut(htmlRequest);
                    pageUpdateTime[pageName] = content.updateTime;
                }
            });
        });
    },
    delCache: function (url) {
        caches.open(CACHE_NAME).then(cache => {
            console.log("delete cache " + url);
            cache.delete(url, {ignoreVary: true});
        });
    }
};

代码先去得到二个json文件,叁个页面会对应二个json文件,这一个json的内容是这么的:

JavaScript

{“updateTime”:”10/2/2017, 3:23:57 PM”,”resources”: {img: [], css:
[]}}

1
{"updateTime":"10/2/2017, 3:23:57 PM","resources": {img: [], css: []}}

其间根本有三个updateTime的字段,借使地点内部存款和储蓄器未有这些页面包车型地铁updateTime的多少也许是和新星updateTime不一样等,则再度去得到html,然后放到缓存里。接着供给文告页面线程数据产生变化了,你刷新下页面吗。那样就无须等客商刷新页面本领卓有作用了。所以当刷新完页面后用postMessage文告页面:

JavaScript

let util = { postMessage: async function (msg) { const allClients =
await clients.matchAll(); allClients.forEach(client =>
client.postMessage(msg)); } }; util.fetchPut(htmlRequest, false,
function() { util.postMessage({type: 1, desc: “html found updated”, url:
url.href}); });

1
2
3
4
5
6
7
8
9
let util = {
    postMessage: async function (msg) {
        const allClients = await clients.matchAll();
        allClients.forEach(client => client.postMessage(msg));
    }
};
util.fetchPut(htmlRequest, false, function() {
    util.postMessage({type: 1, desc: "html found updated", url: url.href});
});

并明确type: 1就代表那是一个创新html的音讯,然后在页面监听message事件:

JavaScript

if(“serviceWorker” in navigator) {
navigator.serviceWorker.addEventListener(“message”, function(event) {
let msg = event.data; if (msg.type === 1 && window.location.href ===
msg.url) { console.log(“recv from service worker”, event.data);
window.location.reload(); } }); }

1
2
3
4
5
6
7
8
9
if("serviceWorker" in navigator) {
    navigator.serviceWorker.addEventListener("message", function(event) {
        let msg = event.data;
        if (msg.type === 1 && window.location.href === msg.url) {
            console.log("recv from service worker", event.data);
            window.location.reload();
        }  
    });
}

接下来当我们需求更新html的时候就更新json文件,那样用户就能够来看最新的页面了。只怕是当客户重新起动浏览器的时候会促成ServiceWorker的周转内部存款和储蓄器都被清空了,即存款和储蓄页面更新时间的变量被清空了,当时也会再次央求页面。

急需留意的是,要把那些json文件的http
cache时间设置成0,那样浏览器就不会缓存了,如下nginx的布局:

JavaScript

location ~* .sw.json$ { expires 0; }

1
2
3
location ~* .sw.json$ {
    expires 0;
}

因为那个文件是急需实时获取的,无法被缓存,firefox暗中同意会缓存,Chrome不会,加上http缓存时间为0,firefox也不会缓存了。

再有少年老成种更新是客商更新的,举例客商发表了商量,必要在页面公告service
worker把html缓存删了再一次赢得,那是二个转头的信息通告:

JavaScript

if (“serviceWorker” in navigator) {
document.querySelector(“.comment-form”).addEventListener(“submit”,
function() { navigator.serviceWorker.controller.postMessage({ type: 1,
desc: “remove html cache”, url: window.location.href} ); } }); }

1
2
3
4
5
6
7
8
9
10
if ("serviceWorker" in navigator) {
    document.querySelector(".comment-form").addEventListener("submit", function() {
            navigator.serviceWorker.controller.postMessage({
                type: 1,
                desc: "remove html cache",
                url: window.location.href}
            );
        }
    });
}

Service Worker也监听message事件:

JavaScript

const messageProcess = { // 删除html index 1: function (url) {
util.delCache(url); } }; let util = { delCache: function (url) {
caches.open(CACHE_NAME).then(cache => { console.log(“delete cache “

  • url); cache.delete(url, {ignoreVary: true}); }); } };
    this.addEventListener(“message”, function(event) { let msg = event.data;
    console.log(msg); if (typeof messageProcess[msg.type] === “function”)
    { messageProcess[msg.type](msg.url); } });
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const messageProcess = {
    // 删除html index
    1: function (url) {
        util.delCache(url);
    }
};
 
let util = {
    delCache: function (url) {
        caches.open(CACHE_NAME).then(cache => {
            console.log("delete cache " + url);
            cache.delete(url, {ignoreVary: true});
        });
    }
};
 
this.addEventListener("message", function(event) {
    let msg = event.data;
    console.log(msg);
    if (typeof messageProcess[msg.type] === "function") {
        messageProcess[msg.type](msg.url);
    }
});

依据不一致的音信类型调分化的回调函数,假设是1的话正是去除cache。客户公布完争辨后会触发刷新页面,刷新的时候缓存已经被删了就能够再也去央浼了。

这么就缓和了实时更新的难点。

开采者工具

Chrome浏览器提供了生龙活虎二种的工具来帮衬您来调度ServiceWorker,日志也会向来显示在调整台上。

您最棒利用匿超格局来扩充支付职业,那样能够废除缓存对开辟的忧虑。

最后,Chrome的Lighthouse扩张也得感到你的渐进式Web应用提供一些更上后生可畏层楼消息。

4. Http/Manifest/Service Worker三种cache的关系

要缓存能够接收二种手腕,使用Http
Cache设置缓存时间,也得以用Manifest的Application Cache,还足以用ServiceWorker缓存,假若三者都用上了会怎么着呢?

会以Service Worker为先行,因为瑟维斯Worker把央浼拦截了,它首先做拍卖,若是它缓存Curry一些话一直回到,未有的话经常央求,就约等于还未ServiceWorker了,当时就到了Manifest层,Manifest缓存里若是有个别话就取这些缓存,若无的话就相当于还没Manifest了,于是就能从Http缓存里取了,借使Http缓存里也从未就能够发须要去获得,服务端依照Http的etag或然Modified
Time或者会回来304 Not
Modified,不然平常再次来到200和数码内容。这正是整三个拿走的历程。

所以假如既用了Manifest又用ServiceWorker的话应该会促成同多个财富存了一遍。可是足以让协理ServiceWorker的浏览器接受Service Worker,而不扶助的使用Manifest.

渐进式Web应用的要义

渐进式Web应用是生龙活虎种新的本事,所以使用的时候势供给小心。约等于说,渐进式Web应用能够让你的网址在多少个时辰内得到纠正,况且在不扶助渐进式Web应用的浏览器上也不会影响网址的显示。

可是我们必要思考以下几点:

5. 利用Web App Manifest增添桌面入口

只顾这里说的是别的三个Manifest,这一个Manifest是二个json文件,用来放网址icon名称等新闻以便在桌面增多三个图标,以致创立大器晚成种张开这么些网页就如张开App相似的成效。上边素来讲的Manifest是被撇下的Application
Cache的Manifest。

本条Maifest.json文件能够这么写:

JavaScript

{ “short_name”: “人人FED”, “name”: “人人网FED,专心于后面一个技巧”,
“icons”: [ { “src”: “/html/app-manifest/logo_48.png”, “type”:
“image/png”, “sizes”: “48×48” }, { “src”:
“/html/app-manifest/logo_96.png”, “type”: “image/png”, “sizes”: “96×96”
}, { “src”: “/html/app-manifest/logo_192.png”, “type”: “image/png”,
“sizes”: “192×192” }, { “src”: “/html/app-manifest/logo_512.png”,
“type”: “image/png”, “sizes”: “512×512” } ], “start_url”:
“/?launcher=true”, “display”: “standalone”, “background_color”:
“#287fc5”, “theme_color”: “#fff” }

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
26
27
28
29
30
{
  "short_name": "人人FED",
  "name": "人人网FED,专注于前端技术",
  "icons": [
    {
      "src": "/html/app-manifest/logo_48.png",
      "type": "image/png",
      "sizes": "48×48"
    },
    {
      "src": "/html/app-manifest/logo_96.png",
      "type": "image/png",
      "sizes": "96×96"
    },
    {
      "src": "/html/app-manifest/logo_192.png",
      "type": "image/png",
      "sizes": "192×192"
    },
    {
      "src": "/html/app-manifest/logo_512.png",
      "type": "image/png",
      "sizes": "512×512"
    }
  ],
  "start_url": "/?launcher=true",
  "display": "standalone",
  "background_color": "#287fc5",
  "theme_color": "#fff"
}

icon要求粮草先行粮草先行二种尺度,最大须求512px *
512px的,那样Chrome会自动去筛选合适的图样。如若把display改成standalone,从扭转的Logo打开就能像张开一个App相像,未有浏览器地址栏那一个东西了。start_url钦命展开现在的进口链接。

接下来加多三个link标签指向那些manifest文件:

JavaScript

<link rel=”manifest” href=”/html/app-manifest/manifest.json”>

1
<link rel="manifest" href="/html/app-manifest/manifest.json">

如此那般组合Service Worker缓存:
图片 8把start_url指向的页面用ServiceWorker缓存起来,那样当顾客用Chrome浏览器展开这么些网页的时候,Chrome就能够在尾巴部分弹三个擢升,询问顾客是或不是把那个网页增加到桌面,假设点“加多”就可以转换二个桌面Logo,从这么些Logo点进去就疑似张开二个App同样。体会如下:

图片 9

正如为难的是Manifest方今唯有Chrome辅助,而且只可以在安卓系统上应用,IOS的浏览器无法增添三个桌面Logo,因为IOS未有开放这种API,但是自个儿的Safari却又是能够的。

综上,本文介绍了怎么用Service Worker结合Manifest做八个PWA离线Web
应用软件,主假使用ServiceWorker调节缓存,由于是写JS,相比灵敏,还足以与页面举办通讯,其余通过央浼页面包车型地铁更新时间来剖断是还是不是必要立异html缓存。ServiceWorker的宽容性不是专门好,但是前途比较光明,浏览器都在备选辅助。现阶段得以结合offline
cache的Manifest做离线应用。

相关阅读:

  1. 为啥要把网址晋级到HTTPS
  2. 怎么着把网址晋级到http/2
  3. 本身是怎样让网站用上HTML5
    Manifest

1 赞 1 收藏
评论

图片 10

URL隐藏

当您的使用正是一个单U本田UR-VL的应用程序时(比如游戏卡塔尔,作者建议您隐蔽地址栏。除了这一个之外的景况本人并不建议你隐蔽地址栏。在Manifest中,display: minimal-ui 或者 display: browser对于大相当多情景的话丰硕用了。

缓存过大

您无法将你网址中的全数内容缓存下来。对于小片段的网址来讲缓存全部剧情并不是一个难题,但是借使贰个网址富含了上千个页面吗?很扎眼不是全数人对网址中的全数内容都感兴趣。存储是有节制的,假诺您将具有访问过的页面都缓存下来的话,缓存大小会增进额非常快。

您可以如此制定你的缓存攻略:

  • 只缓存首要的页面,比方主页,联系人页面和今日浏览小说的页面。
  • 毫不缓存任何图片,录像和大文件
  • 准期清理旧的缓存
  • 提供贰个“离线阅读”开关,那样顾客就能够筛选必要缓存哪些内容了。

缓存刷新

示范代码中在提倡呼吁以前会先查询缓存。当客户处于离线状态时,那很好,但是假诺客户处于在线状态,那他只会浏览到相比老旧的页面。

各个财富举个例子图片和摄像不会转移,所以平日都把这个静态财富设置为漫漫缓存。这么些财富能够直接缓存一年(31,536,000秒卡塔尔。在HTTP
Header中,正是:

Cache-Control: max-age=31536000

1
Cache-Control: max-age=31536000

页面,CSS杭剧本文件也许变动的更频仍一些,所以您能够安装一个一点都超小的缓存超时时间(24钟头卡塔尔国,并保障在客商网络连接恢复生机时再也从服务器须求:

Cache-Control: must-revalidate, max-age=86400

1
Cache-Control: must-revalidate, max-age=86400

您也能够在每一回网址表露时,通过更名的方法强制浏览着重新央求财富。

小结

至此,相信你风度翩翩旦根据本文一步一步操作下来,你也得以便捷把温馨的Web应用转为PWA。在转为了PWA后,即使有应用满意PWA
模型的前端控件的必要,你能够施行纯前端表格控件SpreadJS,适用于
.NET、Java 和移动端等平台的表格控件一定不会让你大失所望的。

原稿链接:

1 赞 1 收藏
评论

图片 10

admin

网站地图xml地图