Files
NeoBot/docs/core-concepts/architecture.md
镀铬酸钾 12d1eb3438 Dev (#45)
* 滚木

* 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): 统一代码风格和常量命名

* fix(scripts): 修复编码问题并添加错误追踪

在compile_machine_code.py中添加utf-8编码设置以避免潜在编码问题
添加traceback.print_exc()以在编译失败时打印完整错误堆栈
更新.gitignore以忽略config.toml文件

* feat(性能分析): 实现性能分析工具模块并添加相关测试

添加性能分析工具模块,包括时间测量、内存分析和性能统计功能
添加测试文件和示例配置,完善性能分析工具的使用场景
在工具模块中实现单例装饰器并导出到__init__.py

* feat(douyin_parser): 新增抖音视频解析插件

refactor(performance): 移除未使用的asyncio导入并优化性能测试
style(compile_modules): 修正字符串引号格式
chore: 删除废弃的编译脚本和临时文件
fix(bili_parser): 增强B站链接解析的健壮性
refactor(singleton): 重构单例模式实现
docs: 更新配置文件和事件模型注释

* feat: 添加抖音视频解析插件并优化代码结构

添加抖音视频解析插件,支持自动解析抖音分享链接并提取视频信息。优化现有代码结构,包括:
- 重构单例模式实现
- 移除未使用的导入和文件
- 修复性能测试脚本中的异步调用
- 优化消息事件模型中的权限常量定义
- 改进编译脚本的错误处理
- 增强B站解析插件的稳定性

同时清理了多个废弃脚本和临时文件,提升代码可维护性。

* 1

* Delete core/data/temp/help_menu.png

* fix(权限管理): 增强权限检查的类型安全并修复权限引用

修复权限检查中可能传入非Permission类型导致的错误,将echo插件的权限引用从MessageEvent.ADMIN迁移到Permission.ADMIN

* redis取消tls

* feat(github_parser): 添加GitHub仓库信息查询功能

- 新增github_parser插件,支持通过命令或自动解析链接查询GitHub仓库信息
- 添加github_repo.html模板用于渲染仓库信息图片
- 优化图片管理器支持高质量截图和CSS缩放
- 重构消息事件类权限常量定义方式
- 更新帮助页面样式为三列布局并优化响应式设计

* feat(web_parser): 新增通用web链接解析插件框架

refactor: 重构B站、抖音、GitHub解析器为模块化结构

fix(executor): 增强docker容器错误处理和回调稳定性

style(templates): 优化帮助页面和代码执行结果的样式

perf(web_parser): 添加API缓存和消息去重机制

docs: 更新插件元信息和注释

chore: 移除旧的独立解析器插件文件

* refactor(managers): 重构单例管理器实现并优化代码结构

feat(ws_pool): 新增 WebSocket 连接池实现

perf(json): 使用 orjson 替代标准 json 库提升性能

style: 清理未使用的导入和冗余代码

docs: 更新架构文档和开发规范

test: 添加 WebSocket 连接池测试用例

fix(plugins): 修复自动审批插件 API 调用参数格式

---------

Co-authored-by: baby20162016 <2185823427@qq.com>
Co-authored-by: web vscode <youremail@example.com>
2026-01-22 16:25:13 +08:00

8.6 KiB
Raw Blame History

骨架

Neobot是面向内部开发者的我会开源但是写的很烂。。。

1. 动力核心

Python 3.14 + JIT

镀铬酸钾创项目的时候用的 Python 3.14 3.14兼容JIT那就这样吧

  • 何原理: 运行时把热点代码编译成机器码Just-In-Time
  • 何用途: 密集CPU运算能提升一些尤其是插件里的循环和函数调用
  • 怎么开: 启动时加 -X jit 参数

Mypyc 编译 (AOT)

