入门教程,离线网页应用

React 同构应用 PWA 进级指南

2018/05/25 · JavaScript
· PWA,
React

初稿出处:
林东洲   

渐进式Web应用(PWA卡塔 尔(阿拉伯语:قطر‎入门教程(下卡塔尔

2018/05/25 · 基本功手艺 ·
PWA

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

上篇小说大家对渐进式Web应用(PWA卡塔尔国做了黄金年代部分主干的牵线。

渐进式Web应用(PWA卡塔 尔(阿拉伯语:قطر‎入门教程(上卡塔尔国

在此生机勃勃节中,大家将介绍PWA的原理是什么样,它是怎么着起先工作的。

行使 Service Worker 做叁个 PWA 离线网页应用

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

原版的书文出处:
人人网FED博客   

在上后生可畏篇《本身是怎么样让网址用上HTML5
Manifest》介绍了怎么用Manifest做三个离线网页应用,结果被大范围网上亲密的朋友嘲弄说这么些东西已经被deprecated,移出web规范了,今后被ServiceWorker替代了,不管怎么,Manifest的片段考虑依旧得以借用的。作者又将网站进级到了ServiceWorker,即使是用Chrome等浏览器就用瑟维斯Worker做离线缓存,纵然是Safari浏览器就依然用Manifest,读者能够展开这么些网址体会一下,断网也是能符合规律打开。

前言

近年来在给本人的博客网址 PWA 进级,顺便就记录下 React 同构应用在利用 PWA
时遇到的主题材料,这里不会从头初叶介绍怎样是 PWA,借使你想学习 PWA
相关知识,能够看下上面小编收藏的后生可畏部分稿子:

  • 你的首先个 Progressive Web
    App
  • 【ServiceWorker】生命周期那多少个事儿
  • 【PWA学习与奉行】(1)
    2018,早先你的PWA学习之旅
  • Progressive Web Apps (PWA)
    中文版

第一步:使用HTTPS

渐进式Web应用程序须求利用HTTPS连接。即使接收HTTPS会令你服务器的付出变多,但使用HTTPS能够让您的网址变得更安全,HTTPS网站在谷歌(Google卡塔 尔(英语:State of Qatar)上的排名也会更靠前。

是因为Chrome浏览器会暗中认可将localhost以致127.x.x.x地址视为测量检验地方,所以在本示例中您并无需开启HTTPS。其它,出于调节和测量检验指标,您能够在开发银行Chrome浏览器的时候利用以下参数来关闭其对网址HTTPS的自己探究:

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

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到桌面上等。

PWA 特性

PWA 不是生龙活虎味的某项本领,而是一群技巧的集合,举例:ServiceWorker,manifest 增多到桌面,push、notification api 等。

而就在近年来时间,IOS 11.3 刚刚帮衬 Service worker 和好像 manifest
增添到桌面包车型客车表征,所以这一次 PWA
校订主要照旧兑现这两有些功用,至于别的的特征,等 iphone 扶持了再提高吗。

其次步:制造叁个应用程序清单(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奥迪Q3L范围。比方:尽管你将“/app/”设置为UENCOREL范围时,那些动用就能够一向在这里个目录中。
  • background_color: 应接页面的背景颜色和浏览器的背景颜色(可选卡塔 尔(英语:State of Qatar)
  • 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,大小和花色。

2. Service Worker的扶助景况

Service Worker近期独有Chrome/Firfox/Opera帮助:

图片 3

Safari和Edge也在希图接济Service Worker,由于ServiceWorker是谷歌(Google卡塔 尔(阿拉伯语:قطر‎基本的大器晚成项标准,对于生态相比较密闭的Safari来讲也是迫于时局初始策画支持了,在Safari
TP版本,能够看见:

图片 4

在试验作用(Experimental Features卡塔 尔(阿拉伯语:قطر‎里曾经有ServiceWorker的菜单项了,只是即便展开也是不能够用,会提示您还尚无实现:

图片 5

但无论是什么样,起码表达Safari已经计划匡助ServiceWorker了。此外还能见到在今年前年8月颁发的Safari
11.0.1本子现已支撑WebRTC了,所以Safari仍然二个进步的孩子。

Edge也计划扶助,所以Service Worker的前途特别美好。

Service Worker

service worker
以作者之见,相同于多个跑在浏览器后台的线程,页面第一遍加载的时候会加载那一个线程,在线程激活之后,通过对
fetch 事件,能够对每一种收获的能源扩充支配缓存等。

其三步:创制叁个 Service Worker

瑟维斯 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。

3. 使用Service Worker

ServiceWorker的运用套路是先挂号一个Worker,然后后台就能够运转一条线程,能够在此条线程运维的时候去加载一些能源缓存起来,然后监听fetch事件,在此个事件里拦截页面包车型大巴央浼,先看下缓存里有未有,倘诺有直接再次来到,不然平常加载。可能是一同头不缓存,每种财富诉求后再拷贝生机勃勃份缓存起来,然后下一回倡议的时候缓存里就有了。

显著哪些财富须求被缓存?

那么在上马利用 service worker 以前,首先必要知道什么能源必要被缓存?

Install事件

该事件将在使用设置到位后触发。大家日常在此边运用Cache
API缓存一些必不可缺的文件。

第大器晚成,咱们须要提供如下配置

  1. 缓存名称(CACHE卡塔尔以致版本(version卡塔尔。应用能够有多少个缓存存款和储蓄,然而在行使时只会动用当中二个缓存存储。每当缓存存款和储蓄有变动时,新的本子号将会内定到缓存存款和储蓄中。新的缓存存储将会作为当前的缓存存款和储蓄,在此之前的缓存存款和储蓄将会被作废。
  2. 一个离线的页面地址(offlineURAV4L卡塔 尔(阿拉伯语:قطر‎:当客商访谈了事先并未有访谈过的地点时,该页面将会展现。
  3. 二个满含了颇有必需文件的数组,包含保持页面寻常作用的CSS和JavaScript。在本示例中,我还增加了主页和logo。当有两样的U中华VL指向同二个资源时,你也足以将这么些U奥德赛L分别写到那一个数组中。offlineU福特ExplorerL将会投入到那么些数组中。
  4. 俺们也足以将一些非要求的缓存文件(installFilesDesirable卡塔尔国。那个文件在装置进程准将会被下载,但如果下载失败,不会触发安装退步。

// 配置文件 const version = ‘1.0.0’, CACHE = version + ‘::PWAsite’,
offlineU凯雷德L = ‘/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.addEventListener(‘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())
  );
});

(1卡塔 尔(阿拉伯语:قطر‎注册贰个Service Worker

瑟维斯 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文件就是ServiceWorker的运作环境,假使不能成功注册的话就能够抛相当,如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就会接管页面包车型客车保有能源了。

缓存静态财富

率先是像 CSS、JS 这个静态能源,因为自个儿的博客里引用的本子样式都是因而 hash
做持久化缓存,雷同于:main.ac62dexx.js 那样,然后展开强缓存,那样下一次客商后一次再探问作者的网址的时候就绝不再行乞求财富。直接从浏览器缓存中读取。对于那后生可畏都部队分财富,service
worker 没供给再去管理,直接放行让它去读取浏览器缓存就可以。

本人感到只要你的站点加载静态能源的时候笔者并未有打开强缓存,况且你只想经过前端去得以落成缓存,而不须要后端在参与进行调度,那能够行使
service worker 来缓存静态财富,不然就有一些适得其反了。

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揽胜L 页面。

Chrome开拓者工具中的瑟维斯Worker部分提供了有关当前页面worker的音讯。此中交易会示worker中爆发的荒谬,仍是可以强制刷新,也能够让浏览器踏向离线方式。

Cache Storage
部分例举了日前具有曾经缓存的能源。你可以在缓存须求更新的时候点击refresh开关。

(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();

缓存页面

缓存页面显著是少不了的,那是最基本的片段,当您在离线的地方下加载页面会之后现身:

图片 7

究其原因便是因为你在离线状态下不能加载页面,今后有了 service
worker,即便你在没互联网的情状下,也得以加载以前缓存好的页面了。

第四步:创设可用的离线页面

离线页面能够是静态的HTML,日常用来提示客户日前乞求的页面一时半刻不能利用。然则,大家得以提供一些得以阅读的页面链接。

Cache
API能够在main.js中选择。可是,该API使用Promise,在不援救Promise的浏览器中会失利,全部的JavaScript实施会为此面对震慑。为了制止这种气象,在访问/js/offlinepage.js的时候大家加多了生机勃勃段代码来检查当前是还是不是在离线遇到中:

/js/offlinepage.js 中以版本号为名称保存了近些日子的缓存,获取具备URubiconL,删除不是页面包车型地铁U宝马X3L,将那一个U兰德瑞虎L排序然后将有着缓存的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);
          });
      })
  });

(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,假使跨域的能源支撑CO奥德赛S,那么能够把request的mod改成cors。假使须要失败了,如404恐怕是过期等等的,那么也直接再次来到response让主页面管理,不然的话表明加载成功,把这些response克隆叁个放到cache里面,然后再重临response给主页面线程。注意能舒缓存里的能源日常只可以是GET,通过POST获取的是不能够缓存的,所以要做个剖断(当然你也能够手动把request对象的method改成get卡塔尔,还会有把部分私有不期待缓存的能源也做个决断。

如此那般假诺顾客展开过三次页面,ServiceWorker就设置好了,他刷新页面也许打开第三个页面包车型大巴时候就可以知道把央求的财富朝气蓬勃后生可畏做缓存,包罗图形、CSS、JS等,只要缓存里有了随意客商在线也许离线都能够不荒谬访谈。这样大家本来会有三个难题,那些缓存空间到底有多大?上生机勃勃篇我们提到Manifest也毕竟地点存款和储蓄,PC端的Chrome是5Mb,其实那么些说法在新本子的Chrome已经不标准了,在Chrome
61本子能够看看地点存款和储蓄的半空春天使用状态:

图片 8

当中Cache Storage是指ServiceWorker和Manifest占用的长台湾空中大学小和,上图能够观看总的空间尺寸是20GB,差相当的少是unlimited,所以基本上不用担忧缓存会相当不够用。

缓存后端接口数据

缓存接口数据是内需的,但亦非必得经过 service worker
来完毕,前端贮存数据的地点有超多,例如通过 localstorage,indexeddb
来进展仓库储存。这里笔者也是由此 service worker
来贯彻缓存接口数据的,如果想经过其他措施来落到实处,只需求在乎好 url
路线与数据对应的照射关系就能够。

开采者工具

Chrome浏览器提供了风流倜傥多级的工具来支持您来调治ServiceWorker,日志也会直接彰显在调控台上。

您最佳利用匿有名的模特式来开展支付专门的学业,那样能够撤除缓存对开采的苦闷。

最后,Chrome的Lighthouse恢宏也得认为你的渐进式Web应用提供一些更上生机勃勃层楼新闻。

(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.add伊夫ntListener(“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的数码仍为和新星update提姆e不等同,则再一次去获得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。客商发布完争辩后会触发刷新页面,刷新的时候缓存已经被删了就能够再一次去央浼了。

与上述同类就解决了实时更新的难点。

缓存计策

确定了何等能源供给被缓存后,接下去将要钻探缓存攻略了。

渐进式Web应用的要领

渐进式Web应用是生机勃勃种新的手艺,所以使用的时候自然要小心。也正是说,渐进式Web应用能够让您的网址在多少个钟头内拿到改革,何况在不援助渐进式Web应用的浏览器上也不会潜移暗化网址的呈现。

可是大家须求思谋以下几点:

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

要缓存能够选取两种花招,使用Http
Cache设置缓存时间,也能够用Manifest的Application Cache,还足以用ServiceWorker缓存,假若三者都用上了会怎么呢?

会以Service Worker为先行,因为ServiceWorker把供给拦截了,它首先做拍卖,假设它缓存Curry一些话一贯回到,未有的话平常央求,就也正是尚未ServiceWorker了,此时就到了Manifest层,Manifest缓存里如果有些话就取这个缓存,若无的话就相当于还未Manifest了,于是就能够从Http缓存里取了,假设Http缓存里也远非就能够发诉求去获得,服务端依据Http的etag只怕Modified
Time恐怕会回来304 Not
Modified,不然平常重回200和数码内容。这正是整三个赢得的历程。

进而即使既用了Manifest又用ServiceWorker的话应该会促成同二个能源存了一次。不过足以让扶助ServiceWorker的浏览器采取Service Worker,而不辅助的施用Manifest.

页面缓存战术

因为是 React
单页同构应用,每回加载页面的时候数据都以动态的,所以自个儿使用的是:

  1. 互联网优先的艺术,即优先拿到互连网上风行的资源。当网络央求战败的时候,再去拿到service worker 里以前缓存的能源
  2. 当网络加载成功之后,就更新 cache
    中对应的缓存财富,保障后一次历次加载页面,都是上次作客的新型能源
  3. 若是找不到 service worker 中 url 对应的能源的时候,则去得到 service
    worker 对应的 /index.html 暗中同意首页

// sw.js self.add伊芙ntListener(‘fetch’, (e) => {
console.log(‘以后正在呼吁:’ + e.request.url); const currentUrl =
e.request.url; // 相称上页面路线 if (matchHtml(currentUrl)) { const
requestToCache = e.request.clone(); e.respondWith( // 加载互联网上的财富fetch(requestToCache).then((response) => { // 加载失利 if (!response
|| response.status !== 200) { throw Error(‘response error’); } //
加载成功,更新缓存 const responseToCache = response.clone();
caches.open(cacheName).then((cache) => { cache.put(requestToCache,
responseToCache); }); console.log(response); return response;
}).catch(function() { //
获取对应缓存中的数据,获取不到则失败到收获暗许首页 return
caches.match(e.request).then((response) => { return response ||
caches.match(‘/index.html’); }); }) ); } });

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
// sw.js
self.addEventListener(‘fetch’, (e) => {
  console.log(‘现在正在请求:’ + e.request.url);
  const currentUrl = e.request.url;
  // 匹配上页面路径
  if (matchHtml(currentUrl)) {
    const requestToCache = e.request.clone();
    e.respondWith(
      // 加载网络上的资源
      fetch(requestToCache).then((response) => {
        // 加载失败
        if (!response || response.status !== 200) {
          throw Error(‘response error’);
        }
        // 加载成功,更新缓存
        const responseToCache = response.clone();
        caches.open(cacheName).then((cache) => {
          cache.put(requestToCache, responseToCache);
        });
        console.log(response);
        return response;
      }).catch(function() {
        // 获取对应缓存中的数据,获取不到则退化到获取默认首页
        return caches.match(e.request).then((response) => {
           return response || caches.match(‘/index.html’);
        });
      })
    );
  }
});

何以存在命中持续缓存页面包车型大巴图景?

  1. 率先须求驾驭的是,客商在第二遍加载你的站点的时候,加载页面后才会去运转sw,所以率先次加载不容许通过 fetch 事件去缓存页面
  2. 本人的博客是单页应用,不过客商并不一定会经过首页踏向,有望会透过其余页面路线步入到笔者的网址,这就变成作者在
    install 事件中一向不可能钦赐须要缓存那多少个页面
  3. 终极完毕的功效是:顾客率先次张开页面,即刻断掉互联网,还是可以够离线访谈我的站点

构成地方三点,我的不二等秘书技是:第叁遍加载的时候会缓存 /index.html 这么些财富,並且缓存页面上的数目,假设客户及时离线加载的话,这时并不曾缓存对应的门路,比如 /archives 能源访谈不到,那重回 /index.html 走异步加载页面的逻辑。

在 install 事件缓存 /index.html,保证了 service worker
第一回加载的时候缓存私下认可页面,留下退路。

import constants from ‘./constants’; const cacheName =
constants.cacheName; const apiCacheName = constants.apiCacheName; const
cacheFileList = [‘/index.html’]; self.addEventListener(‘install’, (e)
=> { console.log(‘Service Worker 状态: install’); const
cacheOpenPromise = caches.open(cacheName).then((cache) => { return
cache.addAll(cacheFileList); }); e.waitUntil(cacheOpenPromise); });

1
2
3
4
5
6
7
8
9
10
11
12
import constants from ‘./constants’;
const cacheName = constants.cacheName;
const apiCacheName = constants.apiCacheName;
const cacheFileList = [‘/index.html’];
 
self.addEventListener(‘install’, (e) => {
  console.log(‘Service Worker 状态: install’);
  const cacheOpenPromise = caches.open(cacheName).then((cache) => {
    return cache.addAll(cacheFileList);
  });
  e.waitUntil(cacheOpenPromise);
});

在页面加载完后,在 React 组件中马上缓存数据:

// cache.js import constants from ‘../constants’; const apiCacheName =
constants.apiCacheName; export const saveAPIData = (url, data) => {
if (‘caches’ in window) { // 伪造 request/response 数据
caches.open(apiCacheName).then((cache) => { cache.put(url, new
Response(JSON.stringify(data), { status: 200 })); }); } }; // React 组件
import constants from ‘../constants’; export default class extends
PureComponent { componentDidMount() { const { state, data } =
this.props; // 异步加载数据 if (state === constants.INITIAL_STATE ||
state === constants.FAILURE_STATE) { this.props.fetchData(); } else {
// 服务端渲染成功,保存页面数据 saveAPIData(url, data); } } }

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
// cache.js
import constants from ‘../constants’;
const apiCacheName = constants.apiCacheName;
 
export const saveAPIData = (url, data) => {
  if (‘caches’ in window) {
    // 伪造 request/response 数据
    caches.open(apiCacheName).then((cache) => {
      cache.put(url, new Response(JSON.stringify(data), { status: 200 }));
    });
  }
};
 
// React 组件
import constants from ‘../constants’;
export default class extends PureComponent {
  componentDidMount() {
    const { state, data } = this.props;
    // 异步加载数据
    if (state === constants.INITIAL_STATE || state === constants.FAILURE_STATE) {
      this.props.fetchData();
    } else {
        // 服务端渲染成功,保存页面数据
      saveAPIData(url, data);
    }
  }
}

那般就确定保证了客户率先次加载页面,马上离线访谈站点后,尽管不能够像第三遍同样能够服务端渲染数据,不过之后能通过获取页面,异步加载数据的法子塑造离线应用。

图片 9

用户率先次访谈站点,假如在不刷新页面包车型客车状态切换路由到任何页面,则会异步获取到的数量,当下次做客对应的路由的时候,则失败到异步获取数据。

图片 10

当客商第一遍加载页面包车型地铁时候,因为 service worker
已经调整了站点,已经具备了缓存页面包车型地铁力量,之后在探望的页面都将会被缓存可能更新缓存,当客户离线访谈的的时候,也能访问到服务端渲染的页面了。

图片 11

URL隐藏

当您的选择便是二个单U奇骏L的应用程序时(譬如游戏),笔者建议您隐讳地址栏。除外的气象小编并不提议你隐蔽地址栏。在Manifest中,display: minimal-ui 或者 display: browser对此大多数意况的话充足用了。

5. 施用Web App Manifest加多桌面入口

留心这里说的是别的贰个Manifest,那么些Manifest是二个json文件,用来放网址icon名称等音讯以便在桌面增多贰个Logo,以致创立大器晚成种张开那么些网页就像是展开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缓存:
图片 12把start_url指向的页面用ServiceWorker缓存起来,那样当顾客用Chrome浏览器打开这一个网页的时候,Chrome就能够在底层弹一个唤起,询问客商是不是把这一个网页增添到桌面,若是点“加多”就能生成一个桌面Logo,从那么些Logo点进去就如张开叁个App同样。心得如下:

图片 13

相比窘迫的是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 收藏
评论

图片 14

接口缓存攻略

谈完页面缓存,再来说讲接口缓存,接口缓存就跟页面缓存很周围了,唯生机勃勃的两样在于:页面首回加载的时候不料定有缓存,不过会有接口缓存的留存(因为杜撰了
cache 中的数据),所以缓存战术跟页面缓存相符:

  1. 网络优先的法子,即优先获得网络上接口数据。当互连网央浼失败的时候,再去赢得
    service worker 里早前缓存的接口数据
  2. 当互联网加载成功之后,就校订 cache
    中对应的缓存接口数据,保障后一次每便加载页面,都是上次作客的风靡接口数据

因此代码就像是这样(代码相同,不再赘述):

self.addEventListener(‘fetch’, (e) => { console.log(‘未来正在号令:’

  • e.request.url); const currentUrl = e.request.url; if
    (matchHtml(currentUrl)) { // … } else if (matchApi(currentUrl)) {
    const requestToCache = e.request.clone(); e.respondWith(
    fetch(requestToCache).then((response) => { if (!response ||
    response.status !== 200) { return response; } const responseToCache =
    response.clone(); caches.open(apiCacheName).then((cache) => {
    cache.put(requestToCache, responseToCache); }); return response;
    }).catch(function() { return caches.match(e.request); }) ); } });
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
self.addEventListener(‘fetch’, (e) => {
  console.log(‘现在正在请求:’ + e.request.url);
  const currentUrl = e.request.url;
  if (matchHtml(currentUrl)) {
    // …
  } else if (matchApi(currentUrl)) {
    const requestToCache = e.request.clone();
    e.respondWith(
      fetch(requestToCache).then((response) => {
        if (!response || response.status !== 200) {
          return response;
        }
        const responseToCache = response.clone();
        caches.open(apiCacheName).then((cache) => {
          cache.put(requestToCache, responseToCache);
        });
        return response;
      }).catch(function() {
        return caches.match(e.request);
      })
    );
  }
});

这里其实能够再张开优化的,举例在获取数据接口的时候,能够先读取缓存中的接口数据进行渲染,当真正的互联网接口数据再次回到之后再开展轮流,那样也能使得压缩客户的首屏渲染时间。当然那大概会产生页面闪烁的功力,能够加多一些动漫片来进展连接。

缓存过大

你不能够将您网址中的全部剧情缓存下来。对于小部分的网站的话缓存全数剧情实际不是三个标题,可是只要二个网址包罗了上千个页面吗?很鲜明不是全体人对网址中的全数剧情都感兴趣。存款和储蓄是有限量的,如果你将具备采访过的页面都缓存下来的话,缓存大小会增进额超级快。

你能够这么制订你的缓存战术:

  • 只缓存重要的页面,举个例子主页,联系人页面和方今浏览作品的页面。
  • 不要缓存任何图片,摄像和大文件
  • 按时清理旧的缓存
  • 提供一个“离线阅读”按键,这样客商就足以选择要求缓存哪些内容了。

任何难题

到近些日子截至,已经差不离能够兑现 service worker
离线缓存应用的作用了,不过还或然有照旧存在部分标题:

缓存刷新

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

各样财富举例图片和录像不会改造,所以日常都把这一个静态能源设置为浓烈缓存。这几个能源得以一直缓存一年(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

你也能够在历次网址揭露时,通过更名的办法强制浏览重视新央求财富。

快速度与激情活 service worker

暗中认可情状下,页面包车型客车乞请(fetch卡塔尔不会经过 sw,除非它本身是透过 sw
获取的,也正是说,在装置 sw 之后,须求刷新页面能力有机能。sw
在设置成功并激活从前,不会响应 fetch或push等事件。

因为站点是单页面应用,那就导致了你在切换路由(未有刷新页面)的时候从不缓存接口数据,因为那时候service worker 还还没从头职业,所以在加载 service worker
的时候须要急忙地激活它。代码如下:

self.addEventListener(‘activate’, (e) => { console.log(‘Service
Worker 状态: activate’); const cachePromise = caches.keys().then((keys)
=> { return Promise.all(keys.map((key) => { if (key !== cacheName
&& key !== apiCacheName) { return caches.delete(key); } return null;
})); }); e.waitUntil(cachePromise); // 迅速度与激情活 sw,使其能够响应 fetch
事件 return self.clients.claim(); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
self.addEventListener(‘activate’, (e) => {
  console.log(‘Service Worker 状态: activate’);
  const cachePromise = caches.keys().then((keys) => {
    return Promise.all(keys.map((key) => {
      if (key !== cacheName && key !== apiCacheName) {
        return caches.delete(key);
      }
      return null;
    }));
  });
  e.waitUntil(cachePromise);
  // 快速激活 sw,使其能够响应 fetch 事件
  return self.clients.claim();
});

生龙活虎部分作品说还亟需在 install
事件中增多 self.skipWaiting(); 来跳过等待时间,可是自身在实行中发掘固然不增多也得以健康激活
service worker,原因未知,有读者领会的话可以调换下。

于今当你首先次加载页面,跳转路由,立即离线访谈的页面,也得以安枕而卧地加载页面了。

小结

现今,相信你若是依照本文一步一步操作下来,你也得以连忙把温馨的Web应用转为PWA。在转为了PWA后,假设有选取满意PWA
模型的前端控件的供给,你能够推行纯前端表格控件SpreadJS,适用于
.NET、Java 和移动端等平台的表格控件一定不会让你失望的。

原稿链接:

1 赞 1 收藏
评论

图片 14

绝不强缓存 sw.js

顾客每回访问页面包车型客车时候都会去重新得到sw.js,依照文件内容跟早前的本子是或不是黄金时代律来判别 service worker
是不是有更新。所以豆蔻梢头旦您对 sw.js
开启强缓存的话,就将深陷死循环,因为每便页面拿到到的 sw.js
未有不相同,这样就不能够进步你的 service worker。

除此以外对 sw.js 开启强缓存也是一贯不要求的:

  1. 本人 sw.js
    文件自己就极小,浪费不了多少带宽,以为浪费能够选用左券缓存,但附加增添花销担任
  2. sw.js 是在页面空闲的时候才去加载的,并不会耳熏目染顾客首屏渲染速度

幸免改动 sw 的 U福睿斯L

在 sw 中如此做是“最差实行”,要在原地方上改过 sw。

比世尊声明为啥:

  1. index.html 注册了 sw-v1.js 作为 sw
  2. sw-v1.js 对 index.html 做了缓存,也便是缓存优先(offline-first卡塔 尔(英语:State of Qatar)
  3. 你更新了 index.html 重新注册了在新鸿基土地资产方的 sw sw-v2.js

只要您像上边那么做,顾客永世也拿不到 sw-v2.js,因为 index.html 在
sw-v1.js 缓存中,那样的话,假使您想翻新为 sw-v2.js,还索要转移原本的
sw-v1.js。

测试

其后,大家早就达成了接纳 service worker
对页面实行离线缓存的成效,假设想心得效果的话,访谈笔者的博客:

随便浏览任性的页面,然后关掉互联网,再一次访谈,此前您浏览过的页面都得以在离线的事态下开展访谈了。

IOS 必要 11.3 的本子才支撑,使用 Safari 举办访问,Android 请选取扶助service worker 的浏览器

manifest 桌面应用

前边说罢了怎么利用 service worker 来离线缓存你的同构应用,不过 PWA
不止限于此,你仍然是能够选拔安装 manifest
文件来将您的站点加多到运动端的桌面上,进而到达趋近于原生应用的经历。

使用 webpack-pwa-manifest 插件

自家的博客站点是经过 webpack 来营造前端代码的,所以本人在社区里找到
webpack-pwa-manifest 插件用来生成 manifest.json。

率先安装好 webpack-pwa-manifest 插件,然后在你的 webpack
配置文件中加多:

// webpack.config.prod.js const WebpackPwaManifest =
require(‘webpack-pwa-manifest’); module.exports =
webpackMerge(baseConfig, { plugins: [ new WebpackPwaManifest({ name:
‘Lindz’s Blog’, short_name: ‘Blog’, description: ‘An isomorphic
progressive web blog built by React & Node’, background_color: ‘#333’,
theme_color: ‘#333’, filename: ‘manifest.[hash:8].json’, publicPath:
‘/’, icons: [ { src: path.resolve(constants.publicPath, ‘icon.png’),
sizes: [96, 128, 192, 256, 384, 512], // multiple sizes destination:
path.join(‘icons’) } ], ios: { ‘apple-mobile-web-app-title’: ‘Lindz’s
Blog’, ‘apple-mobile-web-app-status-bar-style’: ‘#000’,
‘apple-mobile-web-app-capable’: ‘yes’, ‘apple-touch-icon’:
‘//xxx.com/icon.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
// webpack.config.prod.js
const WebpackPwaManifest = require(‘webpack-pwa-manifest’);
module.exports = webpackMerge(baseConfig, {
  plugins: [
    new WebpackPwaManifest({
      name: ‘Lindz’s Blog’,
      short_name: ‘Blog’,
      description: ‘An isomorphic progressive web blog built by React & Node’,
      background_color: ‘#333’,
      theme_color: ‘#333’,
      filename: ‘manifest.[hash:8].json’,
      publicPath: ‘/’,
      icons: [
        {
          src: path.resolve(constants.publicPath, ‘icon.png’),
          sizes: [96, 128, 192, 256, 384, 512], // multiple sizes
          destination: path.join(‘icons’)
        }
      ],
      ios: {
        ‘apple-mobile-web-app-title’: ‘Lindz’s Blog’,
        ‘apple-mobile-web-app-status-bar-style’: ‘#000’,
        ‘apple-mobile-web-app-capable’: ‘yes’,
        ‘apple-touch-icon’: ‘//xxx.com/icon.png’,
      },
    })
  ]
})

简单易行地阐释下布署信息:

  1. name: 应用名称,正是Logo下边包车型大巴显得名称
  2. short_name: 应用名称,但 name 无法展现完全时候则展现那一个
  3. background_color、theme_color:断章取义,相应的颜料
  4. publicPath: 设置 cdn 路径,跟 webpack 里的 publicPath 一样
  5. icons: 设置Logo,插件会自动帮你转移区别 size
    的图纸,可是图片大小必需高于最大 sizes
  6. ios: 设置在 safari 中哪些去增多桌面应用

安装完事后,webpack 会在构建进度中变化对应的 manifest 文件,并在 html
文件中引用,下边正是生成 manifest 文件:

{ “icons”: [ { “src”:
“/icons/icon_512x512.79ddc5874efb8b481d9a3d06133b6213.png”, “sizes”:
“512×512”, “type”: “image/png” }, { “src”:
“/icons/icon_384x384.09826bd1a5d143e05062571f0e0e86e7.png”, “sizes”:
“384×384”, “type”: “image/png” }, { “src”:
“/icons/icon_256x256.d641a3644ce20c06855db39cfb2f7b40.png”, “sizes”:
“256×256”, “type”: “image/png” }, { “src”:
“/icons/icon_192x192.8f11e077242cccd9c42c0cbbecd5149c.png”, “sizes”:
“192×192”, “type”: “image/png” }, { “src”:
“/icons/icon_128x128.cc0714ab18fa6ee6de42ef3d5ca8fd09.png”, “sizes”:
“128×128”, “type”: “image/png” }, { “src”:
“/icons/icon_96x96.dbfccb1a5cef8093a77c079f761b2d63.png”, “sizes”:
“96×96”, “type”: “image/png” } ], “name”: “Lindz’s Blog”,
“short_name”: “Blog”, “orientation”: “portrait”, “display”:
“standalone”, “start_url”: “.”, “description”: “An isomorphic
progressive web blog built by React & Node”, “background_color”:
“#333”, “theme_color”: “#333” }

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
{
  "icons": [
    {
      "src": "/icons/icon_512x512.79ddc5874efb8b481d9a3d06133b6213.png",
      "sizes": "512×512",
      "type": "image/png"
    },
    {
      "src": "/icons/icon_384x384.09826bd1a5d143e05062571f0e0e86e7.png",
      "sizes": "384×384",
      "type": "image/png"
    },
    {
      "src": "/icons/icon_256x256.d641a3644ce20c06855db39cfb2f7b40.png",
      "sizes": "256×256",
      "type": "image/png"
    },
    {
      "src": "/icons/icon_192x192.8f11e077242cccd9c42c0cbbecd5149c.png",
      "sizes": "192×192",
      "type": "image/png"
    },
    {
      "src": "/icons/icon_128x128.cc0714ab18fa6ee6de42ef3d5ca8fd09.png",
      "sizes": "128×128",
      "type": "image/png"
    },
    {
      "src": "/icons/icon_96x96.dbfccb1a5cef8093a77c079f761b2d63.png",
      "sizes": "96×96",
      "type": "image/png"
    }
  ],
  "name": "Lindz’s Blog",
  "short_name": "Blog",
  "orientation": "portrait",
  "display": "standalone",
  "start_url": ".",
  "description": "An isomorphic progressive web blog built by React & Node",
  "background_color": "#333",
  "theme_color": "#333"
}

html 中会征引那一个文件,况兼拉长对 ios 增多桌面应用的协理,犹如这么。

<!DOCTYPE html> <html lang=en> <head> <meta
name=apple-mobile-web-app-title content=”Lindz’s Blog”> <meta
name=apple-mobile-web-app-capable content=yes> <meta
name=apple-mobile-web-app-status-bar-style content=#838a88> <link
rel=apple-touch-icon href=xxxxx> <link rel=manifest
href=/manifest.21d63735.json> </head> </html>

1
2
3
4
5
6
7
8
9
10
<!DOCTYPE html>
<html lang=en>
<head>
  <meta name=apple-mobile-web-app-title content="Lindz’s Blog">
  <meta name=apple-mobile-web-app-capable content=yes>
  <meta name=apple-mobile-web-app-status-bar-style content=#838a88>
  <link rel=apple-touch-icon href=xxxxx>
  <link rel=manifest href=/manifest.21d63735.json>
</head>
</html>

就这样轻巧,你就能够运用 webpack 来加多你的桌面应用了。

测试

加多完之后你能够通过 chrome 开垦者工具 Application – Manifest 来查看你的
mainfest 文件是不是见到成效:

图片 16

如此这般表明您的配置生效了,安卓机缘自动识别你的配备文件,并驾驭客户是或不是丰富。

结尾

讲到那基本上就完了,等随后 IOS 帮助 PWA
的任何效用的时候,届期候作者也会相应地去推行其余 PWA 的风味的。以后 IOS
11.3 也仅仅扶植 PWA 中的 service worker 和 app manifest
的效劳,可是相信在不久的未来,其余的效率也会相应获得辅助,届时候相信 PWA
将会在活动端绽开异彩的。

1 赞 收藏
评论

图片 14

发表评论

电子邮件地址不会被公开。 必填项已用*标注