WebサイトをPWA(プログレッシブWebアプリ)にする方法

WebサイトをPWAにする方法(検証済みのコード付き) | We.Inc

あらゆるWebサイトを、インストールできてオフラインでも動くようにします。マニフェスト生成ツール、実際に検証したサービスワーカー、インストールボタン、iPhoneでの制限、ViteやNext.jsでの設定方法を紹介します。

WebサイトをPWA(プログレッシブWebアプリ)にする方法

WebサイトをプログレッシブWebアプリにするには、HTTPSで配信し、name、start_url、表示モード、192ピクセルと512ピクセルのアイコンを含むmanifest.webマニフェストを追加して、すべてのページからリンクします。さらに、ファイルをキャッシュしてオフラインで使えるようにするサービスワーカーを登録します。これで、Chromium系ブラウザーではインストールが提案され、Safariの利用者は共有メニューから追加できるようになります。

PWAを構成する3つの要素

  • 要素
  • 役割
  • 名前、アイコン、色、アプリの開き方
  • サービスワーカー(sw.js)
  • ファイルをキャッシュし、オフラインでもページを読み込めるようにする
  • HTTPS
  • サービスワーカーとインストールに必須

フォームに入力すると、マニフェストと、貼り付けるためのheadタグが生成されます。その後、サービスワーカーとインストール用スクリプトをコピーしてください。このページのサービスワーカーは、公開前に実際のブラウザーでネットワークを切断した状態で動作を確認しています。

  • 192ピクセルと512ピクセルのアイコンを作り、さらにロゴを中央の80%に収めたmaskable版も用意します。
  • フォームでマニフェストを生成し、サイトのルートにmanifest.webマニフェストとして保存して、headタグをすべてのページに貼り付けます。
  • sw.js、offline.html、登録用スクリプトを保存し、主要なファイルをPRECACHEに列挙します。
  • Chrome DevToolsのApplicationパネルを開きます。Manifestでインストールの問題を、Service workersで動作中のサービスワーカーを確認します。Offlineにチェックを入れて再読み込みし、テストします。
  • キャッシュしたファイルを変更したら、再訪問者が新しいファイルを受け取れるようVERSIONを上げます。
  • sw.jsはサイトのルートから配信しましょう。サービスワーカーが制御できるのは、自身のフォルダーとその配下のページだけです。
  • sw.js自体を長期間のHTTPキャッシュヘッダーでキャッシュしないでください。ブラウザーは更新がないかsw.jsを確認します。
  • プリキャッシュのリストは短くしましょう。リストにあるものはすべて初回訪問時にダウンロードされます。
  • iPhoneでは、インストール方法を利用者に伝えましょう。「共有」から「ホーム画面に追加」です。表示させられるプロンプトはありません。
  • オフラインのテストでは、Offlineのチェックボックスだけでなくローカルサーバーも停止し、サービスワーカー自身のリクエストも失敗するようにしましょう。

よくある質問

PWAをインストール可能にするにはサービスワーカーが必要ですか?

現在のChromeでは不要です。有効なマニフェスト、HTTPS、ある程度のユーザー操作があれば、インストールの選択肢が表示されます。それでもサービスワーカーは用意すべきです。ないと、インストールしたアプリがオフライン時にブラウザーのエラーページを表示してしまうからです。

PWAはiPhoneで動きますか?

はい、ただし制限があります。Safariの利用者は共有メニューからインストールし、インストールを促すイベントはありません。プッシュ通知は、iOS 16.4以降でホーム画面に追加したサイトでのみ動作します。オフラインのキャッシュは動作します。

インストールボタンがまったく表示されないのはなぜですか?

beforeinstallpromptが発火するのはChromium系ブラウザーだけで、インストールの条件を満たしている場合に限られ、アプリがすでにインストール済みの場合は発火しません。理由はDevToolsのApplicationパネルにあるManifestセクションで確認してください。

LighthouseにPWAのスコアがなくなった今、PWAをどう確認すればよいですか?

Lighthouse 12でPWAカテゴリーは廃止されました。Chrome DevToolsのApplicationパネルを使いましょう。Manifestビューにはインストール可否に関するエラーやアイコンの問題が表示され、Service workersビューでは登録、更新の状態とOfflineの切り替えスイッチが確認できます。

リリース後にPWAを更新するには?

sw.jsのキャッシュのVERSIONを変更します。ブラウザーは変更されたサービスワーカーを検出してインストールし、activateの処理で古いキャッシュを削除します。skipWaitingとclients.claimを使えば、次の読み込みで新しいサービスワーカーに切り替わります。

キャッシュ優先かネットワーク優先か

  • キャッシュ優先(Cache-first)はキャッシュから応答し、保存していないものだけをネットワークに取りに行きます。高速で、ハッシュ付きのスクリプト、フォント、アイコンのように、同じ名前のまま内容が変わらないファイルに適しています。
  • ネットワーク優先(Network-first)はサーバーに問い合わせ、それが失敗したときだけキャッシュを使います。更新後に古いコピーを表示すると混乱を招くHTMLページに向いています。上のサービスワーカーは両方を使っています。ページの読み込みにはネットワーク優先、それ以外にはキャッシュ優先です。