光 JIT 还不够。。核心模块(core/ws.py, core/managers/*.py我编译成了C扩展

  • 何原理: 因为这个项目有很多类型提示然后我就编译成C库了。。。
  • 何用途: WS和manager下边的模块都是机器码运行或许会快一些。。。

异步 IO 模型

  • Linux: uvloop
  • Windows:IOCP
    • : winloop 死了,会和面具打架。。。

2. 连接模式

正向 WebSocket 模式

这是一种简单直接的模式

  • 主动出击 (Client): Bot 是个客户端
    • 好处: 你电脑能上网就行实际上是因为没公网ip哈。。。
graph LR
    subgraph Local [你的电脑/服务器]
        Bot[NEO Bot]
        Browser[Playwright 页面池]
    end
    
    subgraph Remote [外部]
        NapCat[NapCatQQ]
    end

    Bot -- "WebSocket (主动连接)" --> NapCat
    Bot -- "内部调用" --> Browser

3. 资源管理

单例管理器

所有东西(指令、权限、浏览器、图片)都是全局独一份的。

  • 随叫随到: 在哪都能直接 import
  • 绝对权威: 全局就一份数据

资源池化

别几把开多个实例。。。

  • Browser Pool: 浏览器页面提前开好,用完洗干净放回去
  • Connection Pool: Redis 和 HTTP 请求都用连接池

4. 技术栈全景

NEO Bot 的“骨架”是由一堆现代 Python 库和技术堆起来的。下面这张清单能让你一眼看清整个项目的技术选型。

编程语言与运行时

  • Python 3.14: 镀铬酸钾创项目的时候用的 Python 3.14 3.14兼容JIT那就这样吧
  • JIT (Just-In-Time): 启动时加 -X jit 参数,运行时把热点代码编译成机器码
  • Mypyc (AOT): 核心模块(core/ws.py, core/managers/*.py编译成C扩展机器码运行

异步与网络

  • asyncio: Python 原生异步框架,所有 IO 操作都是非阻塞的
  • uvloop (Linux): 替代 asyncio 默认事件循环,性能更高
  • IOCP (Windows): Windows 上的高性能 IO 完成端口
  • aiohttp: 异步 HTTP 客户端/服务器,用于 API 请求和 WebSocket 通信
  • websockets: 纯粹的 WebSocket 客户端/服务器库
  • Playwright: 浏览器自动化工具,负责截图、页面渲染

数据与存储

  • Redis: 内存数据库,用于缓存帮助图片、会话状态等
  • orjson: Rust 编写的 JSON 序列化库,比标准 json 快很多
  • Pydantic: 数据验证与设置管理配置文件、API 请求/响应都靠它

工具与工具链

  • Loguru: 结构化日志记录,输出漂亮且支持文件轮转
  • Watchdog: 文件系统监控,实现插件热重载
  • Jinja2: 模板引擎,渲染 HTML 页面然后转为图片
  • Pillow: 图像处理库,负责图片格式转换、尺寸调整
  • BeautifulSoup4: HTML 解析B站、抖音等链接解析插件在用
  • httpx: 异步 HTTP 客户端,某些插件用它发请求

测试与开发

  • Pytest: 测试框架,写单元测试、集成测试
  • Docker: 容器化,沙箱执行用户代码时可能用到
  • cryptography: 加密解密,处理一些安全相关的操作

架构模式

  • Singleton (单例): 全局唯一实例,所有管理器都是单例
  • Connection Pool (连接池): Redis 连接、HTTP 会话都复用
  • Plugin System (插件系统): 动态导入、装饰器注册,一个 .py 文件就是一个插件

5. Python 动态语言特性运用

Python 是一门“动态”语言这意味着你可以在运行时做很多静态语言做不到的事情。NEO Bot 大量利用了这些特性,让框架变得灵活、易扩展。

装饰器 (Decorator)

  • 何用: 给函数“贴上标签”,告诉框架这个函数是干什么的
  • 何处:
    • @matcher.command("echo") 注册一个消息指令
    • @matcher.on_message() 注册一个通用消息处理器
    • @matcher.on_notice() 注册一个通知事件处理器
  • 何原理: 装饰器本质上是一个高阶函数,它接收被装饰的函数,然后把它“注册”到某个管理器里

动态导入 (Dynamic Import)

  • 何用: 不需要在代码开头写死 import,运行时根据情况加载模块
  • 何处: PluginManager.load_all_plugins()importlib.import_module() 扫描 plugins/ 目录,找到 .py 文件就导入
  • 何原理: Python 的模块系统是完全动态的,import 语句实际上调用了 __import__() 函数

自省 (Introspection)

  • 何用: 让代码能“看到”自己的结构,比如函数属于哪个模块、有哪些参数
  • 何处:
    • inspect.getmodule(func) 获取函数所在的模块名,用于记录插件来源
    • func.__name__, func.__module__ 获取函数名和模块名
  • 何原理: Python 把几乎所有元信息都存在对象的 __dict__ 里,你可以随时翻看

鸭子类型 (Duck Typing)

  • 何用: “如果它走起来像鸭子,叫起来像鸭子,那它就是鸭子。”——不检查类型,只检查行为
  • 何处:
    • 事件处理器不要求事件对象必须是某个类,只要它有 post_typeuser_id 等属性就行
    • 插件不需要继承某个基类,只要它有 __plugin_meta__ 字典就行
  • 何原理: Python 的变量没有类型,类型是对象自己的事。只要对象有你需要的方法或属性,你就可以调用它

反射 (Reflection)

  • 何用: 在运行时检查、修改对象的结构
  • 何处:
    • getattr(module, "__plugin_meta__") 获取插件的元数据字典
    • hasattr(event, "raw_message") 检查事件对象是否有某个属性
    • setattr() 动态设置属性(虽然用得少)
  • 何原理: Python 的对象本质上就是字典(__dict__getattr/setattr 就是对这个字典的操作

元编程 (Metaprogramming)

  • 何用: 在代码运行时改变代码的行为
  • 何处:
    • Singleton 基类重写 __new__ 方法,控制实例创建,确保全局只有一个实例
    • 装饰器在函数定义时修改函数,给它添加额外逻辑
  • 何原理: Python 的类也是对象(类型对象),你可以通过修改类来影响它所有实例的行为

上下文管理器 (Context Manager)

  • 何用: 安全地获取和释放资源,比如文件、网络连接、浏览器页面
  • 何处:
    • async with browser_manager.get_page() as page: 从页面池获取一个页面,用完后自动放回
    • async with aiohttp.ClientSession() as session: 发起 HTTP 请求后自动关闭会话
  • 何原理: __enter__/__exit__(同步)或 __aenter__/__aexit__(异步)协议

描述符 (Descriptor)

  • 何用: 控制属性访问的逻辑,比如把方法伪装成属性
  • 何处:
    • @property 把方法变成只读属性,比如 PluginManager.command_manager
    • @property.setter 给属性设置值时的自定义逻辑
  • 何原理: 描述符是一个实现了 __get____set____delete__ 方法的类

猴子补丁 (Monkey Patching)

  • 何用: 在运行时修改模块、类或对象,通常用于测试或修复第三方库
  • 何处: 测试中可能会用 unittest.mock.patch 临时替换某个函数,模拟它的行为
  • 何原理: Python 的模块和类都是可变的,你可以直接给它们赋值新属性

eval/exec

  • 何用: 执行字符串形式的 Python 代码
  • 何处: code_py.py 插件中,用户发送的代码片段会被 exec() 执行,实现代码沙箱功能
  • 何原理: Python 解释器本身就是一个运行时环境,eval() 用于表达式,exec() 用于语句

类型提示 (Type Hints)

  • 何用: 虽然 Python 是动态类型,但类型提示能让代码更清晰,工具(如 Mypy也能做静态检查
  • 何处: 几乎所有函数和方法的参数、返回值都加了类型提示,这让 Mypyc 编译成为可能
  • 何原理: 类型提示只是注解,运行时通常被忽略(除非你用 typing 模块做检查)