路由

Web 服务器使用请求的路径和方法来查找正确的资源，这一过程称为**“路由”**。

我们可以通过HTTP 动词方法、路径和匹配时执行的函数来定义路由。

typescript

import { Elysia } from 'elysia'

new Elysia()
    .get('/', '你好')
    .get('/hi', '嗨')
    .listen(3000)

我们可以通过访问 http://localhost:3000 来访问 web 服务器。

默认情况下，web 浏览器在访问页面时会发送 GET 方法。

TIP

使用上面的交互式浏览器，将鼠标悬停在蓝色高亮区域以查看每个路径之间的不同结果

路径类型

Elysia 中的路径可分为3种类型：

静态路径 - 静态字符串用于定位资源
动态路径 - 段可以是任何值
通配符路径 - 路径到某个特定点可以是任何内容

你可以将所有这些路径类型组合起来，为你的 web 服务器设计行为。

typescript

import { Elysia } from 'elysia'

new Elysia()
    .get('/id/1', '静态路径')
    .get('/id/:id', '动态路径')
    .get('/id/*', '通配符路径')
    .listen(3000)

静态路径

静态路径是硬编码的字符串，用于定位服务器上的资源。

import { Elysia } from 'elysia'

new Elysia()
	.get('/hello', 'hello')
	.get('/hi', 'hi')
	.listen(3000)

动态路径

动态路径匹配某部分内容并捕获该值得到额外信息。

定义动态路径时，可以使用冒号 : 后跟名称。

typescript

import { Elysia
 } from 'elysia'

new Elysia
()
    .get
('/id/:id', ({ params
: { id
 } }) => id
)
    .listen
(3000)

这里通过 /id/:id 创建了一个动态路径。Elysia 会捕获 :id 段的值，比如 /id/1、/id/123、/id/anything。

请求时，服务器会返回以下响应：

路径	响应
/id/1	1
/id/123	123
/id/anything	anything
/id/anything?name=salt	anything
/id	未找到
/id/anything/rest	未找到

动态路径非常适合包含如 ID 这类稍后可用的变量。

我们将命名变量路径称为路径参数，简称params。

多个路径参数

你可以有多个路径参数，它们会存储在一个 params 对象中。

typescript

import { Elysia
 } from 'elysia'

new Elysia
()
    .get
('/id/:id', ({ params
: { id
 } }) => id
)
    .get
('/id/:id/:name', ({ params
: { id
, name
 } }) => id
 + ' ' + name
)
    .listen
(3000)

服务器将返回以下响应：

路径	响应
/id/1	1
/id/123	123
/id/anything	anything
/id/anything?name=salt	anything
/id	未找到
/id/anything/rest	anything rest

可选路径参数

有时我们想让静态路径与动态路径解析到相同的处理程序。

可以通过在参数名称后加问号 ? 来使路径参数可选。

typescript

import { Elysia
 } from 'elysia'

new Elysia
()
    .get
('/id/:id?', ({ params
: { id
 } }) => `id ${id
}`)
    .listen
(3000)

通配符

动态路径只捕获单个段，而通配符路径可捕获剩余路径。

定义通配符使用星号 *。

typescript

import { Elysia
 } from 'elysia'

new Elysia
()
    .get
('/id/*', ({ params
 }) => params
['*'])
    .listen
(3000)

路径优先级

Elysia 的路径优先级如下：

静态路径
动态路径
通配符

如果静态路径和动态路径同时匹配，Elysia 将优先解析静态路径。

typescript

import { Elysia } from 'elysia'

new Elysia()
    .get('/id/1', '静态路径')
    .get('/id/:id', '动态路径')
    .get('/id/*', '通配符路径')
    .listen(3000)

HTTP 动词

HTTP 定义了一组请求方法，指示对给定资源执行的操作。

常见的 HTTP 动词包括：

GET

GET 请求仅用于获取数据。

POST

向指定资源提交有效负载，通常引起状态变化或副作用。

PUT

用请求负载替换目标资源的所有当前表示。

PATCH

对资源进行部分修改。

DELETE

删除指定资源。

为了支持不同动词，Elysia 内置多个 HTTP 动词API，与 Elysia.get 类似。

typescript

import { Elysia } from 'elysia'

