Skip to content

Service Worker

Service Worker 是一种在浏览器后台运行的脚本,用于处理诸如缓存和推送通知之类的任务。通过使用 Service Worker 适配器,你可以将使用 Hono 构建的应用程序作为 FetchEvent 处理程序在浏览器中运行。

此页面展示了如何使用 Vite 创建项目的示例。

1. 设置

首先,创建并进入你的项目目录:

sh
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"]
}

接下来,安装必要的模块。

sh
npm i hono
npm i -D vite
sh
yarn add hono
yarn add -D vite
sh
pnpm add hono
pnpm add -D vite
sh
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 的脚本:

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

sw.ts 中,使用 Hono 创建一个应用程序,并使用 Service Worker 适配器的 handle 函数将其注册到 fetch 事件。这允许 Hono 应用程序拦截对 /sw 的访问。

ts
// 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. 运行

启动开发服务器。

sh
npm run dev
sh
yarn dev
sh
pnpm run dev
sh
bun run dev

默认情况下,开发服务器将在端口 5173 上运行。在浏览器中访问 http://localhost:5173/ 以完成 Service Worker 的注册。然后,访问 /sw 以查看来自 Hono 应用程序的响应。

在 MIT 许可证下发布。