服务工作者
服务工作者 是在浏览器后台运行的脚本,用于处理缓存和推送通知等任务。使用服务工作者适配器,您可以将使用 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
是一个用于注册服务工作者的脚本
ts
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 创建一个应用程序,并使用服务工作者适配器的 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
上运行。访问浏览器中的 https://127.0.0.1:5173/
以完成服务工作者注册。然后,访问 /sw
以查看来自 Hono 应用程序的响应。