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:
镀铬酸钾
@@ -1,102 +1,102 @@
|
||||
# 部署指南
|
||||
|
||||
当您的机器人开发完成并准备投入生产环境时，本指南将为您提供部署的最佳实践和建议。
|
||||
把 Bot 扔到服务器上长期运行，比在自己电脑上跑要多几个步骤。
|
||||
|
||||
## 1. 生产环境配置
|
||||
## 1. 环境准备
|
||||
|
||||
与开发环境不同，生产环境要求更高的稳定性和安全性。
|
||||
### a. 安装 Python 3.14
|
||||
|
||||
### 创建生产配置文件
|
||||
用3.14。。。
|
||||
|
||||
建议您复制一份 `config.toml` 并重命名为 `config.prod.toml`，专门用于生产环境。
|
||||
### b. 安装依赖
|
||||
|
||||
**关键修改项**:
|
||||
```bash
|
||||
# 切换到项目目录
|
||||
cd /path/to/your/bot
|
||||
|
||||
* **数据库与服务地址**:
|
||||
* 确保 `napcat_ws` 和 `redis` 部分的地址、端口和密码都指向您的生产服务器，而不是本地开发环境。
|
||||
# 创建虚拟环境 (强烈建议)
|
||||
python3.14 -m venv venv
|
||||
source venv/bin/activate
|
||||
|
||||
|
||||
|
||||
## 2. 使用进程守护工具
|
||||
|
||||
直接在终端中运行 `python main.py` 适用于开发，但在生产环境中，如果终端关闭或程序意外崩溃，机器人就会下线。
|
||||
|
||||
为了确保机器人能够 7x24 小时稳定运行，您应该使用**进程守护工具**。
|
||||
|
||||
### 推荐工具
|
||||
|
||||
* **PM2 (Node.js)**: 尽管是 Node.js 工具，但 PM2 提供了强大的 Python 进程管理功能，包括崩溃自启、日志管理和性能监控。
|
||||
* **Supervisor (Python)**: 一个纯 Python 实现的进程控制系统，配置简单，稳定可靠。
|
||||
* **Systemd (Linux)**: Linux 系统自带的服务管理器，可以创建系统服务来管理机器人进程。
|
||||
|
||||
### 使用 PM2 (示例)
|
||||
|
||||
1. **安装 PM2**:
|
||||
```bash
|
||||
npm install -g pm2
|
||||
```
|
||||
|
||||
2. **创建生态系统文件**:
|
||||
在项目根目录创建一个 `ecosystem.config.js` 文件：
|
||||
|
||||
```javascript
|
||||
// ecosystem.config.js
|
||||
module.exports = {
|
||||
apps: [
|
||||
{
|
||||
name: 'neo-bot', // 应用名称
|
||||
script: 'main.py', // 启动脚本
|
||||
interpreter: '/path/to/your/venv/bin/python', // 指定虚拟环境的 Python 解释器
|
||||
env: {
|
||||
'APP_ENV': 'production', // 设置环境变量
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
**注意**: 请务必将 `interpreter` 路径修改为您服务器上虚拟环境的实际路径。
|
||||
|
||||
3. **启动应用**:
|
||||
```bash
|
||||
pm2 start ecosystem.config.js
|
||||
```
|
||||
|
||||
4. **常用 PM2 命令**:
|
||||
* `pm2 list`: 查看所有应用状态
|
||||
* `pm2 logs neo-bot`: 查看日志
|
||||
* `pm2 restart neo-bot`: 重启应用
|
||||
* `pm2 stop neo-bot`: 停止应用
|
||||
* `pm2 startup`: 设置开机自启
|
||||
|
||||
## 3. 禁用热重载
|
||||
|
||||
热重载功能在开发时非常有用，但在生产环境中会带来不必要的性能开销和潜在的不稳定性。
|
||||
|
||||
在部署前，建议您在 `main.py` 中**注释掉**或移除与 `watchdog` 相关的文件监控代码。
|
||||
|
||||
**修改 `main.py`**:
|
||||
|
||||
```python
|
||||
# main.py
|
||||
|
||||
async def main():
|
||||
# ...
|
||||
|
||||
# 生产环境中禁用文件监控
|
||||
# loop = asyncio.get_running_loop()
|
||||
# event_handler = PluginReloadHandler(loop)
|
||||
# observer = Observer()
|
||||
# if os.path.exists(plugin_path):
|
||||
# observer.schedule(event_handler, plugin_path, recursive=True)
|
||||
# observer.start()
|
||||
# logger.info(f"已启动插件热重载监控: {plugin_path}")
|
||||
|
||||
try:
|
||||
# ...
|
||||
finally:
|
||||
# if observer.is_alive():
|
||||
# observer.stop()
|
||||
# observer.join()
|
||||
# 安装依赖
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
遵循以上步骤，您就可以将 NEO Bot 机器人稳定、高效地部署在生产服务器上。
|
||||
### c. 编译核心模块 (可选，但强烈建议)
|
||||
|
||||
为了性能，把核心模块编译成 C 扩展。
|
||||
|
||||
```bash
|
||||
python setup_mypyc.py build_ext --inplace
|
||||
```
|
||||
|
||||
## 2. 使用进程管理器
|
||||
|
||||
你想直接 `python main.py` 然后关掉 SSH？那机器人也跟着停了。必须用进程管理器来守护它。
|
||||
|
||||
这里推荐用 `pm2`，虽然是 Node.js 的工具，但管 Python 程序一样好用。
|
||||
|
||||
### a. 安装 pm2
|
||||
|
||||
```bash
|
||||
# 你需要先装 Node.js 和 npm
|
||||
npm install pm2 -g
|
||||
```
|
||||
|
||||
### b. 启动 Bot
|
||||
|
||||
在项目根目录，创建一个 `ecosystem.config.js` 文件：
|
||||
|
||||
```javascript
|
||||
module.exports = {
|
||||
apps : [{
|
||||
name : "neobot",
|
||||
script : "main.py",
|
||||
interpreter: "/path/to/your/bot/venv/bin/python", // 指定虚拟环境里的 python
|
||||
max_memory_restart: "500M", // 内存超过 500M 自动重启
|
||||
env: {
|
||||
"PYTHONUNBUFFERED": "1" // 禁用 python 输出缓冲，日志能实时看
|
||||
}
|
||||
}]
|
||||
}
|
||||
```
|
||||
|
||||
然后启动：
|
||||
|
||||
```bash
|
||||
pm2 start ecosystem.config.js
|
||||
```
|
||||
|
||||
### c. 常用 pm2 命令
|
||||
|
||||
```bash
|
||||
pm2 list # 查看所有进程状态
|
||||
pm2 logs neobot # 查看 neobot 的实时日志
|
||||
pm2 restart neobot# 重启 neobot
|
||||
pm2 stop neobot # 停止 neobot
|
||||
pm2 delete neobot # 删除 neobot
|
||||
```
|
||||
|
||||
## 3. 配置 NapCatQQ
|
||||
|
||||
最后一步，修改 NapCatQQ 的配置文件，让它把消息推送到你的服务器上。
|
||||
|
||||
找到 NapCatQQ 的 `config/onebot11.json` 文件，修改 `ws_reverse_servers` 部分：
|
||||
|
||||
```json
|
||||
"ws_reverse_servers": [
|
||||
{
|
||||
"url": "ws://你的服务器IP:8080/onebot/v11/ws",
|
||||
"access_token": "你的访问令牌"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
* `url`: 改成你服务器的 IP 和 `main.py` 里配置的端口。
|
||||
* `access_token`: 如果你在 `main.py` 里设置了 `ACCESS_TOKEN`，这里要保持一致。
|
||||
|
||||
|
||||
或者你也可以用napcat的webui，不多赘述了。。。
|
||||
|
||||
|
||||
改完后重启 NapCatQQ，Bot 应该就能收到消息了。
|
||||
|
||||
Reference in New Issue
Block a user