开发者指南
Tip
什么时候需要读这篇:准备为 ErisPulse 开发扩展——给机器人加功能(模块)或接入新平台(适配器)——时。只想使用机器人则跳过,直接看快速开始。
从这里找到你的开发路径:模块开发让你用命令、消息处理器扩展机器人功能;适配器开发让机器人连上新的消息平台。两条路径都覆盖从创建项目到测试、发布的完整流程。
内容列表
模块开发
- 模块开发入门 - 创建第一个模块
- 模块核心概念 - 模块的核心概念和架构
- Event 包装类详解 - Event 对象的完整说明
- 模块最佳实践 - 开发高质量模块的建议
- 数据模型层(ORM) - 模块开发进阶:声明式模型、自动建表与增删改查
适配器开发
- 适配器开发入门 - 创建第一个适配器
- 适配器核心概念 - 适配器的核心概念(含 start() 两种写法与 PollingAdapter / WebhookAdapter 连接模式基类)
- SendDSL 详解 - Send 消息发送 DSL 的完整说明
- 事件转换器 - 实现事件转换器
- 适配器最佳实践 - 开发高质量适配器的建议
测试与排查
- 模块测试(ErisPulse-Testing) - TestBot、事件工厂与断言面
通用规范
- 配置与 UI 元数据 - 声明式配置:widget / 条件显隐 / 值形态 / 兼容性契约(适配器与模块通用)
发布指南
- 发布与模块商店指南 - 将你的作品发布到 PyPI 和 ErisPulse 模块商店
开发准备
在开始开发之前,请确保你:
开发类型选择
根据你的需求选择合适的开发类型:
如果你想扩展机器人的功能(如添加命令、处理消息),选择模块开发。如果你需要让机器人连接到一个新的平台,选择适配器开发。
开发工具
项目模板
ErisPulse 提供了示例项目作为参考:
- 模块示例 - 模块的完整项目结构(命令 / 配置 / ORM / 依赖注入)
- Web 能力示例 - 路由装饰器 / 中间件 / WebSocket 钩子 / router.app 逃生舱
- 交互进阶示例 - 消息事务与回执 / ORM 联合唯一与事务 / 请求审批 / 发送链
- 运维治理示例 - 线程任务归属 / 延迟任务 / 内存体检 / 隐私开关
- 适配器示例 - 适配器的完整项目结构(另有 轮询 / Webhook 变体)
开发模式
使用热重载模式进行开发,代码修改后自动重载:
epsdk run main.py --reload
调试技巧
在 config/config.toml 中启用 DEBUG 或 TRACE 级别日志:
[ErisPulse.logger]
# DEBUG: 输出模块加载、路由注册等开发调试信息
# TRACE: 最低级别,输出事件分发、存储写入、懒加载等框架内部详细流程
level = "DEBUG"
发布你的模块
完整的发布流程请参考 发布与模块商店指南,包括 PyPI 发布步骤、ErisPulse 模块商店提交流程等。