よくある間違い

  • /js/sw.jsのようなサブフォルダーのパスからサービスワーカーを登録してしまい、制御範囲が/js/配下のページに限られる。
  • VERSIONの変更を忘れ、再訪問者が古いCSSやスクリプトを何週間も使い続ける。
  • 他のサイトからの応答やエラー応答をキャッシュしてしまう。上のサービスワーカーはクロスオリジンのリクエストを対象外にし、成功したアセットの応答だけを保存します。
  • Chromeだけでテストする。iPhoneでサイトを開き、Safariの利用者に実際にどう見えるかを確認しましょう。

得られるものとiPhoneでの制限

インストールすると、サイトに専用のアイコンと、アドレスバーのないウィンドウが与えられます。サービスワーカーはオフラインのページを追加します。プッシュ通知には両方が必要で、Appleは利用者がホーム画面に追加したサイトにしか許可していません。

プラットフォーム別のPWAでできること

  • 機能
  • Chrome / Edge(デスクトップ、Android)
  • iPhoneとiPadのSafari
  • Firefox
  • ホーム画面またはデスクトップへのインストール
  • 可、インストールプロンプトあり
  • 可、手動で「共有」から「ホーム画面に追加」
  • Android:可。デスクトップ:限定的、バージョンを確認
  • 独自のインストールボタン(beforeinstallprompt)
  • 可
  • 不可
  • 不可
  • サービスワーカーによるオフライン対応
  • 可
  • 可
  • 可
  • Webプッシュ通知
  • 可
  • iOS 16.4以降でホーム画面に追加したサイトのみ
  • 可
  • 永続的なストレージ
  • 可、容量が逼迫すると削除される場合あり
  • Safariのタブでは、スクリプトで書き込んだストレージは、サイトを訪問しないままブラウザーを7日間使うと消去されることがある。ホーム画面のアプリは独自に日数を数える
  • 可、容量が逼迫すると削除される場合あり
  • バックグラウンド同期
  • 可
  • 不可
  • 不可

動作するサービスワーカー

サイトをオフライン対応にするには3つのファイルが必要です。サービスワーカー、フォールバック用のページ、それを登録する数行のコードです。私たちはこれらのファイルをそのままlocalhostのChromiumで実行しました。サービスワーカーがインストールされ、キャッシュが満たされ、サーバーを停止した状態でもホームページはキャッシュから読み込まれ、一度も訪れていないページではoffline.htmlが表示されました。

sw.js:オフラインで動く最小限のサービスワーカー

ページはまずネットワークを試して最新の内容を表示し、だめならキャッシュしたコピー、それもなければoffline.htmlを表示します。CSS、スクリプト、アイコンなどのファイルはまずキャッシュから取得します。VERSIONを変更すると、次のactivateの処理で古いキャッシュが削除されます。

offline.html:フォールバック用のページ

このページは単体で完結させましょう。表示される時点では他に何も取得できない可能性があるため、スタイルはインラインで書き、外部ファイルは使いません。

インストールボタン

app.js:サービスワーカーを登録し、インストールボタンを表示する

beforeinstallpromptイベントが発火するのはChromium系ブラウザー(Chrome、Edge、Samsung Internet、Opera)だけです。SafariとFirefoxはこのイベントを送らないため、そこではボタンは非表示のままで、利用者はブラウザー自身のメニューを使います。

現在のインストール条件

Chromeは、インストールを提案する前にサービスワーカーを必須とはしなくなりました。確認されるのはマニフェストと以下の項目です。Lighthouse 12ではPWAカテゴリーが削除されたため、代わりにChrome DevToolsでインストール可否を確認しましょう。Applicationパネルを開いてManifestを選ぶと、Installabilityの下に問題が一覧表示されます。

Chromeのインストール要件

  • 要件
  • 詳細
  • HTTPS
  • 安全な接続で配信されていること。テストではlocalhostも安全とみなされます。
  • マニフェストの名前
  • nameまたはshort_name
  • マニフェストのアイコン
  • 少なくとも192 pxと512 pxのアイコン
  • マニフェストに含まれていること
  • fullscreen, standalone, minimal-ui or window-controls-overlay
  • 指定なし、またはfalse
  • ユーザー操作
  • 訪問者がページを少なくとも1回クリックまたはタップし、ある程度の時間を過ごしていること

ViteとNext.jsでの設定

Vite:vite-plugin-pwa

npm i -D vite-plugin-pwaでインストールします。このプラグインはビルド時にマニフェストを書き出し、Workboxのサービスワーカーを生成するため、sw.jsを手書きする必要はありません。アイコンはpublic/に置きます。

Next.js App Router:app/manifest.ts

Next.jsはこのファイルを/manifest.webマニフェストとして配信し、linkタグも自動で追加します。オフライン対応には、上のsw.jsをpublic/に置き、小さなクライアントコンポーネントから登録します。

Next.js:クライアントコンポーネントからpublic/sw.jsを登録する

これをapp/layout.tsxで1回だけ描画します。キャッシュされたビルドで編集内容が見えなくならないよう、開発環境では登録をスキップします。

アプリ名

短い名前(アイコンの下に表示)

開始URL

アイコンのフォルダー

テーマカラー

背景色

コピー

マニフェスト生成ツール

表示モード

maskableアイコンを含める

アイコンはicon-192.pngとicon-512.png(およびicon-512-maskable.png)としてアイコンのフォルダーに保存してください。

すべてのページのheadに入れるタグ

無料でサイトを作る · 無料で構築、カード登録不要

関連: ガイド|Webマーケティングと集客を学ぶ

製品

ご利用いただける方

機能

リソース

会社情報

サイトマップを見る