Dev (#40)
* 滚木 * feat: 重构核心架构，增强类型安全与插件管理 本次提交对核心模块进行了深度重构，引入 Pydantic 增强配置管理的类型安全性，并全面优化了插件管理系统。 主要变更详情： 1. 核心架构与配置 - 重构配置加载模块：引入 Pydantic 模型 (`core/config_models.py`)，提供严格的配置项类型检查、验证及默认值管理。 - 统一模块结构：规范化模块导入路径，移除冗余的 `__init__.py` 文件，提升项目结构的清晰度。 - 性能优化：集成 Redis 缓存支持 (`RedisManager`)，有效降低高频 API 调用开销，提升响应速度。 2. 插件系统升级 - 实现热重载机制：新增插件文件变更监听功能，支持开发过程中自动重载插件，提升开发效率。 - 优化生命周期管理：改进插件加载与卸载逻辑，支持精确卸载指定插件及其关联的命令、事件处理器和定时任务。 3. 功能特性增强 - 新增媒体 API：引入 `MediaAPI` 模块，封装图片、语音等富媒体资源的获取与处理接口。 - 完善权限体系：重构权限管理系统，实现管理员与操作员的分级控制，支持更细粒度的命令权限校验。 4. 代码质量与稳定性 - 全面类型修复：解决 `mypy` 静态类型检查发现的大量类型错误（包括 `CommandManager`、`EventFactory` 及 `Bot` API 签名不匹配问题）。 - 增强错误处理：优化消息处理管道的异常捕获机制，完善关键路径的日志记录，提升系统运行稳定性。 * feat: 添加测试用例并优化代码结构 refactor(permission_manager): 调整初始化顺序和逻辑 fix(admin_manager): 修复初始化逻辑和目录创建问题 feat(ws): 优化Bot实例初始化条件 feat(message): 增强MessageSegment功能并添加测试 feat(events): 支持字符串格式的消息解析 test: 添加核心功能测试用例 refactor(plugin_manager): 改进插件路径处理 style: 清理无用导入和代码 chore: 更新依赖项 * refactor(handler): 移除TYPE_CHECKING并直接导入Bot类 简化类型注解，直接导入Bot类而非使用TYPE_CHECKING条件导入，提高代码可读性和维护性 * fix(command_manager): 修复插件卸载时元信息移除不精确的问题 修复 CommandManager 中 unload_plugin 方法移除插件元信息时使用 startswith 导致可能误删其他插件的问题，改为精确匹配 同时调整相关测试用例验证精确匹配行为 * refactor: 清理未使用的导入和更新文档结构 docs: 添加config_models.py到项目结构文档 docs: 调整数据目录位置到core/data下 docs: 更新权限管理器文档描述 * 文档更新 * 更新thpic插件 支持一次返回多张图 * feat: 添加测试覆盖率并修复相关问题 refactor(redis_manager): 移除冗余的ConnectionError处理 refactor(event_handler): 优化Bot类型注解 refactor(factory): 移除未使用的GroupCardNoticeEvent test: 添加全面的单元测试覆盖 - 添加test_import.py测试模块导入 - 添加test_debug.py测试插件加载调试 - 添加test_plugin_error.py测试错误处理 - 添加test_config_loader.py测试配置加载 - 添加test_redis_manager.py测试Redis管理 - 添加test_bot.py测试Bot功能 - 扩展test_models.py测试消息模型 - 添加test_plugin_manager_coverage.py测试插件管理 - 添加test_executor.py测试代码执行器 - 添加test_ws.py测试WebSocket - 添加test_api.py测试API接口 - 添加test_core_managers.py测试核心管理模块 fix(plugin_manager): 修复插件加载日志变量问题 覆盖率已到达86%（忽略插件） * 更新/help指令，现在会发送图片 * feat(help): 重构帮助系统为图片渲染模式 添加浏览器管理器和图片管理器，用于通过 Playwright 渲染帮助菜单为图片 重构命令管理器以支持图片缓存和同步功能 添加 HTML 模板用于帮助菜单渲染 * build: 更新依赖文件 requirements.txt * build: 更新依赖文件 * feat: 添加性能优化和架构文档，更新依赖和核心模块 refactor(browser_manager): 实现页面池机制以提升性能 refactor(image_manager): 添加模板缓存并集成页面池 refactor(bili_parser): 迁移到异步HTTP请求并实现会话复用 docs: 新增性能优化、架构设计和最佳实践文档 chore: 更新requirements.txt添加新依赖 * docs: 更新文档内容并优化语言风格 重构所有文档内容，使用更简洁直接的语言风格 更新架构、插件开发、部署等核心文档 优化代码示例和图表说明 统一术语和格式规范 * docs: 更新文档内容，简化语言并修正格式 - 简化插件开发指南中的描述，移除冗余内容 - 调整部署文档中的Python版本说明 - 优化最佳实践文档的措辞和格式 - 更新性能优化文档，删除不准确的数据 - 重构核心概念文档，使用更简洁的语言 - 修正README中的项目描述和技术栈说明 - 更新快速上手文档，简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档，添加参数注入示例 - 优化单例管理器文档的表述 * refactor(core): 优化权限管理和事件模型 - 重构 AdminManager 和 PermissionManager 以 Redis 为主要数据源 - 为所有事件模型添加 slots=True 提升性能 - 更新文档说明 Mypyc 编译注意事项 - 清理测试和调试文件 - 移动静态资源到 web_static 目录 * feat: 添加模块编译脚本和导出依赖功能 refactor(events): 移除数据类的slots参数以提升兼容性 build: 更新requirements.txt依赖列表 * docs: 更新性能优化文档并修复命令管理器帮助输出 更新性能优化相关文档，详细说明 Python 3.14 JIT 编译器的使用方法和原理，补充与 Mypyc 的互补策略。同时修复命令管理器中帮助信息的输出方式，移除图片发送仅保留文本输出。 调整部署文档结构，明确两种性能优化方案（AOT 和 JIT）的配置方法和适用场景。完善架构文档中关于 JIT 的原理和启用方式说明。 * feat(help): 重构帮助菜单界面并优化样式 refactor(bili_parser): 修复 API 响应 content-type 问题 fix(command_manager): 添加帮助图片获取的错误处理 docs(deployment): 简化部署文档并移除 JIT 相关内容 * feat: 新增自动同意请求插件和API文档 docs: 更新文档结构和内容 * refactor(scripts): 重构并优化脚本文件结构 feat(scripts): 添加Python环境检查脚本 feat(scripts): 增强依赖导出脚本功能 perf(plugins/bili_parser): 优化B站解析器性能和代码结构 style(plugins/bili_parser): 统一代码风格和常量命名 --------- Co-authored-by: baby20162016 <2185823427@qq.com>
This commit is contained in:
镀铬酸钾
130
docs/api/base.md
Normal file
130
docs/api/base.md
Normal file
@@ -0,0 +1,130 @@
|
||||
# API 基础
|
||||
|
||||
这一页讲的是 NEO Bot 里 API 调用的底层原理。如果你只是写插件发消息，可以直接跳过这页，去看 [消息 API](./message.md)。
|
||||
|
||||
但如果你想了解背后发生了什么，或者想自己封装一些高级功能，那这里的信息会帮到你。
|
||||
|
||||
## API 调用流程
|
||||
|
||||
简单来说，当你调用 `bot.send_group_msg()` 时：
|
||||
|
||||
1. **你的插件** → `bot.send_group_msg(123456, "hello")`
|
||||
2. **Bot 类** → 把它打包成 OneBot 标准的 JSON
|
||||
3. **WebSocket** → 通过 `ws.py` 发给 NapCatQQ（或其他 OneBot 实现）
|
||||
4. **OneBot 实现** → 收到请求，真的把消息发到 QQ 群里
|
||||
5. **响应返回** → 原路返回，告诉 Bot “消息发送成功”
|
||||
|
||||
整个过程是异步的，所以你要用 `await`。
|
||||
|
||||
## call_api 方法
|
||||
|
||||
所有 API 最终都会调用 `BaseAPI.call_api()` 方法。这是最底层的接口：
|
||||
|
||||
```python
|
||||
async def call_api(self, action: str, params: Optional[Dict[str, Any]] = None) -> Any:
|
||||
```
|
||||
|
||||
- `action`: API 动作名，比如 `"send_group_msg"`、`"get_login_info"`
|
||||
- `params`: 参数字典，比如 `{"group_id": 123456, "message": "hello"}`
|
||||
|
||||
### 返回值
|
||||
|
||||
`call_api` 返回的是 OneBot 响应中的 `data` 字段。如果 API 调用失败（返回 `{"status": "failed", ...}`），它会记录一条警告日志，但**不会抛出异常**（除非网络错误）。
|
||||
|
||||
这样设计是为了让插件能更灵活地处理失败情况。比如：
|
||||
|
||||
```python
|
||||
try:
|
||||
result = await bot.call_api("send_group_msg", {"group_id": 123456, "message": "test"})
|
||||
if result is None:
|
||||
print("API 调用失败，但没抛异常")
|
||||
except Exception as e:
|
||||
print(f"网络或底层错误: {e}")
|
||||
```
|
||||
|
||||
## 响应格式
|
||||
|
||||
OneBot v11 的标准响应格式是：
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"retcode": 0,
|
||||
"data": { ... },
|
||||
"message": "",
|
||||
"echo": "请求时的 echo 值（如果有）"
|
||||
}
|
||||
```
|
||||
|
||||
- `status`: `"ok"` 或 `"failed"`
|
||||
- `retcode`: 状态码，0 表示成功
|
||||
- `data`: 真正的返回数据
|
||||
- `message`: 错误信息（失败时）
|
||||
- `echo`: 用来匹配请求和响应的标识（WebSocket 用）
|
||||
|
||||
NEO Bot 的 `call_api` 方法会自动提取 `data` 字段返回给你。如果 `status` 是 `"failed"`，它会在日志里记录警告，但依然返回 `data`（通常是 `None` 或空字典）。
|
||||
|
||||
## 错误处理
|
||||
|
||||
API 调用可能因为各种原因失败：
|
||||
|
||||
1. **网络问题**: WebSocket 断开、超时
|
||||
2. **权限不足**: 机器人不是管理员却想踢人
|
||||
3. **参数错误**: 群号不存在、消息太长
|
||||
4. **客户端不支持**: 某些 OneBot 实现可能没实现某些 API
|
||||
|
||||
建议在插件里做好错误处理：
|
||||
|
||||
```python
|
||||
@matcher.command("kick")
|
||||
async def handle_kick(event: MessageEvent, args: str):
|
||||
target_id = int(args) if args.isdigit() else 0
|
||||
if not target_id:
|
||||
await event.reply("参数错误，需要 QQ 号")
|
||||
return
|
||||
|
||||
try:
|
||||
result = await event.bot.set_group_kick(event.group_id, target_id)
|
||||
if result.get("status") == "failed":
|
||||
await event.reply(f"踢人失败: {result.get('message', '未知错误')}")
|
||||
else:
|
||||
await event.reply("踢人成功")
|
||||
except Exception as e:
|
||||
await event.reply(f"网络错误: {e}")
|
||||
```
|
||||
|
||||
## 直接调用 vs 高级封装
|
||||
|
||||
NEO Bot 提供了两种调用 API 的方式：
|
||||
|
||||
### 1. 直接调用 `call_api`
|
||||
|
||||
```python
|
||||
await bot.call_api("send_group_msg", {"group_id": 123456, "message": "hello"})
|
||||
```
|
||||
|
||||
**什么时候用？**
|
||||
- 你想调用的 API 没有被封装成独立方法（很少见）
|
||||
- 你在调试，想看看原始请求和响应
|
||||
- 你在写框架代码，需要动态生成 action 名
|
||||
|
||||
### 2. 使用封装好的方法
|
||||
|
||||
```python
|
||||
await bot.send_group_msg(123456, "hello")
|
||||
```
|
||||
|
||||
**这是推荐的方式**，因为：
|
||||
- 有类型提示，编辑器能帮你补全
|
||||
- 参数有文档，不用去查 OneBot 标准
|
||||
- 有些方法有额外逻辑（比如缓存、参数转换）
|
||||
|
||||
## 下一步
|
||||
|
||||
现在你了解了 API 调用的基础。接下来可以去看看具体的 API 类别：
|
||||
|
||||
- [消息 API](./message.md): 最常用，先看这个
|
||||
- [群组 API](./group.md): 管理群聊
|
||||
- [好友 API](./friend.md): 好友相关操作
|
||||
- [账号 API](./account.md): 机器人自身状态
|
||||
- [媒体 API](./media.md): 图片、语音
|
||||
Reference in New Issue
Block a user