关键概念
我们 强烈建议 您在开始使用 Elysia 之前阅读此页面。
尽管 Elysia 是一个简单的库，但它有一些关键概念，您需要理解以有效地使用它。
此页面涵盖大部分您应该了解的 Elysia 的重要概念。
一切都是组件
每个 Elysia 实例都是一个组件。
组件是可以连接到其他实例的插件。
它可以是路由、存储、服务或其他任何东西。
import { Elysia } from 'elysia'
const store = new Elysia()
.state({ visitor: 0 })
const router = new Elysia()
.use(store)
.get('/increase', ({ store }) => store.visitor++)
const app = new Elysia()
.use(router)
.get('/', ({ store }) => store)
.listen(3000)这迫使您将应用程序分解为小块，使您能够轻松添加或删除功能。
在 插件 中了解更多内容。
作用域
默认情况下，每个实例中的事件/生命周期是相互隔离的。
import { Elysia } from 'elysia'
const ip = new Elysia()
.derive(({ server, request }) => ({
ip: server?.requestIP(request)
}))
.get('/ip', ({ ip }) => ip)
const server = new Elysia()
.use(ip)
.get('/ip', ({ ip }) => ip) .listen(3000)在此示例中，ip 属性仅在其自身实例中共享，而不在 server 实例中共享。
要共享生命周期，在我们的例子中，与 server 实例共享 ip 属性，我们需要 明确指定 它可以被共享。
import { Elysia } from 'elysia'
const ip = new Elysia()
.derive(
{ as: 'global' },
({ server, request }) => ({
ip: server?.requestIP(request)
})
)
.get('/ip', ({ ip }) => ip)
const server = new Elysia()
.use(ip)
.get('/ip', ({ ip }) => ip)
.listen(3000)在这个例子中，ip 属性在 ip 和 server 实例之间共享，因为我们将其定义为 global。
这迫使您考虑每个属性的作用域，防止您意外地在实例之间共享属性。
在 作用域 中了解更多内容。
方法链
Elysia 的代码应始终使用 方法链。
由于 Elysia 的类型系统复杂，Elysia 中的每个方法都会返回一个新的类型引用。
这很重要，以确保类型完整性和推断。
import { Elysia } from 'elysia'
new Elysia()
.state('build', 1)
// 存储是严格类型的 //
.get('/', ({ store: { build } }) => build)
.listen(3000)在上面的代码中，state 返回一个新的 ElysiaInstance 类型，添加了一个类型化的 build 属性。
❌ 不要：在没有方法链的情况下使用 Elysia
如果不使用方法链，Elysia 不会保存这些新类型，从而导致没有类型推断。
import { Elysia } from 'elysia'
const app = new Elysia()
app.state('build', 1)
app.get('/', ({ store: { build } }) => build)
app.listen(3000)我们建议 始终使用方法链 以提供准确的类型推断。
依赖性
默认情况下，每个实例在应用于另一个实例时会被重新执行。
这可能导致相同方法被多次应用，而某些方法，如 生命周期 或 路由，应该只调用一次。
为了防止生命周期方法重复调用，我们可以为实例添加 一个唯一标识符。
import { Elysia } from 'elysia'
const ip = new Elysia({ name: 'ip' })
.derive(
{ as: 'global' },
({ server, request }) => ({
ip: server?.requestIP(request)
})
)
.get('/ip', ({ ip }) => ip)
const router1 = new Elysia()
.use(ip)
.get('/ip-1', ({ ip }) => ip)
const router2 = new Elysia()
.use(ip)
.get('/ip-2', ({ ip }) => ip)
const server = new Elysia()
.use(router1)
.use(router2)这将通过使用唯一名称进行去重，防止 ip 属性被多次调用。
一旦提供了 name，该实例将成为 单例，允许 Elysia 应用插件去重。
这使我们可以多次重用相同的实例而不产生性能损失。
这迫使您思考每个实例的依赖性，方便进行迁移或重构。
在 插件去重 中了解更多内容。
类型推断
Elysia 具有复杂的类型系统，允许您从实例推断类型。
import { Elysia, t } from 'elysia'
const app = new Elysia()
.post('/', ({ body }) => body, {
body: t.Object({
name: t.String()
})
})如果可能，始终使用内联函数以提供准确的类型推断。
如果您需要应用单独的函数，例如 MVC 的控制器模式，建议从内联函数中解构属性，以防止不必要的类型推断。
import { Elysia, t } from 'elysia'
abstract class Controller {
static greet({ name }: { name: string }) {
return 'hello ' + name
}
}
const app = new Elysia()
.post('/', ({ body }) => Controller.greet(body), {
body: t.Object({
name: t.String()
})
})在 最佳实践：MVC 控制器 中了解更多内容。
贡献者
一纸忘忧