前端工程化->使用Service Worker和离线缓存Cache(转载)

今天在用create-react-app构建项目的时候发现多了一个serviceWorker做离线缓存的选项。

(1)什么是Service Worker

Service Worker是一个注册在指定源和路径下的事件驱动 worker。它采用JavaScript控制关联的页面或者网站,拦截并修改访问和资源请求,细粒度地缓存资源。你可以完全控制应用在特定情形(最常见的情形是离线)下的表现。

Service Worker运行在worker上下文,因此它不能访问DOM。相对于驱动应用的主JavaScript线程,它运行在其他线程中,所以不会造成阻塞。它设计为完全异步,同步API(如XHRlocalStorage)不能在service worker中使用。

出于安全考量,Service workers只能由HTTPS承载,毕竟修改网络请求的能力暴露给中间人攻击会非常危险。

为什么不直接用web worker?

Web Worker 是临时的,每次做的事情的结果还不能被持久存下来,如果下次有同样的复杂操作,还得费时间的重新来一遍。那我们能不能有一个Worker 是一直持久存在的,并且随时准备接受主线程的命令。基于这样的需求推出了最初版本的 Service WorkerService WorkerWeb Worker 的基础上加上了持久离线缓存能力。

Service Worker 之前也有一个在 HTML5 上做离线缓存的 API 叫 AppCache, 但是 AppCache 就是一坨shit(别人说的)。W3C 决定 AppCache 仍然保留在 HTML 5.0 Recommendation 中,在 HTML 后续版本中移除。

(2)使用Service Worker

上面说到 Service Worker 必须使用https协议,但本地开发弄个https协议是很麻烦的。好在还算人性化,Service Worker在http://localhost或者http://127.0.0.1这种本地环境下的时候是可以跑起来的。

这里我推荐一个经常使用的npm工具,用来开启本地服务:live-server

1.注册worker

就像使用web worker那样,先创建两个文件serviceWorker.html、serviceWorker.js

serviceWorker.html:

<script type="text/javascript">

    if ('serviceWorker' in navigator) {
        window.addEventListener('load', function () {
            navigator.serviceWorker.register('./serviceWorker.js', {scope: './'})
                .then(function (registration) {

                    console.log('ServiceWorker registration successful with scope: ', registration.scope);
                })
                .catch(function (err) {

                    console.log('ServiceWorker registration failed: ', err);
                });
        });
    }

</script>

  1. 首先在注册之前确保浏览器是支持 service worker 的。
  2. 接着,我们使用 ServiceWorkerContainer.register() 函数来注册serviceWorker.js
  3. scope 参数是可选的,可以用来指定你想让 service worker 控制的内容的子目录。 在这个例子里,我们指定了 '/',表示 根网域下的所有内容。这也是默认值。
  4. 函数返回一个Promise,注册成功时执行.then(),失败时执行.catch()
2.安装worker

serviceWorker.js:

this.addEventListener('install', function (event) {

    event.waitUntil(
        caches.open('v1').then(function (cache) {
            return cache.addAll([
                './index.html'
            ]);
        })
    );
});

install 事件会在worker安装完成后触发。install 事件一般是被用来设置你的浏览器的离线缓存能力。这里就用到了离线缓存Cache了。

  1. 这里我们 新增了一个 install 事件监听器,接着event对象调用了ExtendableEvent.waitUntil() 方法——这会确保Service Worker 不会在 waitUntil() 里面的代码执行完毕之前就安装完成。(这个方法扩展了事件的生命周期。在service worker线程中,延长事件的寿命从而阻止浏览器在事件中的异步操作完成之前终止service worker线程。)

  2. waitUntil() 里,我们使用了caches.open() 方法来创建了一个叫做 v1 的新的缓存,这是我们的站点资源缓存的第一个版本。它返回了一个创建缓存的 promise。当它 resolved的时候,我们接着会调用创建的缓存上的 addAll() 方法 ,这个方法的参数是一个数组,每个元素是相对于根域的 URL,这些 URL 就是你要缓存的资源的路径。(这里我就缓存了一个index.html)

  3. 如果 promise 被 rejected,安装就会失败,这个 worker 不会做任何事情。

当启动服务运行后,可以看到:

image

打开缓存,也可以看到index.html被缓存了:

image

(3)fetch API

现在已经将index.html缓存了,你要告诉 service worker 怎么用这些缓存。这就要用到 fetch 事件。

给 service worker 添加一个 fetch 的事件监听器,接着调用 event 上的 respondWith() 方法来劫持我们的 HTTP 请求,然后你用可以用自己的方式来更新。

this.addEventListener('fetch', function(event) {
  event.respondWith(
    // magic goes here
  );
});

这里最简单的做法就是,原原本本的返回与url匹配的缓存资源。

this.addEventListener('fetch', function(event) {
  event.respondWith(
    caches.match(event.request)
  );
});

caches.match(event.request)允许我们将网络请求的资源和 cache 里可获取的资源进行匹配,查看是否缓存中有相应的资源。这个匹配通过 url 和各种header进行,就像正常的 http 请求一样。

原来的翻译多了个;号,难怪我复制后会报错,现在已经被我改过来了。

现在,就可以打开控制台断开你的网络,离线。再次访问index.html
可以发现还是ok的。

上面是最简单的例子,当缓存中没有匹配的资源时,或当缓存中没有匹配的资源,同时网络也不可用时。更多详情就直接看MDN吧。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342