go-wechaty

连接聊天机器人

Wechaty 是一个用于微信 个人 账号的 RPA SDK，可以帮助你用 6 行 Go 代码创建一个聊天机器人。

开发者的声音

“Wechaty 是一个很棒的解决方案，我相信会有更多用户认可它。” 链接
— @Gcaufy，腾讯工程师，WePY 的作者

“太好用，好用的想哭”
— @xinbenlv，Google 工程师，HaoShiYou.org 的创始人

“最好的微信开发库” 链接
— @Jarvis，百度工程师

“Wechaty 让运营人员有更多时间思考如何进行活动策划、留存用户以及实现商业变现。” 链接
— @lijiarui，Juzi.BOT 的创始人兼 CEO。

“如果你懂 JavaScript……就试试 Wechaty 吧，它非常容易上手。”
— @Urinx Uri Lee，WeixinBot(Python) 的作者

更多内容请参见 Wiki:开发者之声

加入我们

Wechaty 已被数千名开发者应用于众多聊天机器人项目中。如果你想与其他开发者交流，只需在微信中扫描下方二维码，并输入暗号 go wechaty，加入我们的 Wechaty Go 开发者之家。

立即扫描吧，因为其他 Wechaty Go 开发者也想与你交流呢！（暗号：go wechaty）

使用方法

package main

import (
	"fmt"
	"github.com/wechaty/go-wechaty/wechaty"
	"github.com/wechaty/go-wechaty/wechaty-puppet/schemas"
	"github.com/wechaty/go-wechaty/wechaty/user"
)

func main() {
	wechaty.NewWechaty().
		OnScan(func(context *wechaty.Context, qrCode string, status schemas.ScanStatus, data string) {
			fmt.Printf("扫描二维码登录： %s\nhttps://wechaty.github.io/qrcode/%s\n", status, qrCode)
		}).
		OnLogin(func(context *wechaty.Context, user *user.ContactSelf) {
			fmt.Printf("用户 %s 登录成功\n", user)
		}).
		OnMessage(func(context *wechaty.Context, message *user.Message) {
			fmt.Printf("收到消息：%s\n", message)
		}).DaemonStart()
}

要求

1. Go 1.18+

安装

# 获取 wechaty

go get github.com/wechaty/go-wechaty

开发

make install
make test

常见问题解答

• wechaty-puppet-service：找不到 WECHATY_PUPPET_SERVICE_TOKEN？
  • go-wechaty 是 wechaty（TypeScript）的 Go 语言实现。启动 Wechaty 需要使用 Puppets，但目前已知这些 Puppet 主要是用 TypeScript 编写的。为了让 go-wechaty 能够使用这些 Puppet，我们可以使用 wechaty-gateway 将 Puppet 转换为 gRPC 服务，然后让 go-wechaty 连接到该 gRPC 服务：go-wechaty -> wechaty-gateway -> puppet。文档：https://wechaty.js.org/docs/puppet-services/diy/
  • Puppet 列表：https://wechaty.js.org/docs/puppet-providers/

参考资料

• 12 分钟学会 Go 语言
• 如何编写 Go 代码
• 从面向对象语言到 Golang 的旅程——Sergey Kibish @DevFest Switzerland 2018
• The Go Blog — 发布 Go 模块
• Effective Go

针对 Node.js 开发者的 Golang

• Node.js 开发者入门 Golang — 通过对比 Node.js 示例学习 Golang
• 作为 Node.js 开发者学习 Go 语言
• Node.js 开发者 Golang 教程 — 入门指南

历史

master

v0.4（2020 年 6 月 19 日）

Go Wechaty 和 Scala Wechaty BETA 版本发布！

更多信息请参阅我们博客中的多语言 Wechaty Beta 版本发布活动：

• 多语言 Wechaty Beta 版本发布公告！

v0.1（2020 年 4 月 3 日）

1. 欢迎我们的第二位和第三位 Go Wechaty 贡献者：
   • Bojie LI（李博杰）https://github.com/SilkageNet #9
   • Chaofei DING（丁超飞）https://github.com/dchaofei #20
