200 行代码，一行行教你自制微信机器人

zhuxrgf 2018-11-16

展开全文

1.写机器人的原因

笔者当初决定自己写这么个机器人，有几个原因：

1）用一个Windows客户端工具运营公众号，真的很局限。虽然工具的功能很强大，能自动添加好友，自动拉好友入群，关键字回复等等，但是有一个绕不开的点，它是一款客户端工具，一款EXE软件。

2）我是Mac，为了用这个工具，就要开着虚拟机去操作。

3）为了能一直自动添加好友，邀请入群，自动回复等一系列操作，电脑就不能合上。

4）在外面突然想到一个点，想操作群发了，GG，无能为力。

5）其他……

2.确定需求

基于以上的原因，就想着自己来一套算了。毕竟可以定制化的话，之后想要什么就很方便了，而且在服务器端挂个Python服务要比开个Windows就为了挂一个EXE要很多。

那么首先需要确定需求，wxRobot我是准备长期维护、迭代的，所以显然不可能像网上那些个脚本一样，一个文件打通关。

另外功能自定义，就需要有版本引入，先做什么，痛点是什么都需要明确。我说下自己的选择：

1）痛点是不能自主化的管理公众号、微信号。

2）最急迫解决的是之前EXE工具用到的功能，毕竟这也是我用这个工具的原因。那么有哪些功能呢？

群发消息
自动添加好友
邀请好友入群
关键字回复

3.组件构成

既然是个项目，那么该有的组件一个不能少，看一下我的目录结构，这也是我自己总结出的Common structure，大家可以参考一下。

App：项目业务模块。如果有多个模块就添加子目录，例如：一个网站下的博客模块、投票模块等。

Core：核心组件。例如：数据库组件、类-文件组件等。

Doc：文档。存放所有的文档，一般我会有固定的几个：CHANGELOG.md、BUGLIST.md、TODOLIST.md。

ETC：配置文件。可以细分基本配置、业务配置等。

static：静态文件。

test：单元测试。

TMP：不需要进入版本控制的东西。

Utility：辅助组件。和core相辅。

4.业务分块

我把业务分为两块，filehelper算一个，好友相关的算一个。

好友相关的好理解，诸如添加好友、自动回复、邀请入群等。filehelper是什么呢？说白了，我们除了简单的自动回复、添加外，一定还希望做的更多吧？比如交互式指令。那这个filehelper就承担了指令收发的角色。

所有的业务模块都基于一个BaseHandle，这样底层的一些单元我就可以统一管控了：

class BaseHandle:
 def __init__(self):
 '''
 self._meta = {
 'obj':{ # 消息发送对象
 'ul': [], # unlimit group
 'l': [], # limit group
 'r': [] # restrict
 },
 'reply':{
 'text': '',
 'article': '',
 }
 }
 '''
 self._usage = ''
 self._meta = {}
 self.current_cmd = None
 @property
 def usage(self):
 return self._usage
 @property
 def meta(self):
 return self._meta

再来看看FileHandle这个类，这也是当前版本最丰富的模块。这里面有两端逻辑：1.自动更新群组信息。 2.注册群发相关命令。

自动更新群组信息的目的是因为itchat模块会将所有联系人以及群组信息存储在本地的一个PKI文件中（一个用公钥概念和技术实施和提供安全服务的具有普适性的安全基础设施）。

如果想提升群发消息前获取群组列表的速度，那么就应该把数据放在内存里（反正也没多少数据），以下我把主要逻辑都罗列出来了，具体的代码太长了，暂时就不放出来了：

class FileHelper(BaseHandle):
 _usage = '''
 '''
 def __init__(self):
 super().__init__()
 self._meta = {
 ...
 }
 self._th_update = threading.Thread(target=self._update_meta, args=(), daemon=True)
 self.auto_update_groups()
 def auto_update_groups(self):
 # 自动更新群组
 self._th_update.start()
 def _update_meta(self):
 '''
 初始化限时推送的群组
 '''
 def _filter_restrict_groups(group):
 # 筛选出不能群发的群组
 def _filter_limit_groups(group):
 # 筛选出有时间限制的群组
 def _filter_unlimit_group(groups, limit_groups):
 # 筛选出不受限制的群组
 while True:
 time.sleep(30)
 # 更新群组信息

注册群发相关命令的思路就是做一个命令注册器，因为群发消息、文章、图片等行为类似，针对不同的用户群组发送不同的消息体。

所以我就把注册器的成员分成了：类型（文字、图片）、对象（时间限制群组、无限制群组）、行为（群发、单发）。

被装饰器注册的函数就成为了某个具有单独意义的指令了。

class FileHelper(BaseHandle):
 ...
 def update_cmd(self, cmd):
 # 更新命令，用于动态注册函数
 def _register_mass(func):
 @functools.wraps(func)
 def decorator(self, msg, *args, **kwargs):
 _action, _reply, _obj = func.__name__.split('_')
 if self._meta['action'][_action]:
 _to_user = self._meta['obj'][_obj]
 for _group in _to_user:
 instance.send_msg(msg, _group['UserName'])
 time.sleep(random.randrange(0, 20))
 self._meta['action'][_action] = False
 self._current_cmd = None
 instance.send_msg('群发消息发送完毕', self._meta['extra']['UserName'])
 return decorator
 @_register_mass
 def mass_text_ul(self, msg=None):
 pass
 @_register_mass
 def mass_text_l(self, msg):
 pass
 @_register_mass
 def mass_text_test(self, msg):
 pass
 @_register_mass
 def mass_article_ul(self, msg):
 pass
 @_register_mass
 def mass_article_l(self, msg):
 pass

对比着效果图来看看：

5.添加好友

接下来就是添加好友部分了，目前只支持自动接受好友，根据打招呼自动设置备注，关键字回复。

class Friend(BaseHandle):
 _usage = '''
 '''
 def __init__(self):
 super().__init__()
 self._meta = {
 ...
 }
 def is_biz(self, msg):
 # 判断是不是商务合作

看下效果图：

6.不同版本

讲完核心代码后，再来讲下中间经历的几个看不到的版本吧。

最一开始就是实现功能咯，没想很多，但是发现代码重复太多了，逻辑都差不多，一堆代码太丑了。优化后的代码就是第一版中的群发注册器函数。

接着原本的BaseHandle基类太重了，想的很好，把itchat方法都重写在基类里，这样就不用在其他地方调用itchat实例了，但是结果就是所有的子类都可以做同样的动作，就变成了filehelper.send_msg(), friend.send_image()了，这样对于同一个方法就会产生歧义了。

因此就把基类里所有重写itchat方法的函数都去了，就保留了业务代码，并分别移到对应的类里去，而原本itchat的方法还是用itchat实例去操作。

接着关于itchat实例、FileHelper实例、Friend实例等的共享问题，容易造成重叠，重复使用、互相引用问题。

解决办法目前就是把itchat实例单独在配置文件里初始化了，这也同时解决了上一个问题，其他业务类的实例采用单例模式，在类外面暴露一个统一的实例。