NcatBot 的几种开发范式

前台模式（大多数）

提示

3.x.y 版本中，该模式称为 "插件模式"

前台模式下，你的代码只能通过回调函数被调用。（NcatBot 在前台运行）

适合场景：

• QQ Bot 是项目的核心，程序的生命周期就是 Bot 的生命周期。

讲人话（以下几种情况都是）：

• 收到消息、加群通知之后做点什么。
• 定时发送一些消息。
• 你无法明白前台模式和后台模式的差异。

参考代码。

后台模式

提示

3.x.y 版本中，该模式称为 "主动模式"/"嵌入模式"

后台模式启动后，会返回一个 BotAPI 示例，通过 API 可以调用有关接口完成对应操作。（NcatBot 在后台运行）

可以注册回调函数以便接收 QQ 端的消息。

适合场景：

• QQ Bot 只是项目工作流的一个组件，程序的生命周期不应该由 NcatBot 管理。

参考代码

文档导航

1. 开始

• 1. 认识 NcatBot: 项目简介与社区信息。
• 2. 快速开始: 最快 5 分钟跑通 NcatBot。
• 安装教程：
  • 通用安装指南
  • Linux 安装
  • Windows 安装
  • MacOS 安装
• 安装和使用插件: 了解如何获取并启用社区插件。

2. 基本开发

• 1. 插件最小示例
• 2. 前后台模式最小示例
• 3. NcatBot 生命周期
• 4. 配置项
• 5. 状态量

3. 组件介绍

• 1. 核心组件概览
• 2. BotClient
• 3. PluginLoader
• 4. EventBus
• 5. Adapter
• 6. BotAPI

4. 数据结构介绍

• 1. 核心数据结构概览
• 2. BaseEventData
• 3. MessageArray
• 4. MessageSegment
• 5. ForwardConstructor

5. API 参考

• 1. 概览
• 2. Message 有关 API
• 3. Account 有关 API
• 4. Group 有关 API
• 5. private 有关 API
• 6. Support 有关 API
• 实战手册：
  • 常见场景

7. 插件系统

• 1. 介绍
• 2. 插件类的成员
• 插件的交互系统：
  • 3.1 事件的发布和订阅
  • 3.2 功能和命令
  • 3.3 权限系统
  • 3.4 系统命令
  • 3.5 内置插件的拓展功能
• 插件高级功能：
  • 4.1 添加依赖
  • 4.2 私有工作目录
  • 4.3 定时任务
  • 4.4 插件配置项
• 5. 发布你的插件

8. 高级教程

• 统一命令注册器：
  • 概览
  • 快速开始
  • 命令系统
  • 参数解析
  • 过滤器系统
  • 测试指南
  • 实战案例
  • 最佳实践
  • FAQ
• 测试：
  • 概览
  • 快速开始
  • API 参考
  • 函数式测试最佳实践
  • 集成测试最佳实践
• 其他：
  • 远端模式
  • 日志
  • CLI
  • AI+NcatBot
  • 开发技巧
• 最佳实践

9. 实际项目参考

• 教程项目：
  • 发送复杂消息
  • 上传和获取文件
  • 处理好友请求和加群请求
• 1. 简单 BotClient 项目

10. 常见问题

• 1. 安装时常见问题
• 2. 运行时常见问题
• 3. 开发时常见问题

版权所有

版权归属：huan-yp

许可证：署名 4.0 国际 (CC-BY-4.0)