入门教程,离线网页应用

行使 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)入门教程(下)

2018/05/25 · 基础手艺 · PWA

初稿出处: Craig Buckler   译文出处:蒲陶城控件   

上篇作品大家对渐进式Web应用(PWA)做了有的中坚的介绍。

渐进式Web应用(PWA)入门教程(上)

在这一节中,大家将介绍PWA的原理是怎么着,它是怎样伊始工业作的。

1. 什么是Service Worker

Service Worker是谷歌(Google)发起的兑现PWA(Progressive Web App)的贰个主重要剧中人物色,PWA是为着消除古板Web APP的毛病:

(1)没有桌面入口

(2)不能够离线使用

(3)没有Push推送

那Service Worker的具体表现是怎样的吧?如下图所示:

图片 1

ServiceWorker是在后台运营的一条服务Worker线程,上海体育场合我开了七个标签页,所以显得了七个Client,但是不管开多少个页面都独有一个Worker在担任管理。那几个Worker的办事是把部分财富缓存起来,然后拦截页面包车型地铁乞请,先看下缓存库里有未有,倘若有个别话就从缓存里取,响应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的帮助处境

Service Worker这段时间只有Chrome/Firfox/Opera帮忙:

图片 3

Safari和Edge也在预备帮衬Service Worker,由于ServiceWorker是谷歌(Google)为主的一项专门的学问,对于生态相比密闭的Safari来讲也是迫于时势开端希图匡助了,在Safari TP版本,能够看来:

图片 4

在推行成效(Experimental Features)里已经有ServiceWorker的菜单项了,只是就算张开也是不可能用,会唤起您还尚无落到实处:

图片 5

但不论怎么,最少申明Safari已经筹划帮助ServiceWorker了。另外还足以看到在当年二〇一七年1月发布的Safari 11.0.1版本已经支撑WebRTC了,所以Safari照旧八个前进的儿女。

Edge也计划帮衬,所以Service Worker的前景拾壹分美好。

第二步:创建二个应用程序清单(Manifest)

应用程序清单提供了和日前渐进式Web应用的相干信息,如:

  • 应用程序名
  • 描述
  • 具备图片(满含主显示屏Logo,运维显示器页面和用的图片也许网页上用的图片)

实质上讲,程序清单是页面上用到的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" : "72x72", "type" : "image/png" }, { "src" : "/images/logo/logo152.png", "sizes" : "152x152", "type" : "image/png" }, { "src" : "/images/logo/logo192.png", "sizes" : "192x192", "type" : "image/png" }, { "src" : "/images/logo/logo256.png", "sizes" : "256x256", "type" : "image/png" }, { "src" : "/images/logo/logo512.png", "sizes" : "512x512", "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"         : "72x72",
      "type"          : "image/png"
    },
    {
      "src"           : "/images/logo/logo152.png",
      "sizes"         : "152x152",
      "type"          : "image/png"
    },
    {
      "src"           : "/images/logo/logo192.png",
      "sizes"         : "192x192",
      "type"          : "image/png"
    },
    {
      "src"           : "/images/logo/logo256.png",
      "sizes"         : "256x256",
      "type"          : "image/png"
    },
    {
      "src"           : "/images/logo/logo512.png",
      "sizes"         : "512x512",
      "type"          : "image/png"
    }
  ]
}

程序清单文件建构完事后,你要求在各类页面上援用该文件:

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

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

以下属性在程序清单中时常应用,介绍表明如下:

  • name: 客商观望的施用名称
  • short_name: 应用短名称。当展现选取名称的地点相当不足时,将运用该名称。
  • description: 利用描述。
  • start_url: 接纳起先路线,相对路线,暗中同意为/。
  • scope: UKugaL范围。举例:纵然你将“/app/”设置为UHavalL范围时,那么些利用就能够一贯在这么些目录中。
  • 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奥迪Q7L,大小和类型。

3. 使用Service Worker

ServiceWorker的选择套路是先注册多个Worker,然后后台就能够运转一条线程,可以在那条线程运行的时候去加载一些财富缓存起来,然后监听fetch事件,在那么些事件里拦截页面包车型客车央浼,先看下缓存里有未有,借使有直接重临,否则平日加载。恐怕是一最初不缓存,每一个财富需要后再拷贝一份缓存起来,然后下三遍呼吁的时候缓存里就有了。

其三步:创立一个 瑟维斯 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。

(1)注册八个瑟维斯 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文件正是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就能够接管页面包车型大巴享有财富了。

Install事件

该事件将要利用设置完结后触发。大家平日在此地运用Cache API缓存一些必需的文书。

