angular service worker搭配workbox使用

原文链接
略过前言直接进入主题

什么是 Service Worker?

Service Worker是一个相对较新的技术,用于在应用中运行执行Javascript代码,即使用户还没有打开页面。通过它我们可以在浏览器中注册代码片段、对某些事件进行处理,甚至在我们的例子中,可以对请求进行缓存生成离线应用。

service worker可以设想成浏览器域名下的一个代理,流量通过Service Worker分发,Worker决定数据是从缓存还是从网络获取。缓存是通过service worker API接口定义的,我们可以通过service worker定制自己的缓存策略。

今天我们不打算这样做,事实上,自己实现缓存非常麻烦。幸运的是我们不需要自己造轮子,已经有可用的库提供高级的接口来实现我们需求。本文中我们使用谷歌的Workbox

不是所有的浏览器都支持service worker,但是它们都宣称未来会支持

为什么选择 Workbox?

angular-cli集成了service worker,在angular-cli配置service worker非常容易

新建 angular 项目

ng new angular-service-worker

使用npm i加载依赖

下一步,下载Workbox build API

npm i workbox-build --save-dev

环境以及搭建完成。

为 angular 项目搭建一个 Service Worker 缓存

我们以及下载了Workbox build API,接下来我们就可以去生成angular service worker,为什么我们要生成一个,而不是通过代码配置?

要缓存静态文件,service worker需要知道其文件名,使用 angular-cli 构建项目的时候,目标文件名每次都会改变,angular-cli 在文件名上加了hash值,浏览器可以为新文件作缓存又避免就文件缓存影响

目标文件名每次都会改变,我们无法在 worker-script 去配置,那样每次构建完都要去更改配置,所以我们使用Workbox build API 接口实现。

Workbox build API 允许我们通过 node.js 脚本文件扫描目标文件目录生成 service worker 脚本文件,目标文件大概这样:
dist/sw.js

...
const fileManifest = [
  {
    "url": "index.html",
    "revision": "2a59e6e03216061ad8eebe5d302b63be"
  },
  {
    "url": "inline.5f8f26e0d9e0b566019d.bundle.js",
    "revision": "590f7d098ab30195f9f4761bf79ec18c"
  },
  {
    "url": "main.c0c528c8c7636a1ce8fc.bundle.js",
    "revision": "f1646bf6ca91be91e46d35a173846e5b"
  },
  {
    "url": "polyfills.67d068662b88f84493d2.bundle.js",
    "revision": "ad4076ac41e8c08e5b5f872136081192"
  },
  {
    "url": "styles.d41d8cd98f00b204e980.bundle.css",
    "revision": "d41d8cd98f00b204e9800998ecf8427e"
  },
  {
    "url": "vendor.dd97be8fb65ee0109dba.bundle.js",
    "revision": "dad8873f5866215d28f6a9d07764de3b"
  }
];
workboxSW.precache(fileManifest);
...

缓存静态内容

现在我们开始写脚本文件,我们在项目根目录下新建一个 generate-service-worker.js 文件

const build = require("workbox-build");
const SRC_DIR = "./";
const BUILD_DIR = "dist";

const options = {
  swDest: `${BUILD_DIR}/sw.js`, // target directory
  globDirectory: BUILD_DIR,
  navigateFallback: "/index.html", // redirect all reqest to the fallback, if no explicit route matches
  clientsClaim: true
};

build.generateSW(options).then(() => {
  console.log("Generated service worker with static cache");
});

这段脚本代码中,我们定义了一些变量并将其传递给 builder 的 generateSW 方法,然后 builder 在 BUILD_DIR 指定的目录下创建 service worker 文件

基本就是这样,依靠 angular 生成的 service worker 会缓存所有静态文件。然而,大多数应用程序依赖动态内容,动态内容此时还没被缓存

缓存动态内容

要缓存动态内容,我们需要告诉 Workbox 内容来源,比如说我们有一个接口地址,它提供与应用程序同域下的内容,缓存这类内容,我们需要使用 Workbox builder 的 runtimeCaching 方法,举例说明:
generate-service-worker.js

const options = {
  swDest: `${BUILD_DIR}/sw.js`,
  globDirectory: BUILD_DIR,
  navigateFallback: "/index.html",
  clientsClaim: true,
  runtimeCaching: [
    {
      urlPattern: //api/(.*)/, // reg ex
      handler: "networkFirst" // caching strategy
    }
  ],
  handleFetch: true
};

现在,所有/api/* 下的数据都会被缓存

缓存策略

你还可以定义不同的缓存策略,这是缓存策略

拓展 Service Worker

更多时候,builder 提供的选项不满足我们的应用场景, 比如推送通知缓存到 service worker. 好在service worker 提供用户自定义选项,builder 会通过swSource属性合并两份文件成一个 service worker.
generate-service-worker.js

const options = {
  swSource: `${SRC_DIR}/service-worker.js`,
  swDest: `${BUILD_DIR}/sw.js`,
  globDirectory: BUILD_DIR,
  navigateFallback: "/index.html",
  clientsClaim: true,
  runtimeCaching: [
    {
      urlPattern: //api/(.*)/, // reg ex
      handler: "networkFirst" // caching strategy
    }
  ],
  handleFetch: true
};

同时我们将方法名从generateSW() 改为 injectManifest()
generate-service-worker.js

build.injectManifest(options).then(() => {
    
});

为 Service Worker 配置构建脚本

到这一步,使用 Workbox 不会比 使用 angular-cli service worker 复杂

要想在构建时自动生成 generate-service-worker.js ,我们需要手动在构建脚本关联 service worker。

有一个办法是定制angular-cli 使用 Workbox Webpack pluign,这个可以让 generate-service-worker.js 运行良好,但会破坏angular-cli结构

我们可以在运行 "npm start" 启动项目的时候,通过 express 运行 node.js 脚本,这两个都不算是最佳方案,如果你更好的方案,请联系我
这是 npm package.json

...
"scripts": {
    "ng": "ng",
    "start": "ng build --prod && npm run gn-sw && node server/server.js",
    "build": "ng build --prod && npm run gn-sw",
    "test": "ng test",
    "lint": "ng lint",
    "e2e": "ng e2e",
    "gn-sw": "node generate-service-worker.js"
  },
...

const express = require("express");
const app = express();

app.use(express.static(__dirname + "/../dist/"));

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

推荐阅读更多精彩内容

  • 原文 这一页是关于部署和支持使用Angular service worker的生产版本应用。解析了Angular ...
    Gary嘉骏阅读 1,511评论 0 0
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,656评论 18 139
  • Angular CLI 是什么? Angular CLI 是一个命令行接口(Command Line Interf...
    semlinker阅读 4,187评论 0 39
  • 原文 前期准备 如下的基础知识: Angular service workers介绍. 从5angular.0.0...
    Gary嘉骏阅读 2,948评论 0 2
  • ——四叶草好像也不能带来幸运,是的,每一份幸运后面都有精致的生活,我们真的没有必要羡慕别人的生活,毕竟上帝分配给每...
    2018快乐wy阅读 308评论 0 0