Service Worker

Service Worker は、ブラウザのバックグラウンドで実行され、キャッシュやプッシュ通知などのタスクを処理するスクリプトです。 Service Workerアダプターを使用すると、Honoで作成したアプリケーションをブラウザ内でFetchEventハンドラーとして実行できます。

このページでは、Viteを使用してプロジェクトを作成する例を示します。

1. セットアップ

まず、プロジェクトディレクトリを作成して移動します。

mkdir my-app
cd my-app

プロジェクトに必要なファイルを作成します。以下の内容でpackage.jsonファイルを作成します。

json

{
  "name": "my-app",
  "private": true,
  "scripts": {
    "dev": "vite dev"
  },
  "type": "module"
}

同様に、以下の内容でtsconfig.jsonファイルを作成します。

json

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "lib": ["ES2020", "DOM", "WebWorker"],
    "moduleResolution": "bundler"
  },
  "include": ["./"],
  "exclude": ["node_modules"]
}

次に、必要なモジュールをインストールします。

npmyarnpnpmbun

npm i hono
npm i -D vite

yarn add hono
yarn add -D vite

pnpm add hono
pnpm add -D vite

bun add hono
bun add -D vite

2. Hello World

index.htmlを編集します。

html

<!doctype html>
<html>
  <body>
    <a href="/sw">Hello World by Service Worker</a>
    <script type="module" src="/main.ts"></script>
  </body>
</html>

main.tsは、Service Workerを登録するためのスクリプトです。

function register() {
  navigator.serviceWorker
    .register('/sw.ts', { scope: '/sw', type: 'module' })
    .then(
      function (_registration) {
        console.log('Register Service Worker: Success')
      },
      function (_error) {
        console.log('Register Service Worker: Error')
      }
    )
}
function start() {
  navigator.serviceWorker
    .getRegistrations()
    .then(function (registrations) {
      for (const registration of registrations) {
        console.log('Unregister Service Worker')
        registration.unregister()
      }
      register()
    })
}
start()

sw.tsで、Honoを使用してアプリケーションを作成し、Service Workerアダプターのhandle関数を使用して`fetch`イベントに登録します。これにより、Honoアプリケーションは`/sw`へのアクセスをインターセプトできます。

// To support types
// https://github.com/microsoft/TypeScript/issues/14877
declare const self: ServiceWorkerGlobalScope

import { Hono } from 'hono'
import { handle } from 'hono/service-worker'

const app = new Hono().basePath('/sw')
app.get('/', (c) => c.text('Hello World'))

self.addEventListener('fetch', handle(app))

3. 実行

開発サーバーを起動します。

npmyarnpnpmbun

npm run dev

yarn dev

pnpm run dev

bun run dev

デフォルトでは、開発サーバーはポート`5173`で実行されます。ブラウザで`http://localhost:5173/`にアクセスして、Service Workerの登録を完了します。次に、`/sw`にアクセスして、Honoアプリケーションからのレスポンスを確認します。

Service Worker ​

1. セットアップ ​

2. Hello World ​

3. 実行 ​

Service Worker

1. セットアップ

2. Hello World

3. 実行