new Elysia()
    .get('/', '你好')
    .post('/hi', '嗨')
    .listen(3000)

Elysia 的 HTTP 方法接受以下参数：

path: 路径名
function: 响应客户端的函数
hook: 额外元数据

你可以在 HTTP 请求方法阅读更多关于 HTTP 方法的内容。

自定义方法

我们可以使用 Elysia.route 定义自定义 HTTP 方法。

typescript

import { Elysia } from 'elysia'

const app = new Elysia()
    .get('/get', 'hello')
    .post('/post', 'hi')
    .route('M-SEARCH', '/m-search', 'connect') 
    .listen(3000)

Elysia.route 接受以下参数：

method: HTTP 动词
path: 路径名
function: 响应客户端的函数
hook: 额外元数据

TIP

基于 RFC 7231，HTTP 动词是区分大小写的。

建议为 Elysia 自定义 HTTP 动词使用大写命名。

ALL 方法

Elysia 提供了 Elysia.all，用于处理指定路径的任意 HTTP 方法，API 与 Elysia.get 和 Elysia.post 一致。

typescript

import { Elysia } from 'elysia'

new Elysia()
    .all('/', '嗨')
    .listen(3000)

所有匹配该路径的 HTTP 方法都将如下处理：

路径	方法	结果
/	GET	嗨
/	POST	嗨
/	DELETE	嗨

处理

大多数开发者使用 REST 客户端如 Postman、Insomnia 或 Hoppscotch 测试 API。

但 Elysia 也可以通过 Elysia.handle 编程地测试。

typescript

import { Elysia } from 'elysia'

const app = new Elysia()
    .get('/', '你好')
    .post('/hi', '嗨')
    .listen(3000)

app.handle(new Request('http://localhost/')).then(console.log)

Elysia.handle 是处理发送给服务器的真实请求的函数。

TIP

与单元测试中的 mock 不同，你可以期望它表现得像发送到服务器的真实请求。

同时，也方便模拟或编写单元测试。

组

在构建 web 服务器时，常常有多个路由共享相同前缀：

typescript

import { Elysia } from 'elysia'

new Elysia()
    .post('/user/sign-in', '登录')
    .post('/user/sign-up', '注册')
    .post('/user/profile', '个人资料')
    .listen(3000)

这可以用 Elysia.group 优化，将它们分组并统一添加前缀：

typescript

import { Elysia
 } from 'elysia'

new Elysia
()
    .group
('/user', (app
) =>
        app

            .post
('/sign-in', '登录')
            .post
('/sign-up', '注册')
            .post
('/profile', '个人资料')
    )
    .listen
(3000)

这段代码行为与之前示例相同，路径结构：

路径	结果
/user/sign-in	登录
/user/sign-up	注册
/user/profile	个人资料

.group() 还可接受可选保护参数，减少同时应用组和保护层的样板代码：

typescript

import { Elysia
, t
 } from 'elysia'

new Elysia
()
    .group
(
        '/user',
        {
            body
: t
.Literal
('Rikuhachima Aru')
        },
        (app
) => app

            .post
('/sign-in', '登录')
            .post
('/sign-up', '注册')
            .post
('/profile', '个人资料')
    )
    .listen
(3000)

更多分组和保护信息见作用域。

前缀

还可以给构造函数传入 prefix，将一组路由分离到单独的插件实例，避免嵌套：

typescript

import { Elysia } from 'elysia'

const users = new Elysia({ prefix: '/user' })
    .post('/sign-in', '登录')
    .post('/sign-up', '注册')
    .post('/profile', '个人资料')

new Elysia()
    .use(users)
    .get('/', '你好，世界')
    .listen(3000)

我们的赞助商

路由 ​

路径类型 ​

静态路径 ​

动态路径 ​

多个路径参数 ​

可选路径参数 ​

通配符 ​

路径优先级 ​

HTTP 动词 ​

GET ​

POST ​

PUT ​

PATCH ​

DELETE ​

自定义方法 ​

ALL 方法 ​

处理 ​

组 ​

前缀 ​

路由

路径类型

静态路径

动态路径

多个路径参数

可选路径参数

通配符

路径优先级

HTTP 动词

GET

POST

PUT

PATCH

DELETE

自定义方法

ALL 方法

处理

组

前缀