网关内部机制
消息网关是长运行进程,通过统一架构将 Hermes 连接到 14 多个外部消息平台。
关键文件
| 文件 | 用途 |
|---|---|
gateway/run.py | GatewayRunner —— 主循环、斜杠命令、消息调度(~7,500 行) |
gateway/session.py | SessionStore —— 对话持久化和会话密钥构建 |
gateway/delivery.py | 出站消息传递到目标平台/频道 |
gateway/pairing.py | 用户授权的 DM 配对流程 |
gateway/channel_directory.py | 将聊天 ID 映射到 cron 传递的人类可读名称 |
gateway/hooks.py | 钩子发现、加载和生命周期事件调度 |
gateway/mirror.py | send_message 的跨会话消息镜像 |
gateway/status.py | 配置文件范围的网关实例的令牌锁管理 |
gateway/builtin_hooks/ | 始终注册的钩子(例如 BOOT.md 系统提示钩子) |
gateway/platforms/ | 平台适配器(每个消息平台一个) |
架构概述
┌─────────────────────────────────────────────────┐
│ GatewayRunner │
│ │
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ │
│ │ Telegram │ │ Discord │ │ Slack │ ... │
│ │ Adapter │ │ Adapter │ │ Adapter │ │
│ └─────┬─────┘ └─────┬────┘ └─────┬────┘ │
│ │ │ │ │
│ └──────────────┼──────────────┘ │
│ ▼ │
│ _handle_message() │
│ │ │
│ ┌────────────┼────────────┐ │
│ ▼ ▼ ▼ │
│ Slash command AIAgent Queue/BG │
│ dispatch creation sessions │
│ │ │
│ ▼ │
│ SessionStore │
│ (SQLite persistence) │
└─────────────────────────────────────────────────┘消息流程
当消息从任何平台到达时:
- 平台适配器接收原始事件,将其规范化为
MessageEvent - 基适配器检查活动会话守卫:
- 如果智能体正在为此会话运行 → 将消息排队,设置中断事件
- 如果是
/approve、/deny、/stop→ 绕过守卫(内联调度)
- GatewayRunner._handle_message() 接收事件:
- 通过
_session_key_for_source()解析会话密钥(格式:agent:main:{platform}:{chat_type}:{chat_id}) - 检查授权(参见下面的授权)
- 检查是否是斜杠命令 → 调度到命令处理程序
- 检查智能体是否已在运行 → 拦截
/stop、/status等命令 - 否则 → 创建
AIAgent实例并运行对话
- 通过
- 响应通过平台适配器发送回
会话密钥格式
会话密钥编码完整的路由上下文:
agent:main:{platform}:{chat_type}:{chat_id}例如:agent:main:telegram:private:123456789
支持话题的平台(Telegram 论坛话题、Discord 话题、Slack 话题)可能在 chat_id 部分包含话题 ID。永远不要手动构建会话密钥 —— 始终使用 gateway/session.py 中的 build_session_key()。
两级消息守卫
当智能体正在主动运行时,传入消息通过两个顺序守卫:
第 1 级 —— 基适配器 (
gateway/platforms/base.py):检查_active_sessions。如果会话处于活动状态,将消息排队到_pending_messages并设置中断事件。这在消息到达网关运行器之前捕获消息。第 2 级 —— 网关运行器 (
gateway/run.py):检查_running_agents。拦截特定命令(/stop、/new、/queue、/status、/approve、/deny)并适当路由。其他所有内容触发running_agent.interrupt()。
当智能体被阻塞时必须到达运行器的命令(如 /approve)通过 await self._message_handler(event) 内联调度 —— 它们绕过后台任务系统以避免竞争条件。
授权
网关使用多层授权检查,按顺序评估:
- 每个平台的允许所有标志(例如,
TELEGRAM_ALLOW_ALL_USERS)—— 如果设置,该平台上的所有用户都被授权 - 平台允许列表(例如,
TELEGRAM_ALLOWED_USERS)—— 逗号分隔的用户 ID - DM 配对 —— 经过身份验证的用户可以通过配对代码配对新用户
- 全局允许所有(
GATEWAY_ALLOW_ALL_USERS)—— 如果设置,所有平台上的所有用户都被授权 - 默认:拒绝 —— 未经授权的用户被拒绝
DM 配对流程
管理员:/pair
网关:"配对代码:ABC123。与用户分享。"
新用户:ABC123
网关:"已配对!你现在已获得授权。"配对状态在 gateway/pairing.py 中持久化,并在重启后保留。
斜杠命令调度
网关中的所有斜杠命令流经相同的解析管道:
hermes_cli/commands.py中的resolve_command()将输入映射到规范名称(处理别名、前缀匹配)- 针对
GATEWAY_KNOWN_COMMANDS检查规范名称 _handle_message()中的处理程序基于规范名称进行调度- 某些命令在配置上受到限制(
CommandDef上的gateway_config_gate)
运行智能体守卫
在智能体处理时绝不能执行的命令会被提前拒绝:
if _quick_key in self._running_agents:
if canonical == "model":
return "⏳ 智能体正在运行 —— 等待完成或先 /stop。"绕过命令(/stop、/new、/approve、/deny、/queue、/status)有特殊处理。
配置来源
网关从多个来源读取配置:
| 来源 | 它提供的内容 |
|---|---|
~/.hermes/.env | API 密钥、机器人令牌、平台凭证 |
~/.hermes/config.yaml | 模型设置、工具配置、显示选项 |
| 环境变量 | 覆盖上述任何内容 |
与 CLI(使用带有硬编码默认值的 load_cli_config())不同,网关通过 YAML 加载器直接读取 config.yaml。这意味着存在于 CLI 默认值字典中但不存在于用户配置文件中的配置键在 CLI 和网关之间可能表现不同。
平台适配器
每个消息平台在 gateway/platforms/ 中都有一个适配器:
gateway/platforms/
├── base.py # BaseAdapter —— 所有平台的共享逻辑
├── telegram.py # Telegram Bot API(长轮询或 webhook)
├── discord.py # 通过 discord.py 的 Discord 机器人
├── slack.py # Slack Socket Mode
├── whatsapp.py # WhatsApp Business Cloud API
├── signal.py # 通过 signal-cli REST API 的 Signal
├── matrix.py # 通过 mautrix 的 Matrix(可选 E2EE)
├── mattermost.py # Mattermost WebSocket API
├── email.py # 通过 IMAP/SMTP 的电子邮件
├── sms.py # 通过 Twilio 的 SMS
├── dingtalk.py # 钉钉 WebSocket
├── feishu.py # 飞书/ Lark WebSocket 或 webhook
├── wecom.py # 企业微信(微信工作)回调
├── weixin.py # 微信(个人微信)通过 iLink Bot API
├── bluebubbles.py # 通过 BlueBubbles macOS 服务器的 Apple iMessage
├── webhook.py # 入站/出站 webhook 适配器
├── api_server.py # REST API 服务器适配器
└── homeassistant.py # Home Assistant 对话集成适配器实现通用接口:
connect()/disconnect()—— 生命周期管理send_message()—— 出站消息传递on_message()—— 入站消息规范化 →MessageEvent
令牌锁
使用唯一凭证连接的适配器在 connect() 中调用 acquire_scoped_lock(),在 disconnect() 中调用 release_scoped_lock()。这防止两个配置文件同时使用相同的机器人令牌。
传递路径
出站传递 (gateway/delivery.py) 处理:
- 直接回复 —— 将响应发送回原始聊天
- 主页频道传递 —— 将 cron 作业输出和后台结果路由到配置的主页频道
- 显式目标传递 ——
send_message工具指定telegram:-1001234567890 - 跨平台传递 —— 传递到与原始消息不同的平台
cron 作业传递不会镜像到网关会话历史 —— 它们只存在于自己的 cron 会话中。这是为了避免消息交替违规的故意设计选择。
钩子
网关钩子是在生命周期事件上响应的 Python 模块:
网关钩子事件
| 事件 | 触发时机 |
|---|---|
gateway:startup | 网关进程启动 |
session:start | 新对话会话开始 |
session:end | 会话完成或超时 |
session:reset | 用户使用 /new 重置会话 |
agent:start | 智能体开始处理消息 |
agent:step | 智能体完成一次工具调用迭代 |
agent:end | 智能体完成并返回响应 |
command:* | 执行任何斜杠命令 |
钩子从 gateway/builtin_hooks/(始终活动)和 ~/.hermes/hooks/(用户安装)发现。每个钩子是一个带有 HOOK.yaml 清单和 handler.py 的目录。
记忆提供商集成
当启用记忆提供商插件(例如,Honcho)时:
- 网关为每个消息创建一个带会话 ID 的
AIAgent MemoryManager用会话上下文初始化提供商- 提供商工具(例如,
honcho_profile、viking_search)通过以下方式路由:
AIAgent._invoke_tool()
→ self._memory_manager.handle_tool_call(name, args)
→ provider.handle_tool_call(name, args)- 会话结束/重置时,
on_session_end()触发以进行清理和最终数据刷新
记忆刷新生命周期
当会话被重置、恢复或过期时:
- 内置记忆被刷新到磁盘
- 记忆提供商的
on_session_end()钩子触发 - 临时
AIAgent运行仅记忆的对话回合 - 然后上下文被丢弃或归档
后台维护
网关在消息处理旁边运行定期维护:
- Cron 滴答 —— 检查作业计划并触发到期作业
- 会话过期 —— 超时后清理废弃会话
- 记忆刷新 —— 在会话过期前主动刷新记忆
- 缓存刷新 —— 刷新模型列表和提供商状态
进程管理
网关作为长存活进程运行,通过以下方式管理:
hermes gateway start/hermes gateway stop—— 手动控制systemctl(Linux) 或launchctl(macOS) —— 服务管理~/.hermes/gateway.pid处的 PID 文件 —— 配置文件范围的进程跟踪
配置文件范围 vs 全局:start_gateway() 使用配置文件范围的 PID 文件。hermes gateway stop 仅停止当前配置文件的网关。hermes gateway stop --all 使用全局 ps aux 扫描来终止所有网关进程(更新期间使用)。