前言
最近在dy上看到有相关wx机器人（SCRM）在进行相关推广，而之前学习的时候，用基于python开发的itchat玩过一段时间，后来，某一天突然发现微信登不上了，官方的微信网页版也不能登陆了（至于是啥原因，咱也不知道，也不敢去研究）。
最近又在捣鼓捣鼓这个小助手，遂捡起了之前看过的wechaty。对！！！就是他！！！他来了~~
老规矩，先撩姐（🎨🎨）
简介：
- 官方（git）
- 语言：node(Typescript )，python，java（项目多是支持node，一些是开源了python和java；看issues说是node项目支持的更完美~~咱也没细究）
- 协议：iPad、Mac、WinPc、Web等等（支持的协议挺多的，当然，web协议的README里会声明，登录不了web版微信的号不能正常使用）
- 使用：这里有个东东要提前声明下：token，wechaty的服务都依赖于token，有个合法的token才能正常使用wechaty的服务；后面会细说
- 免费：参与开源激励计划→传送门(点它)
- 收费：官方发布是200￥/号/月，具体→传送门(点它)
- 说明：官方声明，一个token原则上只能同时在线一个微信号，这里的意思就有意味了。这个token不会绑定你的微信号，但是呢，只能同时在线一个微信，你要是想做n个微信的私域，那就需要n个token
学习：
- 我这里的项目是基于wechaty-puppet-hostie
- 官方API文档（很重要！！！一定要先看文档再下手，如果要基于这个开发，一定要把它当作手册）
- 官方参考示例（至于我为什么基于这个示例，因为官方给的我15天免费token是donut版，基于windows协议）
- 语言：主要是nodejs，基于express框架→传送门（点它）
- 技术栈：express框架（前端ejs），socket io
- 名词解释
- token：官方解释
-
Our Mission: Make it easy to build a WeChat Chatbot for developers.
We provide a free access using iPad protocol for the developers who have a strong will and ability to build a valuable chatbot for users.
Any developers can add JuziBOT Inc’s staff ( Wechat number : juzibot) as a Wechat friend. You will receive a review form after adding. If you pass the review and willing to write a blog in Wechaty , you can use our iPad protocol for free！
我们的使命：轻松为开发人员构建微信聊天机器人
我们为有强烈意愿和能力为用户构建有价值的聊天机器人的开发人员提供了使用iPad协议的免费访问权限
任何开发人员都可以将JuziBOT Inc的工作人员（微信编号：juzibot）添加为微信好友。添加后，您将收到一份审查表。如果您通过审查并愿意在Wechaty中写博客，则可以免费使用我们的iPad协议！
-
意思是我们提交审查表后，会获得为期15天的免费Token；想要获取长期有效的免费token，那就参加所谓的开源激励计划，就是在15天后，需要提交一个MVP(最小可行化产品)的Github仓库，Wechaty会将其fork到社区中的同时，会提供一个长期免费Token
-
- wechaty-puppet-padplus：基于ipad协议的微信机器人
- wechaty-puppet-hostie：基于windows协议的机器人
- token：官方解释
初步需求：
- 关键字自动通过好友验证
- 当有人添加机器人时，判断验证消息关键字后通过或直接通过
- 通过验证后自动回复并介绍机器人功能
- 私聊关键字回复
- 例如回复 推送群聊邀请
- 例如回复 推送作者微信名片
- 例如回复 白名单 邀请入群
- 自动聊天
- 对接AI机器人，这里科普推荐免费机器人api和免费天气查询api，回复 芜湖天气
- 群聊中通过 可以和机器人聊天
- 私聊发送消息即可聊天
- 向机器人询问天气
- 加入群聊自动欢迎
- 当新的小伙伴加入群聊后自动 发一个文字欢迎
- web聊天
- 前台获取好友列表
- 通过socket实时向前台推送还有消息
- 实现前台向好友发送消息
项目结构：
新建文件夹wechaty-lite，进入目录执行cnpm init -y (大家都知道国内直接使用 npm 的官方镜像是非常慢的，这里推荐使用淘宝 NPM 镜像。)
安装核心包
配置文件config.js
启动文件www
在Create HTTP server.后引入socketio和wechaty，进行启动
- 引入socketio，调用封装的getSocketio()进行初始化启动；
- 引入donut，调用封装的run()进行初始化启动；
socket服务 socketio.js文件
该示例主要介绍了socket发送机制，如发送给自己，发送给初自己外的其他用户（广播），推送给所有人；（还可以推送给某一个socket连接用户，通过id，这里不介绍了）
- 监听客户端的消息；
- 监听客户端的微信消息并发送给相关好友；
- 封装接口sendWechatLoginMsg、sendWechatMsg给wechaty调用；
donut服务 donut.js文件
该示例主要介绍了引用wechaty包，实现wechaty初始化、加入群聊、退出群聊、消息等监听和多种发送消息函数封装
- bot初始化；
- 实现bot监听（OnMessage、OnRoomJoin...）；
- 消息发送（文本、媒体、链接等消息）；
Wechaty监听
这边重点描述下wechaty的监听示例，这也是为什么单独把几个监听业务给抽出来到wechaty目录下的原因之一。
- scan //扫码登录监听
- login //登录成功监听
- room-join //加入群聊监听
- room-leave //退出群聊监听
- message //消息通知监听
- friendship //好友添加监听
初始化
发送文本消息给好友
这里传入两个参数
- friendName //好友昵称，这里可以调用对象Contact的find({name: friendName})函数进行好友查询
- text //发送的文本内容
其他的发送方式在代码里，这里直接看代码，不一一解释（代码详细注释，建议参考官方文档）
监听配置启动
scan（顾名思义，是用于扫码登录的一个监听）
这里代码较简单，意思是前面通过
引用qrcode-terminal模块，用于在终端进行二维码输出，方便我们测试扫码；
我们借助这个API将 qr 码输出到终端而已，后面那个参数是因为 这个包默认输出的二维码很大，给它变小一些；
这边有一个坑，在webstorm上打码的时候，在终端输出的二维码是这样的，
这时候我们需要把这些字符串复制到码农神器notepad++里，如下图
然后进行扫码登录；
这个问题我在centos下测试是没有这个问题，生产上大家不用担心。
onFriendShip
用于好友监听的监听，这块逻辑比较简单（参看别人代码，直接撸过来的，哈哈哈，在此感谢这位朋友）；
监听好友添加的请求通知，如果打招呼信息hello()内容符合关键词列表，则进行允予通过accept();
这里我看了官方文档，可实现的业务很多，大家可参考官方api进行更多业务拓展！！！
onRoomJoin
这里主要监听用户加入房间的回调
这里我们说明下，如果是在配置白名单roomJoinReply里的群，只要有新人加入，我们就发一个欢迎词并@他下
这些内容我们现在放在config中，实际业务肯定是放在db中，业务启动去获取或实时监听；
此回调接收三个参数
- room 群聊实例
- inviteeList 受邀者名单
- inviter 邀请者
有了房间，受邀者，邀请者，这里可实现的业务就多了~~此处啪啦啪啦省略800字...
做一下判断就可以了，这里的就是我们配置的管理群组列表对象roomJoinReply的value值
为什么要有管理群组列表对象呢？因为我们在登录了一个微信号时，群组进入监听是针对微信号中所有群组的
我的需求是要管理我的群组，所以事先跑了下程序，输出了，然后群里发个消息，就拿到了我想管理的群组所有信息，id自然也在里面，然后写到了配置里，这里输出一个room的聊天信息示例，这里面的roomId就是房号
接下来就是，监听到新加入，把受邀者列表遍历一下，使用方法发送群消息即可，受邀者列表里存的就是加入的微信号实例， 方法第一个参数就是要发送的消息，第二个参数就是为了@此人一下。。。其他业务开发请参考官方文档（再来一个传送门）
onRoomLeave
监听用户退出群聊
这里的业务更简单了，主要是监听用户推出群聊
此回调接收三个参数
- room 群聊实例
- leaver 退出群聊者
onMessage
主要监听消息的接收
这里有个代码块
参考别人的代码，这个协议版本这里获取出来的的是null，所以直接改成替换成自己的name（config中配置），可能是协议或版本不一样，api做了调整；这里我没细查官方api，欢迎补充。
加入群聊监听 这里有个业务点简单描述下，根据用户私聊的的内容，判断是否触发关键词，如果触发直接发送可加的群信息；
回复群名进行群邀请
AI机器人
说到微信机器人，肯定不能脱离AI只能回复；这里的业务用到了自动陪聊和天气查询的功能，分别用到了如下api，相关参数配置在config文件，大家自行申请api 参数进行修改
- 免费机器人
- 接口文档：http://www.itpk.cn/
- 这里自行注册，还可以配置自定义回复，无答案回复，自行训练等等
- 免费天气
- 接口文档：http://www.tianqiapi.com/
- 这里官方文档竟然给了个公开能用的appid和appsecret...额。。。大家自行参考文档
这里没什么可细说，主要是调用第三方封装的api，进行一些关键词的自动答复；
涉及到api的http请求，所以需要引入如下两个模块
这里小小吐槽下图灵，n年体验过图灵，这回本来想申请图灵的api测试，结果关注官方公众号等渠道体验。。。好吧，竟然没有机器人只能答复，遂找了家免费的AI机器人，希望大家别吐槽不智能~~~哈哈，毕竟itpk也需要慢慢进步嘛
这里有个槽点，调用机器人api，设置返回的数据是json，但是返回的body字符串里开通竟然多个个'-'，完了还只能在编译器的控制台能看到，放到浏览器和别的编译器显示不出来，只能进行简单替换处理
回归SocketIo 前端操作
这里为了体验下机器人的代入感，做了个前端demo（很简陋，这里别吐槽。。。就是为了和socket结合一起实时看效果；忽略右上角的红x...调试时中断服务的原因...）
这里简介下nodejs express socketio的一些使用
前端引用socket.io.js，为了方式前后端socket版本不一致带来的问题，强烈建议如下引用方式
会直接调用接口/socket.io目录下的js文件，实际调用到modules目录下的文件
前端建立socket连接
建立连接后，监听名为getMsg的事件
建立连接，想服务端推送数据（socket.emit()），可以是String，可以是json对象
回归SocketIo 后端操作
初始化socketio
监听客户端的连接，这里socketio知识点很多，比如多客户端连接。通过id和session区分等，建议搭建参考官方文档，官方对socketio支持很赞，java，python，nodejs等等
事件监听，这里举例’send‘事件监听，具体触发如下
- 调用初始化的io进行emit()或send()，可向所有用户推送该消息（适用场景向所有客户端推送紧急通知）
- 调用该监听通道，向当前用户回复消息socket.emit()
- 调用当前监听通道，向出自己外的其他用户进行广播推送socket.broadcast.emit()
- 调用初始化的io向某个客户端进行单独的消息推送io.to(socketedId).emit()
此demo的核心代码基本就介绍这么多了...
写在最后
- config的很多配置在实际业务中应业务化处理，比如db化接受实时操作；
- 关于wechaty，根据个人的体验，除了没有朋友圈，视频号相关的内容操作，其他的基本满足机器人、私域相关的操作，支持多语言，提供Java，Go，Python，Javascript，C#等主流语言的兼容支持，根据官方api，业务可扩展性极强；
- 关于nodejs，由于作者之前并没有nodejs实战开发经验，也是基于这个demo看了nodejs相关文档，学习express框架初学，提供不了太多解读。不过nodejs基于脚本语言，学习起来还是很快；
- 关于socketio，和nodejs结合在一起，体验nodejs的异步非阻塞，简直要起了飞；
- 环境
- 系统：win7、centos7.6成功运行
- nodejs版本：windows下调试：v12.16.2；centos：v10.16.0；（wechaty对node版本有要求，不同协议版本最低要求不一致，大家自行参考开源说明和官方文档）
- 代码
- 主要是抽空码出来的，没有太多时间优化
- 有一些业务代码写好了，但是并没有接入使用，欢迎大家补充
- 刚开始查找微信助手相关功能时在CSDN看到这篇文章《Wechaty|不使用微信的web协议的机器人》，勾起了我对wechaty的回忆和探索，因此这篇文档很多内容上也是参考了它（时间关系甚至直接搬运，希望原文作者原谅哈...）
- 源码直通车→点我《wechaty-robot-lite》
后面有空，会持续迭代功能，后续需求扩展
- 推送
- 例如每日早8点，拉取头条发送至群聊
- 可设置定时任务，定时给自己/群聊发送消息
- 好友可定制天气预报定时推送功能
- 消息监听发送
- 同步展示推送媒体消息等
- 支持发送动图，表情包等信息
- 开启斗图模式
- 群聊功能消息管理
- 监听群聊中消息，有不正当言论时或不文明用语对其警告
- 涉zheng，涉huang等言论清除出群
- 群聊游戏
- 后台管理系统(可视化配置及群聊数据统计)
- 丰富聊天功能，提供媒体消息发送，资源库内容发送
- 统计群聊活跃度，关键词通知统计功能
PS：
这篇文档说的最多的应该是”官方文档“四个字了吧，这里再点一下，认真看文档！！！
参考文档
- Wechaty官方API
- Wechaty官方文档
- Wechaty官方示例
- socketio
- nodejs
- express框架
效果截图
待完结