ワークボックス SW

workbox-sw モジュールを使用すると、非常に簡単に起動して実行できます。 Workbox モジュールと統合し、Workbox モジュールの読み込みを簡素化します。 簡単なヘルパー メソッドを提供します。

workbox-sw は、Google の CDN 経由で使用するか、一連のワークボックス ファイルと組み合わせて使用できます。 独自のサーバー上で実行できます

CDN 経由で Workbox SW を使用する

このモジュールを使用する最も簡単な方法は CDN 経由です。必要なのは、 Service Worker に以下を追加します。

importScripts(
  'https://storage.googleapis.com/workbox-cdn/releases/6.4.1/workbox-sw.js'
);

これにより、Service Worker に workbox 名前空間が作成されます。 ワークボックス モジュールすべてにアクセスできます。

workbox.precaching.*
workbox.routing.*
etc

追加のモジュールを使い始めると、いくつか不思議なことが起きます。

モジュールを初めて参照する場合、workbox-sw がこれを検出します 利用可能にする前にモジュールを読み込みます。これについては [Network] タブを開きます。

DevTools でのワークボックス ライブラリの読み込み

これらのファイルはブラウザによってキャッシュに保存され、後で利用できるようになります オフラインで使用できます。

CDN の代わりにローカル ワークボックス ファイルを使用する

CDN を使用したくない場合は、簡単にワークボックス ファイルに切り替えることができる 独自のドメインでホストできます

最も簡単な方法は、workbox-cli の copyLibraries コマンドでファイルを取得して、 workbox-sw で、modulePathPrefix 構成オプションを使用してこれらのファイルを見つける場所。

ファイルを /third_party/workbox-vX.Y.Z/ に配置する場合は、次のように使用します。

importScripts('/third_party/workbox-vX.Y.Z/workbox-sw.js');

workbox.setConfig({
  modulePathPrefix: '/third_party/workbox-vX.Y.Z/',
});

非同期インポートの回避

新しいモジュールを初めて読み込む際、内部的には importScripts() を、対応する JavaScript ファイルのパス（CDN でホストされているか、ローカル URL 経由）に置き換えます。 いずれの場合も、重要な制限が適用されます。importScripts() の暗黙的な呼び出しは、 Service Worker の install ハンドラの内部または Service Worker スクリプトの初回実行。

この制限に違反しないように、ベスト プラクティスとして、 イベント ハンドラや非同期関数の外部にある workbox.* 名前空間。

たとえば、次のトップレベルの Service Worker コードは問題ありません。

importScripts(
  'https://storage.googleapis.com/workbox-cdn/releases/6.4.1/workbox-sw.js'
);

// This will work!
workbox.routing.registerRoute(
  ({request}) => request.destination === 'image',
  new workbox.strategies.CacheFirst()
);

しかし、プロジェクトのどこかで workbox.strategies を参照していない場合、以下のコードは問題となる可能性があります。 Service Worker:

importScripts(
  'https://storage.googleapis.com/workbox-cdn/releases/6.4.1/workbox-sw.js'
);

self.addEventListener('fetch', event => {
  if (event.request.url.endsWith('.png')) {
    // Oops! This causes workbox-strategies.js to be imported inside a fetch handler,
    // outside of the initial, synchronous service worker execution.
    const cacheFirst = new workbox.strategies.CacheFirst();
    event.respondWith(cacheFirst.handle({request: event.request}));
  }
});

この制限に反するようなコードを記述する必要がある場合は、 イベント ハンドラの外部で importScripts() 呼び出しをトリガーする workbox.loadModule() メソッド:

importScripts(
  'https://storage.googleapis.com/workbox-cdn/releases/6.4.1/workbox-sw.js'
);

// This will trigger the importScripts() for workbox.strategies and its dependencies:
workbox.loadModule('workbox-strategies');

self.addEventListener('fetch', event => {
  if (event.request.url.endsWith('.png')) {
    // Referencing workbox.strategies will now work as expected.
    const cacheFirst = new workbox.strategies.CacheFirst();
    event.respondWith(cacheFirst.handle({request: event.request}));
  }
});

または、イベント ハンドラの外部に、関連する名前空間への参照を作成することもできます。 後でその参照を使用します。

importScripts(
  'https://storage.googleapis.com/workbox-cdn/releases/6.4.1/workbox-sw.js'
);

// This will trigger the importScripts() for workbox.strategies and its dependencies:
const {strategies} = workbox;

self.addEventListener('fetch', event => {
  if (event.request.url.endsWith('.png')) {
    // Using the previously-initialized strategies will work as expected.
    const cacheFirst = new strategies.CacheFirst();
    event.respondWith(cacheFirst.handle({request: event.request}));
  }
});

デバッグビルドまたは本番環境ビルドを強制的に使用する

すべての Workbox モジュールには 2 つのビルドが付属しています。1 つはデバッグビルドです。 ロギング、追加の型チェック、本番環境ビルドが含まれています。 ロギングと型チェックが取り除かれます。

デフォルトでは、workbox-sw は localhost 上のサイトに対してデバッグビルドを使用しますが、 それ以外のオリジンには 製品版ビルドを使用します

デバッグビルドまたは本番環境ビルドを強制的に使用する場合は、debug 構成を設定します。 オプション:

workbox.setConfig({
  debug: true,
});

workbox-sw を使用するように import ステートメントを使用してコードを変換する

workbox-sw を使用して Workbox を読み込むと、すべての Workbox パッケージに以下でアクセスします。 グローバルな workbox.* 名前空間。

変換する import ステートメントを使用するコードサンプルがある場合 workbox-sw を使用するには、workbox-sw を読み込んで、すべての import ステートメントを参照するローカル変数に置き換えるだけです。 名前空間に配置されます。

npm に公開されるすべての Workbox Service Worker パッケージもすべて グローバル workbox 名前空間で、 名前の camelCase バージョン（例: workbox-precaching npm パッケージからエクスポートされたすべてのモジュールは次の場所にあります。 workbox.precaching.*。また、Terraform からエクスポートされたすべてのモジュールは、 workbox-background-sync npm パッケージは次の場所にあります。 workbox.backgroundSync.*）。

例として、import ステートメントを使用して参照するコードの例を次に示します。 ワークボックス モジュール:

import {registerRoute} from 'workbox-routing';
import {CacheFirst} from 'workbox-strategies';
import {CacheableResponse} from 'workbox-cacheable-response';

registerRoute(
  ({request}) => request.destination === 'image',
  new CacheFirst({
    plugins: [new CacheableResponsePlugin({statuses: [0, 200]})],
  })
);

また、同じコードを workbox-sw を使用するように書き換えています（ import ステートメントが変更されており、ロジックは変更されていません）。

importScripts(
  'https://storage.googleapis.com/workbox-cdn/releases/6.4.1/workbox-sw.js'
);

const {registerRoute} = workbox.routing;
const {CacheFirst} = workbox.strategies;
const {CacheableResponse} = workbox.cacheableResponse;

registerRoute(
  ({request}) => request.destination === 'image',
  new CacheFirst({
    plugins: [new CacheableResponsePlugin({statuses: [0, 200]})],
  })
);