>

离线网页应用,入门教程

- 编辑:至尊游戏网站 -

离线网页应用,入门教程

利用 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 应用程式的缺点:

(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)主旨的一项专门的学问,对于生态比较密封的Safari来讲也是迫于时局初步盘算扶助了,在Safari TP版本,能够看见:

图片 4

在尝试成效(Experimental Features)里早就有ServiceWorker的菜单项了,只是纵然展开也是不能够用,会唤醒您还尚未兑现:

图片 5

但不管什么,起码表达Safari已经希图扶植ServiceWorker了。此外仍能看到在二〇一四年二零一七年三月发布的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: U大切诺基L范围。譬如:借令你将“/app/”设置为U瑞虎L范围时,那几个应用就能一贯在这里个目录中。
  • 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: 三个分包全部图片的数组。该数组中每种成分富含了图片的URAV4L,大小和类型。

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)注册四个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文件就是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. 二个离线的页面地址(offlineUTiguanL):当客户访谈了前头从没访谈过的地方时,该页面将会展现。
  3. 一个包含了具有必得文件的数组,包蕴保持页面平常机能的CSS和JavaScript。在本示例中,小编还增加了主页和logo。当有分裂的UXC90L指向同一个能源时,你也得以将那些URAV4L分别写到这几个数组中。offlineUCR-VL将会参预到那一个数组中。
  4. 咱俩也得以将一些非须求的缓存文件(installFilesDesirable)。那一个文件在安装进程准将会被下载,但假诺下载战败,不会接触安装退步。

// 配置文件 const version = '1.0.0', CACHE = version + '::PWAsite', offlineULANDL = '/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)瑟维斯 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事件非亲非故)。获取到的财富将会加入到缓存中。
  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开关。

(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就设置好了,他刷新页面恐怕张开第1个页面包车型地铁时候就能够把央浼的能源一一做缓存,包罗图片、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 中以版本号为名称保存了不久前的缓存,获取具备UENCOREL,删除不是页面包车型大巴U智跑L,将这么些U揽胜极光L排序然后将全体缓存的UOdysseyL映未来页面上:

// 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又用瑟维斯Worker的话应该会导致同多个能源存了五次。不过足以让扶植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": "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指向的页面用ServiceWorker缓存起来,那样当客商用Chrome浏览器展开这些网页的时候,Chrome就能够在尾部弹四个唤起,询问客户是还是不是把这么些网页增添到桌面,倘使点“加多”就能调换叁个桌面图标,从那几个Logo点进去就疑似张开一个App同样。感受如下:

图片 9

相比狼狈的是Manifest近日唯有Chrome援救,何况不得不在安卓系统上应用,IOS的浏览器不能加多多个桌面Logo,因为IOS未有开放这种API,可是自个儿的Safari却又是能够的。

综上,本文介绍了怎么用瑟维斯 Worker结合Manifest做四个PWA离线Web APP,首若是用ServiceWorker调控缓存,由于是写JS,相比较灵敏,还足以与页面实行通讯,别的通过诉求页面包车型客车立异时间来推断是还是不是须求革新html缓存。ServiceWorker的包容性不是特地好,不过前景相比较光明,浏览器都在备选支持。现阶段得以整合offline cache的Manifest做离线应用。

连带阅读:

  1. 缘何要把网址晋级到HTTPS
  2. 怎么样把网址晋级到http/2
  3. 作者是怎么让网址用上HTML5 Manifest

1 赞 1 收藏 评论

图片 10

URL隐藏

当你的使用正是二个单ULANDL的应用程序时(举例游戏),我建议你掩盖地址栏。除了那一个之外的景观笔者并不提议您掩盖地址栏。在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

本文由IT-综合发布,转载请注明来源:离线网页应用,入门教程