サービスワーカー API

この記事は翻訳が完了していません。 この記事の翻訳にご協力ください

Service Worker は、基本的にウェブアプリケーション、ブラウザー、そして(もし繋がっていれば)ネットワークの間に介在するプロキシサーバーのように振る舞います。これは、よりよいオフライン体験を可能にするように意図されており、ネットワークのリクエストに介在してネットワークの使用可否の状況に基づいて適切な対応を取ったり、サーバー上にあるアセットを更新したりします。また、プッシュ通知やバックグラウンド同期の API 群へのアクセスもできるようになります。

Service Worker の概念と使い方

Service Worker は、あるオリジンとパスに対して登録されたイベント駆動型の worker です。JavaScript ファイルの形を取り、ナビゲーションやリソースへのリクエストを横取りや改変したり細かい粒度でリソースをキャッシュすることで関連付けられたウェブページやサイトを制御し、それぞれの状況(もっとも顕著な例は、ネットワークが利用できないとき)にアプリがどのように振舞うかを完全に制御することができます。

Service Worker は worker のコンテキストで実行されます。従って、DOM へアクセスすることができず、アプリを実行する主要な JavaScript とは異なるスレッドで実行されるため、他のタスクをブロックすることはありません。完全に非同期で設計されています。そのため、同期型の XHRlocalStorage のような API を Service Worker で利用することはできません。

Service worker はセキュリティ上の理由から、HTTPS 通信でのみ動作します。ネットワークリクエストが改変されると、中間者攻撃を受けるので、人間に広く開かれているのは本当にまずいことです。Firefox ではプライベートブラウジングモードで Service Worker API を利用することはできません。

メモ: Service Worker は AppCache のような、この分野における以前の試みより勝っています。以前のものは、あなたがしようとしていることを想定していなかったり想定が正しくなかったときに壊れたりしていたのに対して、Service Worker はあなたがすべてを細粒度で制御することができるためです。

メモ: Service Worker は promise を頻繁に使用して、応答が来るのを待ってから、成功または失敗のアクションで応答します。promise のアーキテクチャはこの領域に対して理想的なものです。

登録

Service Worker は最初に ServiceWorkerContainer.register() メソッドを使って登録されます。成功したら、Service Worker がクライアントにダウンロードされ、ユーザーがアクセスした URL のオリジン内全体、または指定したそのサブセット内に対してインストールと有効化(下記参照)が試みられます。

ダウンロードとインストールと有効化

この段階で、Service Worker は以下のライフサイクルで実行されます。

  1. ダウンロード
  2. インストール
  3. 有効化

ユーザーが最初に Service Worker が制御するサイトやページにアクセスすると、Service Worker が直ちにダウンロードされます。

その後、次の場面で更新されます。

  • スコープ内のページへの移動が発生したとき
  • Service Worker でイベントが発生し、かつ過去24時間以内にダウンロードが行われていない場合

ダウンロードしたファイルが新しいと分かった場合、既存の Service Worker とバイト単位に比較して異っていた場合や、そのページやサイトで最初の Service Worker が見つかった場合は、インストールが試みられます。

Service Worker が初めて有効化されるときであれば、インストールが試みられ、インストールに成功した後で、有効化されます。

利用できる既存の Service Worker があった場合は、新しいバージョンがバックグラウンドでインストールされますが、まだ有効化 (activate) されません。この時点のものを待機中の (waiting) ワーカーと呼びます。まだ使用している古い Service Worker が読み込んでいるページがなくなった時のみ、有効化されます。ページが読み込まれなくなったらすぐに、新しい Service Worker が有効化されます(アクティブワーカーになります)。ServiceWorkerGlobalScope.skipWaiting() を使用するとすぐに有効化することができ、Clients.claim() を使用してアクティブワーカーが既存のページの管理を始めることができます。

InstallEvent を受け取ることもできます。イベントが発火したときの標準的なアクションは、使用するために Service Worker を準備すること、例えば組込みストレージ API を使用してキャッシュを構築したり、アプリがオフラインの時に使用したい資産をその中に配置したりすることです。

activate イベントもあります。このイベントが発火した時点は、古いキャッシュや、前のバージョンの Service Worker に関するその他のものを整理するのによいタイミングです。

Service Worker は FetchEvent イベントを使用してリクエストに応答することができます。event.respondWith メソッドを使用して、これらのリクエストに対するレスポンスを何でも思うように変更できます。

メモ: oninstall/onactivate は完了するまでに時間がかかる可能性があるため、Service Worker の仕様書では waitUntil メソッドを提供しており、これが oninstall 又は onactivate を呼び出すと、promise を渡します。promise が正常に解決されるまで、関数イベントは Service Worker に配信されません。

最初の基本的な例をどのように構築するかについての完全なチュートリアルは、Service Worker の使用を読んでください。

