首页手记 Workbox3 - ServiceWorker可以如此简单

Workbox3 - ServiceWorker可以如此简单

标签：

Html5 JavaScript 前端工具

如果你追求极致的WEB体验，你一定在站点中使用过PWA，也一定面临过在编写serviceWorker代码时的犹豫不决，因为serviceWorker太重要了，一旦注册在用户的浏览器，全站的请求都会被serviceWorker控制，一不留神，小问题也成了大问题了。不过到了现在有了Workbox 3，一切关于serviceWorker都不再是问题。

科普ServiceWorker

如果你已经熟悉ServiceWorker，可以跳过此段。

ServiceWorker是PWA中最重要的一部分，它是一个网站安插在用户浏览器中的大脑。ServiceWorker是这样被注册在页面上的

if ('serviceWorker' in navigator) {
  navigator.serviceWorker.register('/sw.js')
}

为什么说SW（下文将ServiceWorker简称为SW）是网站的大脑？举个例子，如果在www.example.com的根路径下注册了一个SW，那么这个SW将可以控制所有该浏览器向www.example.com站点发起的请求。只需要监听fetch事件，你就可以任意的操纵请求，可以返回从cacheStorage中读的数据，也可以通过fetch API发起新的请求，甚至可以new一个Response，返回给页面。

// 一段糟糕的sw代码，在这个SW注册好以后，整个SW控制站点的所有请求返回的都将是字符串"bad"，包括页面的HTML
self.addEventListener('fetch', function(event) {
  event.respondWith(
    new Response('bad')
  );
});

就是因为SW权利太大了，写起来才会如履薄冰，一不小心有些页面资源就不能及时正确的更新了。

一个还算完整ServiceWorker

先来看一个直接手写的SW文件

var cacheStorageKey = 'cachesName'
var cacheList = [
  // 注册成功后要立即缓存的资源列表
]

// 当浏览器解析完sw文件时触发install事件
self.addEventListener('install', function(e) {
  // install事件中一般会将cacheList中要换存的内容通过addAll方法，拉一遍放入caches中
  e.waitUntil(
    caches.open(cacheStorageKey).then(function(cache) {
      return cache.addAll(cacheList)
    })
  )
})

// 激活时触发activate事件
self.addEventListener('activate', function(e) {
  // active事件中通常做一些过期资源释放的工作，匹配到就从caches中删除
  var cacheDeletePromises = caches.keys().then(cacheNames => {
    return Promise.all(cacheNames.map(name => {
      if (name !== cacheStorageKey) {
        return caches.delete(name);
      } else {
        return Promise.resolve();
      }
    }));
  });

  e.waitUntil(
    Promise.all([cacheDeletePromises])
  )
})

self.addEventListener('fetch', function(e) {
  // 在此编写缓存策略
  e.respondWith(
    // 可以通过匹配缓存中的资源返回
    caches.match(e.request)
    // 也可以从远端拉取
    fetch(e.request.url)
    // 也可以自己造
    new Response('自己造')
    // 也可以通过吧fetch拿到的响应通过caches.put方法放进chches
  )
})

其实所有站点SW的install和active都差不多，无非是做预缓存资源列表，更新后缓存清理的工作，逻辑不太复杂，而重点在于fetch事件。上面的代码，我把fetch事件的逻辑省略了，因为如果认真写的话，太多了，而且也不利于讲明白缓存策略这件事。想象一下，你需要根据不同文件的扩展名把不同的资源通过不同的策略缓存在caches中，各种css，js，html，图片，都需要单独搞一套缓存策略，你就知道fetch中需要写多少东西了吧。

Workbox 3

workbox的出现就是为了解决上面的问题的，它被定义为PWA相关的工具集合，其实围绕它的还有一些列工具，如workbox-cli、gulp-workbox、webpack-workbox-plagin等等，不过他们都不是今天的重点，今天想聊的就是workbox本身。

其实可以把workbox理解为Google官方PWA框架，它解决的就是用底层API写PWA太过复杂的问题。这里说的底层API，指的就是去监听SW的install, active, fetch事件做相应逻辑处理等。使用起来是这样的

// 首先引入workbox框架
importScripts('https://storage.googleapis.com/workbox-cdn/releases/3.3.0/workbox-sw.js');
workbox.precaching([
  // 注册成功后要立即缓存的资源列表
])

// html的缓存策略
workbox.routing.registerRoute(
  new RegExp(''.*\.html'),
  workbox.strategies.networkFirst()
);

workbox.routing.registerRoute(
  new RegExp('.*\.(?:js|css)'),
  workbox.strategies.cacheFirst()
);

workbox.routing.registerRoute(
  new RegExp('https://your\.cdn\.com/'),
  workbox.strategies.staleWhileRevalidate()
);

workbox.routing.registerRoute(
  new RegExp('https://your\.img\.cdn\.com/'),
  workbox.strategies.cacheFirst({
    cacheName: 'example:img'
  })
);

上面的代码理解起来就容易的多了，通过workbox.precaching中的是install以后要塞进caches中的内容，workbox.routing.registerRoute中第一个参数是一个正则，匹配经过fetch事件的所有请求，如果匹配上了，就走相应的缓存策略workbox.strategies对象为我们提供了几种最常用的策略，如下