python基于itchat实现微信群消息同步机器人
最近 全栈数据工程师养成攻略 的微信群已经将近500人,开了二群之后为了打通不同微信群之间的消息,花了点时间做了个消息同步机器人,在任意群收到消息时同步到其他群,并且将聊天内容上传至数据库,以供进一步分析、统计和展示。
基本思路是,用 Python 模拟微信登陆,接收到群里消息后,对文本、图片、分享等各类消息类型分别处理,并转发至其他群。
前期准备
首先得有一个微信号,用于代码模拟登陆。由于我的微信号得自己留着用,现阶段注册微信又必须要手机号,于是只好特意办了个电信号,用来申请了一个新的微信,微信号是 honlanbot。虽说似乎可以用阿里小号来注册微信,不过听说存在反复回收和安全隐患问题,故不采用。
其次,需要用到一个Python库 itchat,这个库已经做好了用代码调用微信的大多数功能,非常好用,官方文档在这里,安装的时候使用 pip 即可。
pip install itchat
我的手机支持双卡双待,于是把两张卡都装手机里,再双开微信,同时保持两个微信号手机在线,差不多就可以开始写代码了。用 itchat 调用微信主要是模拟微信网页版登陆,所以必须保持微信号手机在线,因为手机端微信一旦退出,其在网页、PC、MAC、IPAD等相应终端认证的账号也会随之退出。
初步尝试
itchat 提供了一些官方代码,让我们在自己的本本或电脑上新建一个 py 文件,初步尝试一下。
运行以下代码,会出现出现一张二维码,扫码登陆之后将会给“文件传输助手”发送一条消息。
# 加载包 import itchat # 登陆 itchat.auto_login() # 发送文本消息,发送目标是“文件传输助手” itchat.send('Hello, filehelper', toUserName='filehelper')
以下代码则注册了一个消息响应事件,用来定义接收到文本消息后如何处理。在 itchat 里定义了文本、图片、名片、位置、通知、分享、文件等多种消息类型,可以分别执行不同的处理。
import itchat # 注册消息响应事件,消息类型为itchat.content.TEXT,即文本消息 @itchat.msg_register(itchat.content.TEXT) def text_reply(msg): # 返回同样的文本消息 return msg['Text'] itchat.auto_login() # 绑定消息响应事件后,让itchat运行起来,监听消息 itchat.run()
再来看看如何处理其他类型消息,可以把在消息响应事件里把 msg 打印出来,是一个字典,看看有哪些感兴趣的字段。
import itchat # import全部消息类型 from itchat.content import * # 处理文本类消息 # 包括文本、位置、名片、通知、分享 @itchat.msg_register([TEXT, MAP, CARD, NOTE, SHARING]) def text_reply(msg): # 微信里,每个用户和群聊,都使用很长的ID来区分 # msg['FromUserName']就是发送者的ID # 将消息的类型和文本内容返回给发送者 itchat.send('%s: %s' % (msg['Type'], msg['Text']), msg['FromUserName']) # 处理多媒体类消息 # 包括图片、录音、文件、视频 @itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO]) def download_files(msg): # msg['Text']是一个文件下载函数 # 传入文件名,将文件下载下来 msg['Text'](msg['FileName']) # 把下载好的文件再发回给发送者 return '@%s@%s' % ({'Picture': 'img', 'Video': 'vid'}.get(msg['Type'], 'fil'), msg['FileName']) # 处理好友添加请求 @itchat.msg_register(FRIENDS) def add_friend(msg): # 该操作会自动将新好友的消息录入,不需要重载通讯录 itchat.add_friend(**msg['Text']) # 加完好友后,给好友打个招呼 itchat.send_msg('Nice to meet you!', msg['RecommendInfo']['UserName']) # 处理群聊消息 @itchat.msg_register(TEXT, isGroupChat=True) def text_reply(msg): if msg['isAt']: itchat.send(u'@%s\u2005I received: %s' % (msg['ActualNickName'], msg['Content']), msg['FromUserName']) # 在auto_login()里面提供一个True,即hotReload=True # 即可保留登陆状态 # 即使程序关闭,一定时间内重新开启也可以不用重新扫码 itchat.auto_login(True) itchat.run()
开发消息同步机器人
经过以上示例代码,可以总结出消息同步机器人的开发思路:
- 维护一个字典,叫做 groups 好了,用来存所有需要同步消息的群聊,key 为群聊的ID,value 为群聊的名称;
- 接收到群聊消息时,如果消息来自于需要同步消息的群聊,就根据消息类型进行处理,同时转发到其他需要同步的群聊。
直接上代码好了,首先定义一个消息响应函数,文本类消息我感兴趣的是 TEXT 和 SHARING 两类,使用 isGroupChat=True 指定消息来自于群聊,这个参数默认为 False。
@itchat.msg_register([TEXT, SHARING], isGroupChat=True) def group_reply_text(msg): # 获取群聊的ID,即消息来自于哪个群聊 # 这里可以把source打印出来,确定是哪个群聊后 # 把群聊的ID和名称加入groups source = msg['FromUserName'] # 处理文本消息 if msg['Type'] == TEXT: # 消息来自于需要同步消息的群聊 if groups.has_key(source): # 转发到其他需要同步消息的群聊 for item in groups.keys(): if not item == source: # groups[source]: 消息来自于哪个群聊 # msg['ActualNickName']: 发送者的名称 # msg['Content']: 文本消息内容 # item: 需要被转发的群聊ID itchat.send('%s: %s\n%s' % (groups[source], msg['ActualNickName'], msg['Content']), item) # 处理分享消息 elif msg['Type'] == SHARING: if groups.has_key(source): for item in groups.keys(): if not item == source: # msg['Text']: 分享的标题 # msg['Url']: 分享的链接 itchat.send('%s: %s\n%s\n%s' % (groups[source], msg['ActualNickName'], msg['Text'], msg['Url']), item)
再来处理下图片等多媒体类消息。
# 处理图片和视频类消息 @itchat.msg_register([PICTURE, VIDEO], isGroupChat=True) def group_reply_media(msg): source = msg['FromUserName'] # 下载图片或视频 msg['Text'](msg['FileName']) if groups.has_key(source): for item in groups.keys(): if not item == source: # 将图片或视频发送到其他需要同步消息的群聊 itchat.send('@%s@%s' % ({'Picture': 'img', 'Video': 'vid'}.get(msg['Type'], 'fil'), msg['FileName']), item)
以上代码实现了对文本、分享、图片、视频四类消息的处理,如果对其他类型的消息也感兴趣,进行相应的处理即可。在前面补上 import 的代码,在后面补上登陆和运行的代码,就大功告成了。
成果展示
目前两个群之间可以进行消息同步了,一群和二群的小伙伴终于可以畅快地聊了起来(当群主不容易,经常要发很多红包 = =)。
进一步工作
当然,我不可能一直在笔记本上运行这么个 py 代码,所以把它部署到服务器上运行就好了,开个 screen 或者用 IPython 都可以。如果账号偶尔下线了,再运行一下就好。
另外,我还写了个 API,响应消息的时候会把相应的数据 POST 到我的服务器并存到数据库,以供进一步的分析、统计和展示,这也是我身为一个群主应尽的职责~