先是,大家供给提供如下配置

  1. 缓存名称(CACHE)以及版本(version)。应用能够有八个缓存存款和储蓄,然而在动用时只会动用个中四个缓存存款和储蓄。每当缓存存款和储蓄有生成时,新的版本号将会内定到缓存存款和储蓄中。新的缓存存款和储蓄将会作为当下的缓存存款和储蓄,在此之前的缓存存款和储蓄将会被作废。
  2. 一个离线的页面地址(offlineU奥迪Q5L):当用户访问了事先从未访谈过的地点时,该页面将会展现。
  3. 一个暗含了装有必需文件的数组,满含保持页面符合规律机能的CSS和JavaScript。在本示例中,笔者还加多了主页和logo。当有两样的UPAJEROL指向同多少个财富时,你也足以将那些U凯雷德L分别写到这几个数组中。offlineU帕杰罗L将会投入到那一个数组中。
  4. 我们也足以将一些非须要的缓存文件(installFilesDesirable)。那一个文件在安装进度少将会被下载,但假设下载失败,不会触发安装退步。

// 配置文件 const version = '1.0.0', CACHE = version + '::PWAsite', offlineU奥迪Q5L = '/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())
  );
});

(2)Service Worker安装和激活

登记完未来,ServiceWorker就能够进行安装,那一年会触发install事件,在install事件之中能够缓存一些资源,如下sw-3.js:

JavaScript

const CACHE_NAME = "fed-cache"; this.add伊芙ntListener("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事件非亲非故)。获取到的能源将会投入到缓存中。
  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文件。别的要求将会回来 offlineUMuranoL 页面。

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都同样才是大同小异的财富,可以设定第1个参数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奥迪R18S,那么能够把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 中以版本号为名称保存了近年的缓存,获取具备URubiconL,删除不是页面包车型大巴U奥迪Q3L,将这么些USportageL排序然后将享有缓存的UHavalL彰显在页面上:

// 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.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的多寡恐怕是和最新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为预先,因为ServiceWorker把央浼拦截了,它最早做管理,如果它缓存库里有的话平素再次来到,未有的话不奇怪央浼,就一定于尚未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名称等新闻以便在桌面增加三个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": "48x48" }, { "src": "/html/app-manifest/logo_96.png", "type": "image/png", "sizes": "96x96" }, { "src": "/html/app-manifest/logo_192.png", "type": "image/png", "sizes": "192x192" }, { "src": "/html/app-manifest/logo_512.png", "type": "image/png", "sizes": "512x512" } ], "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": "48x48"
    },
    {
      "src": "/html/app-manifest/logo_96.png",
      "type": "image/png",
      "sizes": "96x96"
    },
    {
      "src": "/html/app-manifest/logo_192.png",
      "type": "image/png",
      "sizes": "192x192"
    },
    {
      "src": "/html/app-manifest/logo_512.png",
      "type": "image/png",
      "sizes": "512x512"
    }
  ],
  "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指向的页面用瑟维斯Worker缓存起来,那样当顾客用Chrome浏览器展开这些网页的时候,Chrome就能够在尾部弹贰个提示,询问客户是或不是把这几个网页增添到桌面,借使点“增加”就能够转移二个桌面Logo,从这些图标点进去就如张开贰个App同样。感受如下:

图片 9

相比为难的是Manifest近日独有Chrome帮忙,并且只好在安卓系统上使用,IOS的浏览器不能增添一个桌面图标,因为IOS未有开放这种API,但是作者的Safari却又是能够的。

综上,本文介绍了怎么用Service Worker结合Manifest做三个PWA离线Web APP,主借使用ServiceWorker调节缓存,由于是写JS,比较灵活,还足以与页面实行通讯,其余通过央浼页面包车型大巴立异时间来推断是不是需求创新html缓存。ServiceWorker的宽容性不是特地好,然而前景相比较光明,浏览器都在备选协助。现阶段得以组成offline cache的Manifest做离线应用。

有关阅读:

  1. 何以要把网址晋级到HTTPS
  2. 哪些把网址晋级到http/2
  3. 本身是怎么着让网址用上HTML5 Manifest

1 赞 1 收藏 评论

图片 10

URL隐藏

当你的施用便是一个单UTiggoL的应用程序时(比如游戏),笔者建议你掩盖地址栏。除却的事态自个儿并不提出您隐敝地址栏。在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 收藏 评论

图片 11

本文由华夏彩票发布于前端技术,转载请注明出处:入门教程,离线网页应用

您可能还会对下面的文章感兴趣: