wechat-go
使用前阅读：
-
17年6月下旬前登陆过web网页版的微信可以使用此框架，验证微信是否支持web版本API，请点击https://wx.qq.com/ ，扫码验证即可，假如出现无法登陆，则不适用于此框架
介绍
微信web版API的go实现，模拟微信网页版的登录／联系人／消息收发等功能，可以完全接管微信收到的消息, 并定制自己的发送内容
- 支持多用户(多开)
- 支持掉线后免扫码重登
- 功能以插件的形式提供，可以根据用户(比如付费情况）选择加载或者不加载某插件
- 插件编写简单, 可定制性强, 无需关心API和消息分发，二次开发极为方便
- 对于加载的插件, 使用机器人的终端用户可以通过微信聊天界面动态开启/关闭.
- 目前已提供头像(性别／年龄)识别, gif搜索, 笑话大全, "阅后即焚", 消息跨群转发, 中英互译等多个有趣插件
- 可以发送图片/文字/gif/视频/表情等多种消息
- 支持Linux/MacOSX/Windows, 树莓派也可以:)
获取源码
mkdir -p $GOPATH/src/golang.org/x
cd $GOPATH/src/golang.org/x
git clone https://github.com/golang/net.git
go get -u -v github.com/songtianyi/wechat-go
cd $GOPATH/src/github.com/songtianyi/wechat-go
go get ./...
编译并运行
linux/mac
go build examples/linux/terminal_bot.go
./terminal_bot
windows
windows版本需要在非windows系统使用交叉编译来生成, 生成之后在windows下运行
GOOS=windows GOARCH=amd64 go build examples/windows/windows_bot.go
./windows_bot.exe
扫码图片需要用软件打开，路径在输出日志内.
示例项目
区别
- go-aida是拥有扫码页面的功能性机器人
- wechat-go实现了微信的API, 并提供了易用的消息框架, 但并不是可运行程序
- 只需少量代码即可基于wechat-go创建一个属于自己的个性化机器人，对于更复杂的需求(扫码页面等)可以使用go-aida
- wechat-go专注在API的稳定性/框架的易用性/通用插件这三方面
- go-aida专注在机器人的个性化定制上
示例代码
基于wechat-go创建自定义的机器人
package main
import (
"github.com/songtianyi/rrframework/logs"
"github.com/songtianyi/wechat-go/plugins/wxweb/faceplusplus"
"github.com/songtianyi/wechat-go/plugins/wxweb/gifer"
"github.com/songtianyi/wechat-go/plugins/wxweb/replier"
"github.com/songtianyi/wechat-go/plugins/wxweb/switcher"
"github.com/songtianyi/wechat-go/wxweb"
)
func main() {
// 创建session, 一个session对应一个机器人
// 二维码显示在终端上
session, err := wxweb.CreateSession(nil, nil, wxweb.TERMINAL_MODE)
if err != nil {
logs.Error(err)
return
}
// 注册插件, 所有插件默认是开启的
faceplusplus.Register(session)
replier.Register(session)
switcher.Register(session)
gifer.Register(session)
// 你也可以自己选择关闭插件里的handler(消息处理器)
session.HandlerRegister.DisableByName("faceplusplus")
// 登录并接收消息
if err := session.LoginAndServe(false); err != nil {
logs.Error("session exit, %s", err)
}
}插件列表
switcher
一个管理插件的插件
#关闭某个插件, 在微信聊天窗口输入
disable faceplusplus
#开启某个插件, 在微信聊天窗口输入
enable faceplusplus
#查看所有插件信息, 在微信聊天窗口输入
dump
faceplusplus
对收到的图片做面部识别，返回性别和年龄
gifer
以收到的文字消息为关键字做gif搜索，返回gif图, 注意返回的gif可能尺度较大，比如文字消息中包含“污”等关键词。
replier
对收到的文字/图片消息，做自动应答，回复固定文字消息
laosj
随机获取一张美女图片, 在聊天窗口输入
美女
joker
获取一则笑话, 在聊天窗口输入
笑话
revoker
消息撤回插件, 3s后自动撤回手机端所发的文本消息. 机器人发出的消息需要自己在对应插件里写撤回逻辑.
system
处理消息撤回/红包等系统提示
forwarder
消息跨群转发, 在插件里修改群名的全拼即可.
youdao
中英互译插件, 基于有道翻译API
verify
自动接受好友请求, 可以按条件过滤
share
资源(纸牌屋)自动分发示例
config
配置管理插件 设置配置, 在聊天窗口输入
set config key value
查看配置，在聊天窗口输入
get config key
在代码中使用配置
import "github.com/songtianyi/wechat-go/kv"
func demo() {
kv.KVStorageInstance.Set("key", "value")
v := kv.KVStorageInstance.Get("key")
if v == nil {
return
}
// v.(string) etc.
}制作自己的插件
自定义插件的两个原则
- 一个插件只完成一个功能，不在一个插件里加入多个handler
- 插件默认开启
插件示例
package demo // 以插件名命令包名
import (
"github.com/songtianyi/rrframework/logs" // 导入日志包
"github.com/songtianyi/wechat-go/wxweb" // 导入协议包
)
// 必须有的插件注册函数
// 指定session, 可以对不同用户注册不同插件
func Register(session *wxweb.Session) {
// 将插件注册到session
// 第一个参数: 指定消息类型, 所有该类型的消息都会被转发到此插件
// 第二个参数: 指定消息处理函数, 消息会进入此函数
// 第三个参数: 自定义插件名，不能重名，switcher插件会用到此名称
session.HandlerRegister.Add(wxweb.MSG_TEXT, wxweb.Handler(demo), "textdemo")
// 开启插件
if err := session.HandlerRegister.EnableByName("textdemo"); err != nil {
logs.Error(err)
}
}
// 消息处理函数
func demo(session *wxweb.Session, msg *wxweb.ReceivedMessage) {
// 可选: 可以用contact manager来过滤, 比如过滤掉没有保存到通讯录的群
// 注意，contact manager只存储了已保存到通讯录的群组
contact := session.Cm.GetContactByUserName(msg.FromUserName)
if contact == nil {
logs.Error("ignore the messages from", msg.FromUserName)
return
}
// 可选: 根据消息类型来过滤
if msg.MsgType == wxweb.MSG_IMG {
return
}
// 可选: 根据wxweb.User数据结构中的数据来过滤
if contact.PYQuanPin != "songtianyi" {
// 比如根据用户昵称的拼音全拼来过滤
return
}
// 可选: 过滤和自己无关的群组消息
if msg.IsGroup && msg.Who != session.Bot.UserName {
return
}
// 取出收到的内容
// 取text
logs.Info(msg.Content)
//// 取img
//if b, err := session.GetImg(msg.MsgId); err == nil {
// logs.Debug(string(b))
//}
// anything
// 回复消息
// 第一个参数: 回复的内容
// 第二个参数: 机器人ID
// 第三个参数: 联系人/群组/特殊账号ID
session.SendText("plugin demo", session.Bot.UserName, wxweb.RealTargetUserName(session, msg))
// 回复图片和gif 参见wxweb/session.go
}