feat(docs): 更新文档,添加项目结构和部署指南,优化快速上手部分

This commit is contained in:
2026-01-29 21:35:20 +08:00
parent 351ed0b063
commit f2bf1e4ca5
6 changed files with 437 additions and 186 deletions

View File

@@ -1,59 +1,81 @@
#
# 架构设计
Neobot是面向内部开发者的我会开源但是写的很烂。。
NEO Bot 是一个现代化的、高性能的异步 QQ 机器人框架。本文介绍其核心架构和设计理念
## 1. 动力核心
## 1. 性能优化体系
### Python 3.14 + JIT
镀铬酸钾创项目的时候用的 Python 3.14 3.14兼容JIT那就这样吧
* **何原理**: 运行时把热点代码编译成机器码Just-In-Time
* **何用途**: 密集CPU运算能提升一些尤其是插件里的循环和函数调用
* **怎么开**: 启动时加 `-X jit` 参数
### Python 3.14 JITJust-In-Time 编译)
### Mypyc 编译 (AOT)
光 JIT 还不够。。核心模块(`core/ws.py`, `core/managers/*.py`我编译成了C扩展
* **何原理**: 因为这个项目有很多类型提示然后我就编译成C库了。。。
* **何用途**: WS和manager下边的模块都是机器码运行或许会快一些。。。
**原理**Python 3.14 内置 JIT 编译器,运行时将高频调用的代码编译成机器码。
### 异步 IO 模型
* **Linux**: uvloop
* **Windows**:IOCP
* **: `winloop` 死了,会和面具打架。。。
**适用场景**
- 插件业务逻辑(循环、函数调用密集)
- 消息处理流程
## 2. 连接模式
**启用方法**
### 正向 WebSocket 模式
这是一种简单直接的模式
* **主动出击 (Client)**: Bot 是个客户端
* **好处**: 你电脑能上网就行实际上是因为没公网ip哈。。。
```mermaid
graph LR
subgraph Local [你的电脑/服务器]
Bot[NEO Bot]
Browser[Playwright 页面池]
end
subgraph Remote [外部]
NapCat[NapCatQQ]
end
Bot -- "WebSocket (主动连接)" --> NapCat
Bot -- "内部调用" --> Browser
```bash
python -X jit main.py
```
## 3. 资源管理
预期性能提升2-5 倍(取决于代码热点)。
### Mypyc 编译AOT - Ahead-Of-Time
**原理**:将类型注解的 Python 代码编译为 C 扩展,生成平台相关的二进制文件。
**编译范围**
- `core/ws.py` - WebSocket 通信
- `core/managers/` - 各种管理器
- `core/api/` - API 封装
- `models/` - 数据模型
**启用方法**
```bash
python setup_mypyc.py build_ext --inplace
```
预期性能提升3-10 倍(核心模块)。
**注意**:编译产物平台相关,必须在目标环境编译。
### 异步 IO 模型
**Linux**`uvloop`libev 绑定,比 asyncio 快 2-4 倍)
**Windows**IOCPWindows 原生高性能 IO
## 2. 连接架构
### 正向 WebSocket 连接
NEO Bot 采用**正向 WebSocket 连接**模式Bot 主动连接 OneBot 实现(如 NapCatQQ
**流程**
```
Bot 启动 → 连接到 NapCatQQ (ws://127.0.0.1:3001)
监听消息事件
分发到处理器
调用 API 回复
```
## 3. 资源管理架构
### 单例管理器
所有东西(指令、权限、浏览器、图片)都是全局独一份的。
* **随叫随到**: 在哪都能直接 `import`
* **绝对权威**: 全局就一份数据
### 资源池化
别几把开多个实例。。。
* **Browser Pool**: 浏览器页面提前开好,用完洗干净放回去
* **Connection Pool**: Redis 和 HTTP 请求都用连接池
所有全局资源通过单例管理器统一管理,避免重复创建和资源泄漏。
### Playwright 页面池
预初始化页面,无需每次都启动浏览器,大幅降低延迟。
### HTTP 连接复用
全局 aiohttp.ClientSession 支持 Keep-Alive减少连接建立开销。
## 4. 技术栈全景