yqchilde/wxbot：☝🏻 一个好玩的个人微信机器人程序(DaenDLL、VLW

技术解读

以下内容由 GitRead 中文社区编辑团队基于项目 README 与官方资料整理，结合中文开发者的常见使用场景补充技术选型建议。具体以项目官方文档为准。

技术分析：yqchilde/wxbot 项目深度探索

项目背景与痛点

在日常交流中，微信群聊、公众号信息推送等场景已经成为微信的主要应用场景之一。但频繁的消息通知、需要手动操作的任务执行等，都会给用户带来不便。为了解决这个问题，yqchilde/wxbot 项目提出了一个基于微信机器人，集成了机器人聊天、公众号消息转发、定时任务执行等功能的新颖解决方案。

核心技术揭秘

yqchilde/wxbot 项目的实现思路主要依赖于对微信 Web 版本的协议抓包与逆向。通过 DaenDLL 和 VLW 两个工具，插件式地支持微信自动化业务处理。项目使用 Python 实现，整个架构设计合理、扩展性强。

技术架构分析

以下是项目的一个简要技术架构图，展示数据流和核心模块之间的关系：

graph TD A[用户指令] --> B{"指令解析"} B -->|"聊天类型"| C[机器人回复] B -->|"公众号消息"| D[消息分发] B -->|"定时任务"| E[任务执行] B -->|"系统操作"| F[状态同步] C --> G[返回用户] D --> H[转发公众号] E --> I[调度任务] F --> J[更新状态]

指令解析模块
- 接收用户的指令，解析出指令类型。
机器人回复模块
- 聊天类型指令交给机器人回复系统，负责接收到指令后返回对话内容。
消息分发模块
- 公众号消息转发模块负责收集目标公众号的推送信息，并转发给用户。
任务执行模块
- 定时任务模块用于执行自定义的定时任务，可以触发各种操作或通知。
状态同步模块
- 若为系统操作指令，系统将同步状态信息，如登录状态、任务状态等。

技术栈与设计思想

技术栈：项目构建在 Python 上，使用了诸如 DaenDLL、VLW 等库，容器化部署建议采用 Docker。
设计思想：使程序尽可能的模块化与扩展化，这是 yqchilde/wxbot 项目成功的关键之一。通过插件化的架构，使用者可以根据自己的需求增减功能模块。

功能亮点与差异

与其他固化的微信机器人相比，yqchilde/wxbot 在插件式开发模式、多元的基础功能功能性等方面具备显著优势。

灵活性：灵活的插件式架构，允许用户自由扩展功能。
多种功能性：天气查询、公众号信息自动化托管、定时任务执行等特色功能。
兼容性：支持公众号爬虫信息反馈、自动化聊天服务等应用场景，满足不同需求的用户。

应用场景与落地建议

任务自动化：适用于企业内部的事件通知、自动回复模板等。
客服机器人：可以作为客服侧的辅助工具，处理客户常见问题，提升效率。

在生产部署时，需注意以下几点：

数据的处理应当遵循相关法规，确保用户数据安全。
定期更新源代码防止信息泄露。
避免在需要高强度计算的场景中使用，可能会导致 CPU 占用率过高。

综合评价

总之，yqchilde/wxbot 提供了一种轻量级的解决方案，降低了微信机器人开发者的成本，但同时也存在扩展不足与信息安全性问题需要关注。对于需要微信自动化的开发者而言，该项目是一个不错的选择。在未来，项目团队可以进一步优化，并拓展更多的集成能力以满足更多使用需求。

What’s this?

一个还算有意思的wechat robot项目，理想将其设计成一个多功能的机器人助手 😈

🤨框架可无侵入扩展，现已接入千寻框架和vlw框架，请参考framework目录
🤨功能可无侵入扩展，现已集成plugins目录下的功能，请参考plugins目录

🔔 注意：

使用本项目之前需要您已经配置好相关的 微信的hook 类软件，那么只需要在这类软件上设置回调地址即可
本项目已接入vlw、千寻两个框架，如果您有其他框架，可自行添加(参考framework目录，实现IFramework接口即可)，或联系我添加
本项目不提供任何hook类软件，您需要利用搜索引擎自行寻找
本项目暂时只支持HTTP协议，关于websocket协议支持目前不考虑
简而言之，本项目是一个消息处理的中间件，微信消息监听获取是从框架获取
本项目仅供学习交流使用，不得用于商业用途，否则后果自负
使用本项目造成封禁账号等后果（项目立项到现在，作者还没出现过异常），本项目不承担任何责任，实际上您使用任何非官方的微信机器人都有可能造成账号封禁，所以请谨慎使用
如果您阅读了上面的内容，觉得没有问题，那么请继续阅读下面的内容

功能示例：

已对接框架

🎁 已接入框架，展开看👇

千寻框架 | 👉对接说明文档👀
- 具体配置查看 config.yaml 文件注释说明
VLW框架
- 具体配置查看 config.yaml 文件注释说明

已对接API

🎁 已对接API，展开看👇

// IFramework 这是接入框架所定义的接口
type IFramework interface {
	// Callback 这是消息回调方法，vx框架回调消息转发给该Server
	Callback(func(*Event, IFramework))

	// GetMemePictures 获取表情包图片地址(迷因图)
	// return: 图片链接(网络URL或图片base64)
	GetMemePictures(message *Message) string

	// SendText 发送文本消息
	// toWxId: 好友ID/群ID
	// text: 文本内容
	SendText(toWxId, text string) error

	// SendTextAndAt 发送文本消息并@，只有群聊有效
	// toGroupWxId: 群ID
	// toWxId: 好友ID/群ID/all
	// toWxName: 好友昵称/群昵称，留空为自动获取
	// text: 文本内容
	SendTextAndAt(toGroupWxId, toWxId, toWxName, text string) error

	// SendImage 发送图片消息
	// toWxId: 好友ID/群ID
	// path: 图片路径
	SendImage(toWxId, path string) error

	// SendShareLink 发送分享链接消息
	// toWxId: 好友ID/群ID
	// title: 标题
	// desc: 描述
	// imageUrl: 图片链接
	// jumpUrl: 跳转链接
	SendShareLink(toWxId, title, desc, imageUrl, jumpUrl string) error

	// SendFile 发送文件消息
	// toWxId: 好友ID/群ID/公众号ID
	// path: 本地文件绝对路径
	SendFile(toWxId, path string) error

	// SendVideo 发送视频消息
	// toWxId: 好友ID/群ID/公众号ID
	// path: 本地视频文件绝对路径
	SendVideo(toWxId, path string) error

	// SendEmoji 发送表情消息
	// toWxId: 好友ID/群ID/公众号ID
	// path: 本地动态表情文件绝对路径
	SendEmoji(toWxId, path string) error

	// SendMusic 发送音乐消息
	// toWxId: 好友ID/群ID/公众号ID
	// name: 音乐名称
	// author: 音乐作者
	// app: 音乐来源(VLW需留空)，酷狗/wx79f2c4418704b4f8，网易云/wx8dd6ecd81906fd84，QQ音乐/wx5aa333606550dfd5
	// jumpUrl: 音乐跳转链接
	// musicUrl: 网络歌曲直链
	// coverUrl: 封面图片链接
	SendMusic(toWxId, name, author, app, jumpUrl, musicUrl, coverUrl string) error

	// SendMiniProgram 发送小程序消息
	// toWxId: 好友ID/群ID/公众号ID
	// ghId: 小程序ID
	// title: 标题
	// content: 内容
	// imagePath: 图片路径, 本地图片路径或网络图片URL
	// jumpPath: 小程序点击跳转地址，例如：pages/index/index.html
	SendMiniProgram(toWxId, ghId, title, content, imagePath, jumpPath string) error

	// SendMessageRecord 发送消息记录
	// toWxId: 好友ID/群ID/公众号ID
	// title: 仅供电脑上显示用，手机上的话微信会根据[显示昵称]来自动生成 谁和谁的聊天记录
	// dataList:
	// 	- wxid: 发送此条消息的人的wxid
	// 	- nickName: 显示的昵称(可随意伪造)
	// 	- timestamp: 10位时间戳
	// 	- msg: 消息内容
	SendMessageRecord(toWxId, title string, dataList []map[string]interface{}) error

	// SendMessageRecordXML 发送消息记录(XML方式)
	// toWxId: 好友ID/群ID/公众号ID
	// xmlStr: 消息记录XML代码
	SendMessageRecordXML(toWxId, xmlStr string) error

	// SendFavorites 发送收藏消息
	// toWxId: 好友ID/群ID/公众号ID
	// favoritesId: 收藏夹ID
	SendFavorites(toWxId, favoritesId string) error

	// SendXML 发送XML消息
	// toWxId: 好友ID/群ID/公众号ID
	// xmlStr: XML代码
	SendXML(toWxId, xmlStr string) error

	// SendBusinessCard 发送名片消息
	// toWxId: 好友ID/群ID/公众号ID
	// targetWxId: 目标用户ID
	SendBusinessCard(toWxId, targetWxId string) error

	// AgreeFriendVerify 同意好友验证
	// v3: 验证V3
	// v4: 验证V4
	// scene: 验证场景
	AgreeFriendVerify(v3, v4, scene string) error

	// InviteIntoGroup 邀请好友加入群组
	// groupWxId: 群ID
	// wxId: 好友ID
	// typ: 邀请类型，1-直接拉，2-发送邀请链接
	InviteIntoGroup(groupWxId, wxId string, typ int) error

	// GetObjectInfo 获取对象信息
	// wxId: 好友ID/群ID/公众号ID
	// return: User, error
	GetObjectInfo(wxId string) (*User, error)

	// GetFriends 获取好友列表
	// isRefresh: 是否刷新 false-从缓存中获取，true-重新遍历二叉树并刷新缓存
	// return: []*User, error
	GetFriends(isRefresh bool) ([]*User, error)

	// GetGroups 获取群组列表
	// isRefresh: 是否刷新 false-从缓存中获取，true-重新遍历二叉树并刷新缓存
	// return: []*User, error
	GetGroups(isRefresh bool) ([]*User, error)

	// GetGroupMembers 获取群成员列表
	// groupWxId: 群ID
	// isRefresh: 是否刷新 false-从缓存中获取，true-重新遍历二叉树并刷新缓存
	// return: []*User, error
	GetGroupMembers(groupWxId string, isRefresh bool) ([]*User, error)

	// GetMPs 获取公众号订阅列表
	// isRefresh: 是否刷新 false-从缓存中获取，true-重新遍历二叉树并刷新缓存
	// return: []*User, error
	GetMPs(isRefresh bool) ([]*User, error)
}

已有插件

🎁 已有插件 👇

指令大全

点击查看机器人有哪些指令

How to use?

本地运行

克隆代码

git clone --recurse-submodules https://github.com/yqchilde/wxbot.git

配置config.yaml
调试运行或编译
- 调试运行执行 go run main.go
- 编译执行 make release

Releases包

去Releases下载对应系统的编译包，解压后执行二进制文件即可

Docker运行

方式一：一键脚本启动

bash -c "$(curl -fsSL https://raw.fastgit.org/yqchilde/wxbot/hook/docker/run.sh)"

方式二：命令启动，注意提前配置config.yaml,否则会报错

docker run -d \
  --name="wxbot" \
  -p 9528:9528 \
  -v $(pwd)/config.yaml:/app/config.yaml \
  -v $(pwd)/data:/app/data \
  yqchilde/wxbot:latest

Actions编译

先fork本项目
在 https://github.com/settings/tokens 这里获取一个token用于给actions使用
给项目添加一个秘钥，名字为WXBOT_TOKEN，值为上面获取的token
自行创建一个tag，如v1.0.0，然后等待actions编译完成，编译完成后会在release中生成对应的wxbot文件

How to develop?

制作插件或接入其他框架

🤔如果您想要扩展自己的插件，可以参考plugins目录下的插件

🤔如果您想要扩展其他框架，可以参考frameworks目录下的框架

🤔如果您需要增减插件，可编辑 plugins.yaml 中代码中去掉对应插件的导入或者添加对应插件的导入，照猫画虎即可

🔴修改完plugins.yaml后需要执行一次make plugins或go generate -tags plugins ./engine/plugins生成对应的plugins.go文件再去编译

- "github.com/yqchilde/wxbot/plugins/baidubaike"   # 百度百科
- "github.com/yqchilde/wxbot/plugins/chatgpt"      # GPT聊天
- "github.com/yqchilde/wxbot/plugins/crazykfc"     # 肯德基疯狂星期四骚话
- "github.com/yqchilde/wxbot/plugins/ghmonitor"    # 公众号消息监控转发
- "github.com/yqchilde/wxbot/plugins/manager"      # 群组管理相关
- "github.com/yqchilde/wxbot/plugins/memepicture"  # 表情包原图
- "github.com/yqchilde/wxbot/plugins/moyuban"      # 摸鱼办
- "github.com/yqchilde/wxbot/plugins/pinyinsuoxie" # 拼音缩写翻译
- "github.com/yqchilde/wxbot/plugins/plmm"         # 漂亮妹妹
- "github.com/yqchilde/wxbot/plugins/weather"      # 天气查询
- "github.com/yqchilde/wxbot/plugins/zaobao"       # 每日早报
- "github.com/yqchilde/wxbot/plugins/wordcloud"    # 聊天热词
- "github.com/yqchilde/wxbot/plugins/chaid"        # 查wxId
- "github.com/yqchilde/wxbot/plugins/youdaofanyi"  # 有道翻译
- "github.com/yqchilde/wxbot/plugins/coser"        # coser

参考案例

查看更多使用案例

调试-环境变量

环境变量名	变量类型	说明
DEBUG	bool	优先级大于其他`DEBUG_`开头的变量，开启后开启所有DEBUG模式用于调试HTTP请求和调用日志文件名和行号
DEBUG_LOG	bool	用于调试调用日志文件名和行号

提交Pr注意项

import包时顺序要规范，先import标准库，再import第三方库，最后import自己的库，例如：

import (
	"errors"
	"fmt"
	"strings"
	"sync"
	"time"

	"github.com/PullRequestInc/go-gpt3"

	"github.com/yqchilde/wxbot/engine/control"
	"github.com/yqchilde/wxbot/engine/pkg/log"
	"github.com/yqchilde/wxbot/engine/pkg/sqlite"
	"github.com/yqchilde/wxbot/engine/robot"
)

若提交的是插件，请在plugins.yaml中添加对应的插件
若提交的是插件，请在README.md中已有插件部分添加对应的插件
若提交的是插件，请在plugins/README.md中添加对应的插件
提交代码请先make plugins 或 go generate -tags plugins ./engine/plugins 生成对应的plugins.go文件

Feature

开发计划：🕒 开发计划
如果您感觉这个项目有意思，麻烦帮我点一下star
这个项目待(不)补(完)充(善)很多东西，由于工作关系会抽出时间弄，感谢您发现并使用此仓库

如果您有疑惑可以加Q群讨论

Thanks

JetBrains 开源证书支持

yqchilde/wxbot 项目一直以来都是在 JetBrains 公司旗下的 GoLand 集成开发环境中进行开发，基于 free JetBrains Open Source license(s) 正版免费授权，在此表达我的谢意。

开源项目

非Hook版机器人核心由 openwechat SDK实现，在nohook分支，已暂停维护
Hook版机器人框架我使用的是 ~~《我的框架》已跑路~~，现在用的是千寻，为hook分支
hook分支大量借鉴了一个十分优秀的项目ZeroBot-Plugin的设计方案 👍🏻，其中很多基础代码来自ZeroBot-Plugin，在此基础上扩展了支持wechat的方式，非常感谢，Thanks♪(･ω･)ﾉ

Support

ChatGPT账号购买，有需要的朋友可以看看

License

AGPL-3.0 license. See the LICENSE file for details.

wxbot

技术解读

技术分析：yqchilde/wxbot 项目深度探索

项目背景与痛点

核心技术揭秘

技术架构分析

技术栈与设计思想

功能亮点与差异

应用场景与落地建议

综合评价

关于

简要分析

语言占比

Release

贡献者

WxBot

What’s this?

已对接框架

已对接API

已有插件

指令大全

How to use?

本地运行

Releases包

Docker运行

Actions编译

How to develop?

制作插件或接入其他框架

参考案例

调试-环境变量

提交Pr注意项

Feature

Thanks

JetBrains 开源证书支持

开源项目

Support

License

评论

wxbot

技术解读

技术分析：yqchilde/wxbot 项目深度探索

项目背景与痛点

核心技术揭秘

技术架构分析

技术栈与设计思想

功能亮点与差异

应用场景与落地建议

综合评价

相关仓库

关于

简要分析

语言占比

Release

贡献者

WxBot

What’s this?

已对接框架

已对接API

已有插件

指令大全

How to use?

本地运行

Releases包

Docker运行

Actions编译

How to develop?

制作插件或接入其他框架

参考案例

调试-环境变量

提交Pr注意项

Feature

Thanks

JetBrains 开源证书支持

开源项目

Support

License

评论