その他の使用例

Service Worker は次のようなことにも利用されることを想定しています。

  • バックグラウンドのデータ同期
  • 他のオリジンからのリソースのリクエストに対する応答
  • 位置情報やジャイロスコープのような計算コストの高いデータの更新を集中的に受信して、複数のページがデータの一部を利用できるようにすること
  • CoffeeScript, less, CJS/AMD モジュールなどの開発用途で、クライアント側のコンパイルや依存性管理
  • バックグラウンドサービスのフック
  • 特定の URL パターンに基づくテンプレートカスタマイズ
  • パフォーマンスの改善、例えばユーザーが近く必要とするであろう、写真アルバムの次の数枚の写真などの先読み

近い将来、Service Worker はネイティブアプリで実現できることに近い、その他いくつもの便利なことを、ウェブプラットフォーム上でも実現する事ができるようになるでしょう。興味深いことに、次のような他の仕様書でも、Service Worker のコンテキストを利用できるようになってきています。

  • バックグラウンド同期: ユーザーがサイトにいないときにも Service Worker を起動し、キャッシュを更新したりすることができます。
  • プッシュメッセージへの応答: 新しいコンテンツが利用可能になった旨を伝えるためにユーザーにメッセージを送るために Service Worker を起動します。
  • 特定の日付・時刻に対する反応
  • 特定の地理的範囲へ入った事を検知する

インターフェイス

Cache
ServiceWorker のライフライクルの一部としてキャッシュされる、Request / Response オブジェクトのペアのためのストレージです。
CacheStorage
Cache オブジェクトのストレージです。これはServiceWorker がアクセスできるすべての名前付きキャッシュのへの目録を提供し、文字列の名前から対応する Cache へのマップを保持します。
Client
Service Worker クライアントを表します。Service Worker クライアントは、有効化された Service Worker によってブラウザーコントロールされた、コンテキストにおけるドキュメントか SharedWorker です。
Clients
Client オブジェクトのリストのためのコンテナであり、現在のオリジンにある有効化された Service Worker クライアントにアクセスする主な方法です。
ExtendableEvent
ServiceWorkerGlobalScope でディスパッチされる install イベントや activate イベントのライフタイムを伸ばします。これは、データベーススキーマの更新や使われなくなったキャッシュエントリの削除などが終わるまで機能的イベント (Functional events) が ServiceWorker にディスパッチされないことを保証します。
ExtendableMessageEvent
The event object of a message event fired on a service worker (when a channel message is received on the ServiceWorkerGlobalScope from another context) — extends the lifetime of such events.
FetchEvent
The parameter passed into the ServiceWorkerGlobalScope.onfetch handler, FetchEvent represents a fetch action that is dispatched on the ServiceWorkerGlobalScope of a ServiceWorker. It contains information about the request and resulting response, and provides the FetchEvent.respondWith() method, which allows us to provide an arbitrary response back to the controlled page.
InstallEvent
The parameter passed into the oninstall handler, the InstallEvent interface represents an install action that is dispatched on the ServiceWorkerGlobalScope of a ServiceWorker. As a child of ExtendableEvent, it ensures that functional events such as FetchEvent are not dispatched during installation.
NavigationPreloadManager
Provides methods for managing the preloading of resources with a service worker.
Navigator.serviceWorker
Returns a ServiceWorkerContainer object, which provides access to registration, removal, upgrade, and communication with the ServiceWorker objects for the associated document.
NotificationEvent
The parameter passed into the onnotificationclick handler, the NotificationEvent interface represents a notification click event that is dispatched on the ServiceWorkerGlobalScope of a ServiceWorker.
ServiceWorker
Represents a service worker. Multiple browsing contexts (e.g. pages, workers, etc.) can be associated with the same ServiceWorker object.
ServiceWorkerContainer
Provides an object representing the service worker as an overall unit in the network ecosystem, including facilities to register, unregister, and update service workers, and access the state of service workers and their registrations.
ServiceWorkerGlobalScope
Represents the global execution context of a service worker.
ServiceWorkerMessageEvent
Represents a message sent to a ServiceWorkerGlobalScope. Note that this interface is deprecated in modern browsers. Service worker messages will now use the MessageEvent interface, for consistency with other web messaging features.
ServiceWorkerRegistration
Represents a service worker registration.
ServiceWorkerState
Associated with its ServiceWorker's state.
SyncEvent

The SyncEvent interface represents a sync action that is dispatched on the ServiceWorkerGlobalScope of a ServiceWorker.

SyncManager
Provides an interface for registering and listing sync registrations.
WindowClient
Represents the scope of a service worker client that is a document in a browser context, controlled by an active worker. This is a special type of Client object, with some additional methods and properties available.

仕様書

仕様書 状態 備考
Service Workers 草案 初回定義。

関連情報