Angular Service Worker を使用した事前キャッシュ

Angular Service Worker を使用すると、接続が不安定なネットワークでもアプリの速度と信頼性を高めることができます。

接続が制限されている場合

ユーザーのネットワーク アクセスが制限されている、またはまったくアクセスされていない場合、ウェブアプリの機能が大幅に低下し、多くの場合失敗する可能性があります。Service Worker を使用してプリキャッシュ機能を提供すると、ネットワーク リクエストをインターセプトし、ネットワークから取得するのではなく、ローカル キャッシュから直接レスポンスを配信できます。この方法でアプリのアセットをキャッシュすると、アプリの速度が大幅に向上し、ユーザーがオフラインでもアプリを動作させることができます。

この投稿では、Angular アプリでのプリキャッシュのセットアップ方法について説明します。ここでは、すでにプリキャッシュと Service Worker に関する一般的な知識があることを前提としています。復習が必要な場合は、Service Worker と Cache Storage API の投稿をご覧ください。

Angular Service Worker の概要

Angular チームは、フレームワークおよび Angular コマンドライン インターフェース(CLI)と緊密に統合されたプリキャッシュ機能を備えた Service Worker モジュールを提供しています。

Service Worker を追加するには、CLI で次のコマンドを実行します。

ng add @angular/pwa

@angular/service-worker@angular/pwa がアプリにインストールされ、package.json に表示されるはずです。また、ng-add 回路図では、ngsw-config.json というファイルがプロジェクトに追加され、これを使用して Service Worker を構成できます。(このファイルにはデフォルト設定が含まれていますが、後でカスタマイズします)。

本番環境用にプロジェクトをビルドします。

ng build --prod

dist/service-worker-web-dev ディレクトリ内に ngsw.json というファイルがあります。このファイルは、アプリ内のアセットをキャッシュする方法を Angular Service Worker に指示します。このファイルは、構成(ngsw-config.json)とビルド時に生成されたアセットに基づいて、ビルドプロセス中に生成されます。

アプリの本番環境アセットを含むディレクトリで HTTP サーバーを起動し、公開 URL を開いて、Chrome DevTools でネットワーク リクエストを確認します。

  1. Ctrl+Shift+J キー(Mac の場合は Command+Option+J キー)を押して DevTools を開きます。
  2. [ネットワーク] タブをクリックします。

[Network] タブには、ngsw-worker.js スクリプトによってバックグラウンドで直接ダウンロードされる多数の静的アセットがあります。

サンプルアプリ

これは、生成された ngsw.json マニフェスト ファイルで指定された静的アセットをプリキャッシュする Angular Service Worker です。

ただし、重要なアセット(nyan.png)がありません。この画像を事前キャッシュに保存するには、その画像を含むパターンを、ワークスペースのルートにある ngsw-config.json に追加する必要があります。

{
  "$schema": "./node_modules/@angular/service-worker/config/schema.json",
  "index": "/index.html",
  "assetGroups": [
    {
      "name": "app",
      "installMode": "prefetch",
      "resources": {
      "files": [
        "/favicon.ico",
        "/index.html",
        "/*.css",
        "/*.js",
        "/assets/*.png"
        ]
      }
    },
    ...
}

この変更により、/assets フォルダ内のすべての PNG 画像が app リソース アセット グループに追加されます。このアセット グループの installModeprefetch に設定されているため、Service Worker は指定されたすべてのアセット(PNG 画像を含む)を事前キャッシュに保存します。

プリキャッシュする他のアセットを指定するのは簡単です。app リソース アセット グループのパターンを更新します。

まとめ

プレキャッシュに Service Worker を使用すると、アセットをローカル キャッシュに保存してアプリのパフォーマンスを向上させることができます。これにより、低品質のネットワークにおけるアプリの信頼性が向上します。Angular と Angular CLI で事前キャッシュを使用するには:

  1. @angular/pwa パッケージをプロジェクトに追加します。
  2. ngsw-config.json を編集して、Service Worker がキャッシュする対象を制御します。