wechat go

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

區別

• 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

}