feat: 添加性能优化和架构文档,更新依赖和核心模块

refactor(browser_manager): 实现页面池机制以提升性能
refactor(image_manager): 添加模板缓存并集成页面池
refactor(bili_parser): 迁移到异步HTTP请求并实现会话复用
docs: 新增性能优化、架构设计和最佳实践文档
chore: 更新requirements.txt添加新依赖
This commit is contained in:
2026-01-13 03:56:31 +08:00
parent 5996f6eeaf
commit 24af862924
18 changed files with 589 additions and 489 deletions

View File

@@ -1,113 +1,97 @@
# 快速上手
本指南将引导您完成 NEO Bot Framework 的本地开发环境搭建、配置和首次运行
这篇文档教你怎么把 NEO Bot 跑起来。如果你连这都搞不定,建议先去补补 Python 基础
## 1. 环境准备
在开始之前,请确保您的开发环境中已安装以下软件:
别拿老古董环境来跑新代码,我们用的是最新的技术栈。
* **Python**: 版本要求 `3.12` 或更高。
* 我们推荐使用官方的 CPython 解释器
* 您可以通过在终端运行 `python --version` 来检查您的 Python 版本
* **Python**: 必须 `3.14` 或更高。
* 推荐开启 JIT (`-X jit`)
* 别问为什么不用 3.8,问就是慢
* **Git**: 用于克隆项目仓库。
* **Git**: 拉代码用的,这都要教?
* **Redis**: 一个键值对数据库,用于缓存和数据共享
* 对于 Windows 用户,可以考虑使用 `memurai` 或通过 WSL2 安装 Redis
* 对于 macOS 用户,可以使用 `brew install redis`
* 安装后,请确保 Redis 服务正在运行
* **Redis**: 必须装
* Windows 用户自己想办法 (WSL2 或者 Memurai)
* Linux/macOS 用户直接包管理器装
* 没 Redis 跑不起来,别试了
* **OneBot v11 实现**: 机器人框架需要连接到一个实现了 OneBot v11 协议的客户端
* **推荐**: [NapCatQQ](https://github.com/NapNeko/NapCatQQ)
* **OneBot v11 客户**: 机器人本体
* **强烈推荐**: [NapCatQQ](https://github.com/NapNeko/NapCatQQ)
* 别用那些几百年不更新的协议端,出了问题别找我。
## 2. 克隆与安装
## 2. 安装步骤
### 克隆项目
打开您的终端,并克隆项目仓库到本地:
### 拉代码
```bash
git clone [项目仓库地址]
cd [项目目录]
```
### 创建虚拟环境 (推荐)
### 搞个虚拟环境
为了保持项目依赖的隔离,强烈建议您创建一个 Python 虚拟环境
别把系统环境搞脏了,这是基本礼貌
```bash
# 创建虚拟环境
# 创建
python -m venv venv
# 激活虚拟环境
# Windows
# 激活 (Windows)
.\venv\Scripts\activate
# macOS / Linux
# 激活 (Linux/macOS)
source venv/bin/activate
```
### 装依赖
激活虚拟环境后,使用 `pip` 安装所有必需的第三方库:
### 装依赖
```bash
pip install -r requirements.txt
```
### 装浏览器内核
我们用了 Playwright 做渲染,所以得装个 Chromium。
```bash
playwright install chromium
```
### 编译核心 (可选,但推荐)
想体验极致速度?把核心模块编译成 C 扩展。
```bash
python setup_mypyc.py build_ext --inplace
```
*Windows 上需要 Visual Studio Build ToolsLinux 上需要 GCC。编译失败就跳过反正 JIT 也够快了。*
## 3. 配置
项目的核心配置位于根目录下的 `config.toml` 文件中
对于内部开发,该文件通常已预先配置好,可以直接连接到测试服务器。如果您需要连接到自己的环境,请修改以下关键部分:
根目录 `config.toml`
```toml
# config.toml
[napcat_ws]
# 的 OneBot v11 实现端的 WebSocket 地址
# 格式通常为 ws://<IP地址>:<端口号>
# 的 OneBot 地址
# 我们用的是正向连接,也就是 Bot 主动去连 OneBot
uri = "ws://127.0.0.1:3001"
# Access Token (访问令牌),如果您的 OneBot 端设置了
token = ""
[redis]
# Redis 服务的连接信息
host = "127.0.0.1"
port = 6379
db = 0
password = "" # 如果您的 Redis 设置了密码
```
## 4. 首次运行
## 4. 启动
完成以上所有步骤后,您就可以启动机器人了。在项目根目录运行:
一切就绪,起飞。
```bash
python main.py
# 开启 JIT 模式启动
python -X jit main.py
```
如果一切顺利,您将在控制台看到类似以下的输出:
```
2026-01-07 22:42:41.718 | INFO | ... - 管理员管理器初始化完成
2026-01-07 22:42:41.826 | INFO | ... - 正在从 plugins 加载插件...
2026-01-07 22:42:41.994 | SUCCESS | ... - Redis 连接成功!
...
2026-01-07 22:42:42.618 | SUCCESS | ... - 连接成功!
```
看到 `连接成功!` 的日志,即表示您的机器人已成功连接到 OneBot 客户端并准备好接收消息。
## 5. 常见问题排查 (FAQ)
* **Q: 启动时报错 `redis.exceptions.ConnectionError`**
* **A**: 请检查您的 Redis 服务是否已启动,以及 `config.toml` 中的 `host``port` 是否正确。
* **Q: 无法连接到 WebSocket提示 `ConnectionRefusedError`**
* **A**: 请确认您的 OneBot v11 客户端(如 NapCatQQ是否正在运行并检查 `config.toml` 中的 `uri` 地址和端口是否匹配。
* **Q: 修改了插件代码但没有生效**
* **A**: 框架默认开启了热重载功能。请检查控制台是否有 `[HotReload]` 相关的日志输出。如果没有,请确认 `watchdog` 库已正确安装。
现在,您的开发环境已经准备就绪。接下来,您可以尝试修改一个现有插件或[创建您的第一个插件](./plugin-development/index.md)
看到 `连接成功!` 就说明跑通了。如果报错,先看日志,别上来就问。