Dev (#36)
* 滚木 * 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中的项目描述和技术栈说明 - 更新快速上手文档，简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档，添加参数注入示例 - 优化单例管理器文档的表述 --------- Co-authored-by: baby20162016 <2185823427@qq.com>
This commit is contained in:
镀铬酸钾
281
README.md
281
README.md
@@ -1,214 +1,77 @@
|
||||
Calglau BOT by NEO Bot Framework
|
||||
|
||||
[INTERNAL USE ONLY]
|
||||
|
||||
本仓库为 Calglau BOT 的内部开发版本，请遵守相关保密协议。
|
||||
|
||||
Powered by NEO Bot Framework
|
||||
|
||||
项目概述
|
||||
|
||||
Calglau BOT 是一款基于 NEO Bot Framework 构建的功能丰富的 QQ 机器人，采用模块化插件架构设计，支持功能的灵活扩展与独立维护，旨在为社群管理和日常自动化需求提供稳定、高性能且开发体验友好的机器人平台。
|
||||
|
||||
核心特性
|
||||
|
||||
- 模块化插件架构：所有功能均以独立插件形式存放于 plugins/ 目录，支持开发、维护与热重载，降低功能迭代成本。
|
||||
- 高性能异步核心：基于 asyncio 与 websockets 构建，可高效处理高并发消息，保障机器人在高负载场景下的响应速度。
|
||||
- 开发者友好设计：内置插件热重载机制，修改代码无需重启机器人；配套完整类型提示与清晰 API 设计，提升开发效率。
|
||||
- Redis 缓存集成：自动缓存群信息等高频 API 调用结果，减少重复请求，进一步优化响应性能。
|
||||
- 内置帮助系统：通过 /help 指令可自动生成并展示所有已加载插件的功能说明，降低用户使用门槛。
|
||||
|
||||
技术栈
|
||||
|
||||
- 核心框架: Python 3.8+ & NEO Bot Framework
|
||||
- 异步库: asyncio
|
||||
- 网络通信: websockets (OneBot v11 协议)
|
||||
- 缓存服务: Redis
|
||||
- 日志工具: Loguru
|
||||
- 文件监控: watchdog (插件热重载依赖)
|
||||
|
||||
项目结构
|
||||
|
||||
plaintext
|
||||
# Calglau BOT by NEO Bot Framework
|
||||
|
||||
> **[INTERNAL USE ONLY]**
|
||||
>
|
||||
> 本仓库为 Calglau BOT 的内部开发版本，请遵守相关保密协议。
|
||||
|
||||
**Powered by NEO Bot Framework**
|
||||
|
||||
## 项目概述
|
||||
|
||||
**Calglau BOT** 是一个基于 NEO Bot Framework 构建的高性能 QQ 机器人。
|
||||
|
||||
简单来说：扣一
|
||||
|
||||
### 核心特性
|
||||
|
||||
* **模块化插件架构**：所有功能都在 `plugins/` 目录
|
||||
* **极致性能优化**：
|
||||
* **Python 3.14 JIT**：pypy不支持那个浏览器扩展我只能用JIT了。。。
|
||||
* **Mypyc 编译**：一些核心模块已经编译成机器码了
|
||||
* **Playwright 页面池**：浏览器页面预热池
|
||||
* **全局连接复用**：HTTP 和 Redis 连接池化管理
|
||||
* **开发者友好**：完整的类型提示，清晰的 API 设计。
|
||||
* **集成 Redis 缓存**：能缓存的都缓存了。群信息、用户信息、帮助图片
|
||||
* **正向 WebSocket 连接**：我只会支持正向WS连接。。。不要提意见，我不会听的。。。
|
||||
|
||||
### 技术栈
|
||||
|
||||
* **核心框架**: Python 3.14 JIT & NEO Bot Framework
|
||||
* **编译器**: Mypyc
|
||||
* **异步核心**: `asyncio` + `uvloop` (Linux) / 原生 Loop (Windows)
|
||||
* **网络通信**: `websockets` (OneBot v11), `aiohttp` (Shared Session)
|
||||
* **浏览器引擎**: `Playwright` (Chromium) + Page Pool
|
||||
* **数据序列化**: `orjson`
|
||||
* **缓存**: `Redis`
|
||||
* **日志**: `Loguru`
|
||||
|
||||
---
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
.
|
||||
.
|
||||
├── plugins/ # 功能插件目录
|
||||
│ ├── admin.py # 管理员权限管理插件
|
||||
│ ├── bili_parser.py # B站链接解析插件
|
||||
│ ├── code_py.py # Python代码执行插件
|
||||
│ ├── echo.py # 复读与互动插件
|
||||
│ ├── forward_test.py # 合并转发消息演示插件
|
||||
│ ├── jrcd.py # 今日人品等娱乐功能插件
|
||||
│ └── thpic.py # 东方Project图片发送插件
|
||||
├── core/ # NEO框架核心代码（无需修改）
|
||||
│ ├── api/ # 框架API模块
|
||||
│ ├── bot.py # 机器人核心逻辑
|
||||
│ └── ws.py # WebSocket通信模块
|
||||
├── data/ # 数据存储目录
|
||||
│ ├── admin.json # 管理员列表配置
|
||||
│ └── permissions.json # 权限配置文件
|
||||
├── html/ # 静态网页文件目录
|
||||
│ ├── 404.html # 404页面
|
||||
│ └── index.html # 主页
|
||||
├── models/ # 数据模型目录（事件、消息段等）
|
||||
├── .gitignore # Git忽略文件配置
|
||||
├── config.toml # 机器人主配置文件
|
||||
├── main.py # 项目启动入口
|
||||
└── requirements.txt # Python依赖清单
|
||||
|
||||
|
||||
详细开发文档
|
||||
|
||||
想要深入了解框架的工作原理或开发更复杂的插件？
|
||||
👉 点击这里，查阅完整的开发文档
|
||||
|
||||
快速开始
|
||||
|
||||
1. 环境准备
|
||||
|
||||
- Python 3.12 或更高版本
|
||||
- 开发调试阶段推荐使用 CPython 解释器，保障第三方库兼容性与调试体验。
|
||||
- 生产环境部署可考虑 PyPy 解释器，获取潜在性能提升（需注意部分库兼容性）。
|
||||
- 部署并运行 Redis 服务
|
||||
- 准备 OneBot v11 协议实现端（推荐 NapCatQQ）
|
||||
|
||||
2. 安装依赖
|
||||
|
||||
克隆本项目后，在项目根目录执行以下命令安装依赖：
|
||||
|
||||
bash
|
||||
|
||||
pip install -r requirements.txt
|
||||
|
||||
|
||||
3. 配置说明
|
||||
|
||||
[内部开发]
|
||||
项目内置的 config.toml 已预先配置为连接官方 DEV 调试服务器，拉取仓库后通常无需修改即可直接运行。
|
||||
|
||||
若需连接本地或其他环境，可参考以下配置模板调整：
|
||||
|
||||
toml
|
||||
|
||||
# config.toml
|
||||
[napcat_ws]
|
||||
# OneBot 实现端的 WebSocket 地址
|
||||
uri = "ws://127.0.0.1:3001"
|
||||
# Access Token 鉴权（无则留空）
|
||||
├── plugins/ # 插件目录，业务逻辑都在这
|
||||
│ ├── admin.py # 管理员指令
|
||||
│ ├── bili_parser.py # B站解析 (高性能版)
|
||||
│ ├── code_py.py # 代码沙箱
|
||||
│ ├── echo.py # 复读机
|
||||
│ ├── forward_test.py # 合并转发测试
|
||||
│ ├── jrcd.py # 今日运势
|
||||
│ └── thpic.py # 东方图片
|
||||
├── core/ # 框架核心，非请勿动
|
||||
│ ├── api/ # OneBot API 封装
|
||||
│ ├── managers/ # 各种管理器 (指令, 浏览器, 图片, 插件)
|
||||
│ ├── utils/ # 工具函数
|
||||
│ ├── ws.py # WebSocket 通信层 (已编译)
|
||||
│ └── bot.py # Bot 实例
|
||||
├── data/ # 数据存储
|
||||
│ ├── admin.json # 管理员名单
|
||||
│ └── permissions.json # 权限配置
|
||||
├── templates/ # Jinja2 模板
|
||||
├── setup_mypyc.py # 编译脚本
|
||||
└── main.py # 启动入口
|
||||
```
|
||||
|
||||
# 断线重连间隔（单位：秒）
|
||||
reconnect_interval = 5
|
||||
|
||||
## 快速开始
|
||||
|
||||
# 机器人指令前缀（支持配置多个）
|
||||
command_prefixes = ["/", "!", "！"]
|
||||
|
||||
[redis]
|
||||
# Redis 服务连接信息
|
||||
host = "127.0.0.1"
|
||||
port = 6379
|
||||
db = 0
|
||||
password = ""
|
||||
|
||||
|
||||
4. 启动运行
|
||||
|
||||
在项目根目录执行以下命令启动机器人：
|
||||
|
||||
bash
|
||||
|
||||
python main.py
|
||||
|
||||
|
||||
启动成功后，控制台将输出已加载插件列表与 WebSocket 连接状态，机器人将自动接入 OneBot 实现端。
|
||||
|
||||
插件开发指南
|
||||
|
||||
Calglau BOT 的全部功能均通过插件实现，结合热重载机制，开发过程无需频繁重启机器人，极大提升开发效率。
|
||||
|
||||
热重载工作流
|
||||
|
||||
1. 保持 python main.py 进程持续运行
|
||||
2. 在 plugins/ 目录下创建或修改 .py 插件文件
|
||||
3. 保存修改后的文件
|
||||
4. 观察控制台输出 [HotReload] 插件重载完成 提示，修改内容即刻生效
|
||||
|
||||
创建新插件
|
||||
|
||||
1. 在 plugins/ 目录下新建 Python 文件，例如 weather.py
|
||||
2. 按照以下步骤编写插件逻辑
|
||||
|
||||
1. 定义插件元数据
|
||||
|
||||
通过 __plugin_meta__ 字典定义插件信息，确保 /help 指令能自动识别并展示插件功能：
|
||||
|
||||
python
|
||||
|
||||
# plugins/weather.py
|
||||
__plugin_meta__ = {
|
||||
"name": "天气查询",
|
||||
"description": "提供城市天气查询功能",
|
||||
"usage": "/weather [城市名] - 查询指定城市的实时天气",
|
||||
}
|
||||
|
||||
|
||||
2. 编写指令处理器
|
||||
|
||||
使用 @matcher.command() 装饰器注册聊天指令，实现指令响应逻辑：
|
||||
1
|
||||
|
||||
python
|
||||
|
||||
# plugins/weather.py
|
||||
from core.command_manager import matcher
|
||||
from models import MessageEvent
|
||||
|
||||
@matcher.command("weather")
|
||||
async def handle_weather_command(event: MessageEvent, args: list[str]):
|
||||
"""
|
||||
处理 /weather 指令
|
||||
:param event: 消息事件对象，用于回复消息
|
||||
:param args: 用户输入的指令参数列表（按空格分割）
|
||||
"""
|
||||
if not args:
|
||||
await event.reply("请输入要查询的城市名，例如：/weather 北京")
|
||||
return
|
||||
|
||||
city = args[0]
|
||||
# 此处可接入天气API获取真实数据，以下为示例
|
||||
weather_data = f"{city}的天气是：晴，25°C"
|
||||
await event.reply(weather_data)
|
||||
|
||||
|
||||
3. 监听系统事件
|
||||
|
||||
使用 @matcher.on_notice() 装饰器监听机器人事件（如新成员入群），实现事件响应逻辑：
|
||||
|
||||
python
|
||||
|
||||
# plugins/weather.py
|
||||
from core.command_manager import matcher
|
||||
from core.bot import Bot
|
||||
from models import GroupIncreaseNoticeEvent
|
||||
|
||||
@matcher.on_notice("group_increase")
|
||||
async def welcome_new_member(bot: Bot, event: GroupIncreaseNoticeEvent):
|
||||
"""监听群成员增加事件，发送欢迎消息"""
|
||||
welcome_msg = f"欢迎新成员 @{event.user_id} 加入本群！"
|
||||
await bot.send_group_msg(event.group_id, welcome_msg)
|
||||
|
||||
|
||||
当前功能插件
|
||||
|
||||
插件文件 ( plugins/ ) 功能描述
|
||||
admin.py 机器人管理员权限管理（添加/移除管理员、权限验证）
|
||||
bili_parser.py 自动解析 Bilibili 视频链接，生成精美分享卡片
|
||||
code_py.py 执行 Python 代码片段（高危功能，仅限管理员使用）
|
||||
echo.py 提供 /echo 复读指令与 /赞我 互动指令
|
||||
forward_test.py 演示合并转发消息的发送方法
|
||||
jrcd.py 提供今日人品测算、牛牛词典查询等娱乐功能
|
||||
thpic.py 随机发送东方 Project 相关图片
|
||||
|
||||
路线图 (Roadmap)
|
||||
|
||||
Web 仪表盘：开发可视化管理页面，支持查看机器人状态、插件列表与运行日志
|
||||
权限系统重构：引入精细化权限节点，支持按插件/指令维度配置用户权限
|
||||
1. **装环境**: Python 3.14，Redis， OneBot 客户端 (推荐 NapCat)。
|
||||
2. **装依赖**: `pip install -r requirements.txt`
|
||||
3. **装浏览器**: `playwright install chromium`
|
||||
4. **编译核心 (可选)**: `python setup_mypyc.py build_ext --inplace`
|
||||
5. **启动**: `python -X jit main.py`
|
||||
|
||||
详细文档去 `docs/` 目录看
|
||||
|
||||
Reference in New Issue
Block a user