# @enkaku/http-serve 中文文档

规范地址：https://npmcn.com/package/%40enkaku/http-serve/

版本：0\.23\.3
npm 元数据更新时间：2026-11-11T14:09:13.929Z
中文译文更新时间：2026-11-13T17:45:44.841Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40enkaku/http-serve
原文对照：https://npmcn.com/package/%40enkaku/http-serve/?lang=original
项目主页：https://enkaku.dev/
源码仓库：https://github.com/TairuFramework/enkaku

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：40.2 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：8 个
- 首次发布：2026-06-21T15:48:12.709Z
- 最新版本发布：2026-11-11T14:09:13.609Z
- 近 30 天下载量：3333（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 19 个）

## 中文简介

Enkaku RPC 服务器的 HTTP 传输

## 安装

```sh
npm install @enkaku/http-serve
```

也可以使用：`pnpm add @enkaku/http-serve`、`yarn add @enkaku/http-serve`、`bun add @enkaku/http-serve`

## README

# Enkaku HTTP 服务器传输

## 安装

```sh
npm install @enkaku/http-serve
```

## 每句信息 HTTP 语境

`ServerTransport.getMessageContext(message)` 财务报告和审定财务报表 `createServerBridge().getMessageContext(message)` 返回时 `HTTPMessageContext | undefined`。 。 。 . 上下文包含 `request: Request`,可选 `sessionID` 和可选 `session: HTTPSessionHandle`。 。 。 . 流取和频道引用会暴露新的或现有的SSE会话ID `enkaku-session-id` 头曰. 与已知会话相关的信件共享会话处理. 没有会话的一次性请求和信件仍然会暴露他们的HTTP请求.

上下文搜索使用消息对象身份和一个弱地图. 未知对象、已克隆信件和非对象值返回 `undefined`。 。 。 . 上下文保留在序列信息之外 . 服务器的 `onInvocation` 钩子通过此上下文接收 `ctx.transport`键入为 `unknown`。 。 。 . 客户端断开或会话中断 `ctx.signal` 在等待的钩子中,并阻止随后的处理器调度.

## SSE 会话所有权

`HTTPSessionHandle` 曝光只读 `id` 财务报告和审定财务报表 `owner` 属性加 `bindOwner(did: string): void`。 。 。 . 会话开始无约束 。 重新装入同样成功的东西 装订另一个 扔并保存了原主人. 由经核实的呼叫者将所有权绑入经认证的引用钩:

```ts
import type { HTTPMessageContext } from '@enkaku/http-serve'
import { ServerTransport } from '@enkaku/http-serve'
import { Server } from '@enkaku/server'

const transport = new ServerTransport<typeof protocol>()
const server = new Server({
  protocol,
  handlers,
  identity,
  accessRules,
  onInvocation(ctx) {
    const context = ctx.transport as HTTPMessageContext | undefined
    if (ctx.caller != null) {
      context?.session?.bindOwner(ctx.caller.iss)
    }
  },
})
server.handle(transport)
```

`ServerTransportOptions` 财务报告和审定财务报表 `ServerBridgeOptions` 接受 `enforceSessionOwner`,默认为 `true`。 。 。 . 引用受约束会话的后面的 POST 格式必须包含 `payload.iss` 匹配其正常的拥有者. 装入正常状态的仓库 长而短 `did:peer:4` 表格显示同一所有者. 缺少或不同的发行者生成 HTTP `403` 与 `{ error: 'Session owner mismatch' }` 在编辑信息之前. 这适用于请求、事件、流、信道、发送和中止消息. 大桥比较了正常化的DOS. RPC服务器仍然对消息进行认证. 不受约束的会话保持他们现有的行为. 设置 `enforceSessionOwner: false` 禁用检查而不清除所有权.

## 已写入框架字节

两者 `ServerTransportOptions` 财务报告和审定财务报表 `ServerBridgeOptions` 接受同步 `onFrameWritten(info: FrameWrittenInfo)` 观察员.

| 外地 | 含义 |
| --- | --- |
| `kind` | `'response'`, (中文(简体) ), `'sse'` 或者说 `'heartbeat'` |
| `bytes` | 串行体或帧的 UTF-8 字节长度 |
| `rid` | 请求响应和SSE框架的ID, 心跳没有 |
| `sessionID` | SSE 框架和心跳的会话 ID |

```ts
const transport = new ServerTransport<typeof protocol>({
  onFrameWritten(info) {
    console.log(info.kind, info.bytes, info.rid, info.sessionID)
  },
})
```

反应计数覆盖JSON消息机体. SSE 计数包括 `data:` 前缀和后缀 `\n\n`。 。 。 . 初次和定期心跳评论 `:\n\n` 并计为3个字节,带有会话ID,没有请求ID. 每个被排列的SSE帧都会产生回调,包括被帧触发的缓冲溢出. 排队前拒绝的框架不会产生回调 . 计数不包括HTTP头和网络间接费用. 解答或排入帧不能确认交付给客户. 同步回调的例外被记录下来并吞入,所以写作继续.

## 常见问题

### @enkaku/http-serve 是什么？

Enkaku RPC 服务器的 HTTP 传输

### 如何安装 @enkaku/http-serve？

在项目目录运行 npm install @enkaku/http-serve，或使用 pnpm add / yarn add / bun add。

### @enkaku/http-serve 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @enkaku/http-serve 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @enkaku/http-serve 可以商用吗？

@enkaku/http-serve 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @enkaku/http-serve 的下载量有多少？

根据 npm 官方下载统计，@enkaku/http-serve 在 2026/10/14 – 2026/11/12 这 30 天内被下载 3,333 次，日均约 111 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @enkaku/http-serve 还在维护吗？

最新版本 0\.23\.3 发布于 2026/11/11（2 天前）；至今共发布 19 个版本，其中过去 12 个月发布了 19 个；首次发布于 2026/06/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。