关于 bun-elysia
bun-elysia 是面向 Bun 与 Elysia.js 开发者的参考技能,涵盖从项目搭建到路由、验证和原生 API 使用,并提供 Fastify 迁移指南。
主要功能
- 01Bun 与 Elysia.js 项目搭建
- 02路由、处理器与请求验证
- 03生命周期钩子、插件与 WebSocket
- 04Bun 原生数据库及存储 API
- 05OpenAPI 文档与 Eden 类型安全客户端
- 06Fastify 迁移参考
适用场景
- 01创建 Elysia 应用并设置开发服务器
- 02为 API 添加路由和请求验证
- 03接入 Bun 数据库或 Redis API
- 04将 Fastify 功能迁移到 Elysia
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ ymc182/ bun-elysia-skill --skill bun-elysia安装后在 Claude Code 中输入/bun-elysia确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/monorepo.mdreferences/elysia/swagger.mdlifecycle.mdcore.mdwebsocket.mdeden.mdvalidation.mdreferences/migration/fastify-advanced.mdfastify-hooks.mdfastify-auth.mdfastify-plugins.mdfastify-basics.mdfastify-validation.mdreferences/native-apis/http-server.mdredis.mds3.mdsql.md详细介绍
Bun + Elysia.js 开发
使用 Bun 运行时和 Elysia.js 框架构建高性能全栈应用。
快速开始
创建新的 Elysia 项目
bun create elysia my-app
cd my-app
bun run dev
基本服务
import { Elysia, t } from "elysia";
const app = new Elysia()
.get("/", () => "Hello, World!")
.get("/users/:id", ({ params }) => ({ id: params.id }), {
params: t.Object({ id: t.Number() })
})
.post("/users", ({ body }) => ({ created: body }), {
body: t.Object({
name: t.String(),
email: t.String({ format: "email" })
})
})
.listen(3000);
使用 Bun 原生 API
import { Elysia } from "elysia";
import { sql } from "bun";
import { redis } from "bun";
const app = new Elysia()
.decorate("sql", sql)
.decorate("redis", redis)
.get("/users", async ({ sql }) => {
return sql`SELECT * FROM users`;
})
.get("/cache/:key", async ({ redis, params }) => {
return redis.get(params.key);
})
.listen(3000);
参考导航
你想做什么?
设置项目:
- 使用工作区的单体仓库 → monorepo.md
使用 Bun 原生 API:
- PostgreSQL/MySQL/SQLite → native-apis/sql.md
- Redis/Valkey → native-apis/redis.md
- S3/对象存储 → native-apis/s3.md
- HTTP 服务基础 → native-apis/http-server.md
使用 Elysia 构建:
- 路由和处理器 → elysia/core.md
- 请求/响应验证 → elysia/validation.md
- 钩子、中间件、插件 → elysia/lifecycle.md
- WebSocket 支持 → elysia/websocket.md
- OpenAPI/Swagger 文档 → elysia/swagger.md
- 类型安全客户端(Eden)→ elysia/eden.md
从 Fastify 迁移:
- 路由、参数、请求体 → migration/fastify-basics.md
- Schema 验证 → migration/fastify-validation.md
- 生命周期钩子 → migration/fastify-hooks.md
- 插件架构 → migration/fastify-plugins.md
- 身份验证 → migration/fastify-auth.md
- WebSocket、Swagger、文件 → migration/fastify-advanced.md
常见模式
身份验证中间件
import { Elysia } from "elysia";
import { jwt } from "@elysiajs/jwt";
const app = new Elysia()
.use(jwt({ secret: process.env.JWT_SECRET! }))
.derive(async ({ headers, jwt }) => {
const token = headers.authorization?.replace("Bearer ", "");
const user = token ? await jwt.verify(token) : null;
return { user };
})
.get("/profile", ({ user, error }) => {
if (!user) return error(401);
return user;
});
带验证的数据库
import { Elysia, t } from "elysia";
import { sql } from "bun";
const app = new Elysia()
.post("/users", async ({ body }) => {
const [user] = await sql`
INSERT INTO users (name, email)
VALUES (${body.name}, ${body.email})
RETURNING *
`;
return user;
}, {
body: t.Object({
name: t.String({ minLength: 1 }),
email: t.String({ format: "email" })
})
});
带守卫的分组路由
app.group("/api", (app) =>
app
.guard({
headers: t.Object({
authorization: t.String()
}),
beforeHandle: ({ headers, error }) => {
if (!isValidToken(headers.authorization)) {
return error(401);
}
}
}, (app) =>
app
.get("/users", getUsers)
.post("/users", createUser)
)
);
WebSocket 聊天
app.ws("/chat", {
body: t.Object({
room: t.String(),
message: t.String()
}),
open(ws) {
ws.subscribe("general");
},
message(ws, { room, message }) {
ws.publish(room, { from: ws.id, message });
}
});
关键差异:Fastify 与 Elysia
| Fastify | Elysia |
|---|---|
request.params | { params } |
request.query | { query } |
request.body | { body } |
reply.code(n).send(x) | set.status = n; return x |
reply.header(k, v) | set.headers[k] = v |
| JSON Schema | TypeBox (t.*) |
preHandler hook | beforeHandle |
fastify.decorate() | .decorate() |
fastify.register(plugin) | .use(plugin) |
安装
# Elysia and plugins
bun add elysia @elysiajs/swagger @elysiajs/jwt @elysiajs/cors @elysiajs/static @elysiajs/eden
# Types
bun add -d @types/bun typescript
评论
支持 Markdown