README
¶
Rboot
rboot 是一个使用 golang 写的，简单、高效的聊天机器人框架，易于扩展，它可以工作在不同的聊天服务上，并通过扩展脚本可实现 聊天、工作助手、服务监控、警报触发 等功能。
golang版本需求
golang v1.13+
快速创建自己的机器人
$ go get github.com/ghaoo/rboot
$ cd $GOPATH/github.com/ghaoo/rboot/robot
$ go build
$ ./robot
关于消息转接器
消息转接器是用来监听消息的传入和传出，通过消息转接器可以将聊天客户端的消息发送到机器人，经过脚本处理后返回消息发送给客户端。
rboot 提供了 命令行cli 微信网页版 企业微信 钉钉 倍洽 聊天转接器的简单实现。
关于插件
Plugin 并没有提供太多开箱即用的插件，除了一个help插件，其他的需要开发者根据自己的需求去开发。
help插件用法：
!help <plugin>：查看插件帮助信息，当命令不带插件名称时会列出所有插件帮助信息，带插件名称只列出此插件的帮助信息。
使用golang编写插件
在文件夹
robot/plugins下有简单的插件案例，开发者可查看插件编写方法。
使用其他语言编写插件
Plugin 不仅可以使用golang编写插件，也可以使用脚本插件来执行系统命令或使用脚本语言编写的插件文件。
脚本插件是用来解析脚本语言的Plugin插件，它是rboot插件的一个扩展。通过yaml配置文件来执行系统命令或脚本。
因为脚本插件是建立在
Plugin基础之上的，每个脚本都会被注册到Plugin之中，所以确保插件之间名称不要重叠，否则可能先注册的插件会被后注册的插件替换！
如何编写脚本插件
PLUGIN_DIR：脚本插件配置文件存放的文件夹，若不配置默认为scripts
我们可以通过创建一个yaml文件来创建一个脚本插件，通过文件中的配置选项来实现对脚本插件的配置。比如我们创建一个 hello.yml 文件，它的内容如下：
name: hello
version: 0.1.0
ruleset:
hello: "^hello"
usage:
hi: echo hello world and 你好
description: 脚本插件示例
command:
-
cmd:
- echo hi
- echo hello world
-
dir: plugins
cmd:
- echo 你好
这个插件使用的是系统命令 echo。它的意思是：当我们输入“hello”后，脚本会返回 hi，hello world 和 你好 三条信息。
配置中各个字段的含义：
| 配置 | 必须 | 意义 |
|---|---|---|
| name | 是 | 插件名称 |
| ruleset | 是 | 规则集合 |
| version | 否 | 插件版本 |
| usage | 否 | 插件用法 |
| description | 否 | 插件简介 |
| command | 是 | 插件命令集 |
| --- | --- | --- |
| dir | 否 | 命令执行文件夹 |
| cmd | 是 | 插件命令 |
command可配置多个命令集，执行顺序为从上到下依次执行
cmd可配置多条命令，执行顺序为从上到下依次执行
脚本插件支持系统命令和脚本语言。系统命令模式如上面的hello.yml，只需在文件中填写文件夹和系统命令，当你发出命令后，机器人就会从上到下依次执行。
脚本语言是建立在系统命令模式之上的执行方式，我们可以使用系统命令调用语言脚本，从而执行比较复杂的脚本。比如我们使用python输出“hello robot”。
我们的python脚本如下：
#!/usr/bin/env python
print("Hello, robot! i am a python script")
我们的配置文件如下：
name: pyscript
version: 0.1.0
ruleset:
py: "^hello python"
usage:
py: execute python script
description: python插件示例
command:
dir: script
cmd:
- ./hello.py
当我们输入 hello python 时，机器人会调用 hello.py 脚本，脚本输出"Hello, robot! i am a python script"并通过机器人展示给我们。
在不同操作系统下请确认
目录分隔符是否符合当前系统设置。windows下请使用\unix下请使用/
文档
版权
Documentation
¶
Index ¶
- Constants
- Variables
- func DetectAdapter(name string) (adapterF, error)
- func DetectBrain(name string) (func() Brain, error)
- func GetMsgChannel(from, to string) string
- func LoadEnv(filenames ...string) (err error)
- func NewTicker(d time.Duration, name string, f func()) *ticker
- func NewTimer(d time.Duration, name string, f func()) *timer
- func RegisterAdapter(name string, adp adapterF)
- func RegisterBrain(name string, m func() Brain)
- func RegisterPlugin(name string, plugin Plugin)
- func StrToDuration(t int, arc string) (time.Duration, error)
- type Adapter
- type Brain
- type Dispatcher
- type Header
- type Hook
- type Hooks
- type Job
- type Message
- type Plugin
- type PluginFunc
- type Regex
- type Robot
- func (bot *Robot) AddHook(hook Hook)
- func (bot *Robot) Find(bucket, key string) ([]byte, error)
- func (bot *Robot) Go()
- func (bot *Robot) Incoming() chan *Message
- func (bot *Robot) Outgoing(msg *Message)
- func (bot *Robot) Remove(bucket, key string) error
- func (bot *Robot) SendText(text string, to string)
- func (bot *Robot) SetBrain(brain Brain)
- func (bot *Robot) Stop()
- func (bot *Robot) Store(bucket, key string, value []byte) error
- func (bot *Robot) VerifySign(sign, secret, content, datetime string) error
- type Router
- type Rule
- type Worker
Constants ¶
const ( HOOK_BEFORE_INCOMING int = iota + 1 HOOK_AFTER_OUTGOING )
const DefaultBoltDBFile = `db/rboot.db`
Variables ¶
var AllHookTypes = []int{ HOOK_BEFORE_INCOMING, HOOK_AFTER_OUTGOING, }
var JobQueue chan Job
JobQueue Job 通道
Functions ¶
func GetMsgChannel ¶ added in v1.3.0
GetMsgChannel 获取消息通道
func RegisterAdapter ¶
func RegisterAdapter(name string, adp adapterF)
RegisterAdapter 注册转接器，名称不可重复 转接器需实现 Adapter 接口
func RegisterBrain ¶
RegisterBrain 注册存储器，名称须唯一 需实现Brain接口
func RegisterPlugin ¶ added in v1.2.1
RegisterPlugin 注册插件
Types ¶
type Brain ¶
type Brain interface {
Set(bucket, key string, value []byte) error
Get(bucket, key string) ([]byte, error)
Remove(bucket, key string) error
Close() error
}
Brain 是Rboot缓存器实现的接口
type Dispatcher ¶ added in v1.2.2
type Dispatcher struct {
// 工作池容量
MaxWorkers int
// 向调度程序注册的工作程序通道池
WorkerPool chan chan Job
Quit chan bool
}
Dispatcher 调度器
func NewDispatcher ¶ added in v1.2.2
func NewDispatcher(maxWorkers int) *Dispatcher
NewDispatcher 新建一个调度器
type Header ¶ added in v1.1.2
Header 消息附带的头信息，键-值对
type Message ¶
type Message struct {
Channel string `json:"channel"` // 自定义通道
To string `json:"to"` // 消息接收者
From string `json:"from"` // 消息来源
Sender string `json:"sender"` // 发送者
Header Header `json:"header"` // 头信息
Content string `json:"content"` // 消息文本内容
Time time.Time `json:"time"` // 消息发送时间
KeepHeader bool `json:"-"` // 如果为true则传入消息的Header在一次会话结束之前不会清除
}
Message 表示一个消息的结构
func NewMessage ¶ added in v1.1.2
NewMessage 新建一条消息，支持多个接收人
func NewMessages ¶ added in v1.1.2
NewMessages 新建一组消息
type Plugin ¶ added in v1.2.1
type Plugin struct {
Action PluginFunc // 执行解析或一些必要加载
Ruleset map[string]string // 脚本规则集合
Usage map[string]string // 帮助信息
Description string // 简介
}
Plugin 脚本结构体
type PluginFunc ¶ added in v1.2.1
PluginFunc SetupFunc 脚本执行或解析函数 - bot: A Robot instance - incoming: The incoming message
func DirectivePlugin ¶ added in v1.2.1
func DirectivePlugin(name string) (PluginFunc, error)
DirectivePlugin 根据脚本名称获取插件执行函数
type Robot ¶
type Robot struct {
// 路由，支持脚本自定义添加新路由
Router *Router
// 缓存
Brain Brain
// 钩子
Hooks Hooks
// 缓存文件夹
CachePath string
// 调试信息
Debug bool
// contains filtered or unexported fields
}
Robot 是 rboot 的一个实例，它包含了聊天转接器，规则处理器，缓存器，路由适配器和消息的进出通道
func (*Robot) VerifySign ¶ added in v1.1.3
VerifySign 验证签名
type Router ¶ added in v1.1.2
type Router struct {
// contains filtered or unexported fields
}
Router 包含了路由处理器 mux 和已经注册的所有路由集合，支持中间件
func (*Router) HandleFunc ¶ added in v1.1.2
HandleFunc 为路径 path 注册一个新的路由处理函数
type Worker ¶ added in v1.2.2
type Worker struct {
// WorkerPool 是个指向全局唯一的 chan 的引用,
// 负责传递 Worker 接收 Job 的 chan。
// Worker 空闲时，将自己的 JobChannel 放入 WorkerPool 中。
// Dispatcher 收到新的 Job 时，从 JobChannel 中取出一个 chan， 并将 Job
// 放入其中，此时 Worker 将从 Chan 中接收到 Job，并进行处理
WorkerPool chan chan Job
// Worker 用于接收 Job 的 chan
JobChannel chan Job
// 用于给 Worker 发送控制命令的 chan，用于停止 chan
Quit chan bool
}
Worker 表示执行该Job的worker
Source Files
Directories