2. 启用 GitHub Actions
   1. 启用代码风格检查：golint
   2. 启用测试：testing
3. 添加 Makefile 以方便开发
4. 重新组织模块目录：从 src/wechaty 改为 wechaty
5. 将示例机器人重命名为 examples/ding-dong-bot.go

v0.0.1（2020 年 3 月 12 日）

1. 项目创建。
2. 欢迎我们的第一位 Go Wechaty 贡献者：
   • Xiaoyu DING（丁小雨）https://github.com/dingdayu #2

相关项目

• Wechaty — 面向微信个人账号的对话式 AI 聊天机器人 SDK（TypeScript）
• Python Wechaty — 面向微信个人账号的 Python 对话式 AI 聊天机器人 SDK（Python）
• Go Wechaty — 面向微信个人账号的 Go 对话式 AI 聊天机器人 SDK（Go）
• Java Wechaty — 面向微信个人账号的 Java 对话式 AI 聊天机器人 SDK（Java）
• Scala Wechaty — 面向微信个人账号的 Scala 对话式 AI 聊天机器人 SDK（Scala）

徽章

[![Wechaty 的 Go 实现](https://img.shields.io/badge/Wechaty-Go-7de)](https://github.com/wechaty/go-wechaty)

贡献者

1. @SilkageNet - Bojie LI (李博杰)
2. @huan - Huan LI (李卓桓)

创建者

• @dchaofei - Chaofei DING (丁超飞)
• @dingdayu - Xiaoyu DING (丁小雨)

版权与许可

• 代码及文档 © 2020 Wechaty 贡献者 https://github.com/wechaty
• 代码采用 Apache-2.0 许可证发布
• 文档采用知识共享许可协议发布

感谢

go-wechaty 快速上手指南

go-wechaty 是一个基于 Go 语言的微信机器人 SDK，仅需几行代码即可为微信个人号创建聊天机器人。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：支持 Linux, macOS 或 Windows。
• Go 语言版本：必须安装 Go 1.18 或更高版本。
  • 国内开发者可使用清华源或阿里云镜像加速安装：https://golang.google.cn/dl/
• 依赖服务：go-wechaty 本身不包含底层协议实现，需要配合 Puppet Service 使用（通常通过 WECHATY_PUPPET_SERVICE_TOKEN 环境变量配置）。

安装步骤

在项目目录下初始化 Go 模块并安装 go-wechaty：

go get github.com/wechaty/go-wechaty

提示：如果下载速度较慢，建议配置国内 GOPROXY 镜像：

export GOPROXY=https://goproxy.cn,direct

基本使用

创建一个名为 main.go 的文件，填入以下代码。这是最基础的机器人示例，实现了扫码登录监听和消息接收功能。

package main

import (
	"fmt"
	"github.com/wechaty/go-wechaty/wechaty"
	"github.com/wechaty/go-wechaty/wechaty-puppet/schemas"
	"github.com/wechaty/go-wechaty/wechaty/user"
)

func main() {
	wechaty.NewWechaty().
		OnScan(func(context *wechaty.Context, qrCode string, status schemas.ScanStatus, data string) {
			fmt.Printf("Scan QR Code to login: %s\nhttps://wechaty.github.io/qrcode/%s\n", status, qrCode)
		}).
		OnLogin(func(context *wechaty.Context, user *user.ContactSelf) {
			fmt.Printf("User %s logined\n", user)
		}).
		OnMessage(func(context *wechaty.Context, message *user.Message) {
			fmt.Printf("Message: %s\n", message)
		}).DaemonStart()
}

运行机器人：

在终端中设置 Token 并运行程序（请将 <YOUR_TOKEN> 替换为您实际获取的 Puppet Service Token）：

export WECHATY_PUPPET_SERVICE_TOKEN=<YOUR_TOKEN>
go run main.go

运行后，控制台将输出二维码链接，使用微信扫描即可登录并开始接收消息。