GoroBot

Go语言编写的跨平台聊天机器人框架

支持平台

QQ (pkg/lagrange)
OneBot
QQ Official (pkg/qbot)
Telegram

特性

高性能（我瞎说的反正 Go 怎么也比 Node 快）
高扩展性（插件化设计）
高自订性（插件想干啥都行.jpg）

注意事项

如果有能力，请审查所有使用的代码！！！ 由于语言的特性，开发者拥有极高的权限，请在使用不可信来源的插件时多加注意！

快速入门

安装框架

本框架仍然处于开发状态，代码迭代速度快，建议使用第二种安装方法。

从代码包导入

go get github.com/Jel1ySpot/GoroBot
在 main.go 中导入包

从仓库导入

Fork 并克隆仓库，在 main.go 文件与 plugins/ 文件夹中编写业务逻辑代码（已添加至 .gitignore）。这样既能够适应框架的快速迭代，还可以更方便向本仓库提交 PR （对，我们鼓励任何人提交修复或功能代码，也欢迎在 github issue 中提出在使用过程中的任何问题与建议）

示范：

#/bin/bash
git clone https://github.com/PathtoYou/rRepo

cd rRpot
mkdir plugins
touch main.go

最小示例

这是一个最小示例：

package main

import (
	GoroBot "github.com/Jel1ySpot/GoroBot/pkg/core"
)

func main() {
	grb := GoroBot.Create()

	if err := grb.Run(); err != nil {
		panic(err)
	}
}

第一次运行上面的代码会报错，提示我们要填写配置文件（conf/config.json）。我们可以按照以下格式填写：

{
  "log_level": 1, // 日志等级。 0:Debug, 1:Info, 2:Warning, 3:Error
  "owner": { // 机器人所有者
    "qq": "你的QQ号" // 格式："平台": "ID"
  }
}

填写完成后再次启动，可以发现报错消失了，但控制台没有输出。这是因为这段代码没有载入任何逻辑代码。在这段代码中，我们创建了一个 GoroBot 实例（为了方便，在文档中会用 grb 代表 GoroBot 实例），并通过 grb.Run() 运行了它。

引入适配器

GoroBot 框架使用适配器支持各种 IM 平台。具体支持列表见 支持平台。适配器也是一种插件。让我们尝试引入一个适配器：

import LgrClient "github.com/Jel1ySpot/GoroBot/pkg/lagrange" // 引入模块

// 在 main 函数中：
grb.Use(LgrClient.Create())

插件使用 Create() 创建一个服务，我们可以使用 grb.Use(*Service) 来使用一个服务。运行这段代码，如无意外还需要填写配置文件，详细请见 pkg/lagrange。配置好服务后再次运行，没有意外的话机器人服务就启动成功了。

使用插件

同样是一个例子：

import "github.com/Jel1ySpot/GoroBot/example_plugin/message_logger" // 引入模块

// 在 main 函数中
grb.Use(message_logger.Create())

再次运行代码，尝试向机器人账号发送消息，如果控制台中出现了刚才发送的消息，代表框架已经搭建成功了！开始编写属于你自己的 IM Chatbot 吧！

事件系统

GoroBot 通过事件系统实现了消息监听等功能。这一设计允许插件开发者和用户编写简洁、通用的代码来扩展和实现各种功能。

以消息事件举例

以下示例代码展示了如何使用事件系统注册和注销一个监听器：

import botc "github.com/Jel1ySpot/GoroBot/pkg/core/bot_context"

var del func()
del, _ = grb.On(GoroBot.MessageEvent(func(ctx botc.MessageContext) error {
	if ctx.String() == "ping" {
		_ = ctx.ReplyText("🏓")
		del()
	}
	return nil
}))

在这段代码中，通过调用 grb.On 方法，注册了一个监听消息事件的监听器。监听器的回调函数接收一个 ctx（消息内容上下文）参数。当接收到的消息内容为 "ping" 时，调用 ctx.ReplyText 方法回复 "🏓"，并通过 del 函数注销该监听器，从而实现了单次响应特定消息的功能。

MessageEvent() 函数接受一个回调函数作为参数，并返回一个 Name 属性为 "message" 的 EventHandler 实例。框架通过将用户提供的回调函数转换为 func(args ...any) error 的通用签名形式，简化了事件注册的流程。这种设计使开发者无需关心底层实现的细节，便可直观地使用框架或插件提供的事件注册器。

中间件

中间件使用 grb.Middleware(MiddlewareCallback) 注册。跟事件一样，这个方法返回一个函数用于注销该中间件。MiddlewareCallbakc 的签名为 func(bot BotContext, msg message.Context, next func(...MiddlewareCallback) error) error，跟消息事件不同的是，中间件的回调函数参数中有一个额外的参数 next，只有调用了它才会进入接下来的流程。

使用中间件实现的 ping

grb.Middleware(func(bot BotContext, msg message.Context, next func(...MiddlewareCallback) error) error {
	if msg.String() == "ping" {
		msg.ReplyText("🏓")
	}
	next()
})