微信机器人WeChat-PyRobot开源项目教程

1. 项目介绍

WeChat-PyRobot是一个开源项目，通过将Python代码注入到微信进程中，实现微信机器人的功能。它可以发送文本、图片、AT消息等，还能hook微信日志输出、接收消息、防止消息撤回等。项目基于Python开发，提供了丰富的插件接口，用户可以自定义插件来扩展机器人的功能。

2. 项目快速启动

环境准备

• 安装支持的微信版本（例如3.9.8.15）。
• 安装Python，版本大于等于3.8（建议使用3.8版本来避免bug）。
• 使用pip安装WeChat-PyRobot库：

pip install wechat_pyrobot==1.3.0

如果国内源没有同步最新版本，可以使用pip官方库指定安装：

pip install wechat_pyrobot==1.3.0 -i https://pypi.org/simple/

启动步骤

1. 创建一个名为robot_code的目录。
2. 在该目录下创建一个main.py文件，并写入以下代码：

from py_process_hooker import inject_python_and_monitor_dir
from wechat_pyrobot import get_on_startup
from wechat_pyrobot.msg_plugins import PrintMsg, DownLoadEmotion
from wechat_pyrobot.other_plugins import HttpApi

if __name__ == "__main__":
    process_name = "WeChat.exe"
    open_console = True
    on_startup = get_on_startup(
        msg_plugins=[
            PrintMsg,
            DownLoadEmotion
        ],
        other_plugins=[
            HttpApi
        ]
    )
    inject_python_and_monitor_dir(
        process_name,
        __file__,
        open_console=open_console,
        on_startup=on_startup
    )

3. 启动并登录微信。
4. 运行main.py，Python将注入到微信进程中并打开控制台。

3. 应用案例和最佳实践

发送消息

import requests

url = "http://127.0.0.1:26666/sendmsg"
params = {
    "touser": "filehelper",
    "msg": "测试消息"
}
requests.get(url, params=params)

发送AT消息

import requests
import json

url = "http://127.0.0.1:26666/sendatmsg"
data = {
    "touser": "11111111111@chatroom",
    "msg": "@昵称 222222",
    "atwxid": "被@人的wxid"
}
headers = {
    "content-type": "application/json"
}
print(requests.get(url, params=data).json())

发送图片消息

import requests

url = "http://127.0.0.1:26666/sendimage"
params = {
    "touser": "filehelper",
    "path": r"C:\Users\Administrator\Pictures\图片1.jpg"
}
requests.get(url, params=params)

获取联系人列表

import requests

url = "http://127.0.0.1:26666/contacts"
print(requests.get(url).json())

自定义插件

创建一个名为save_to_file.py的文件，用于将消息保存到文件中：

import os
import json
from wechat_pyrobot.plugin_class import MsgPluginTemplate

class SaveToFile(MsgPluginTemplate):
    def __init__(self, **kwargs):
        self.name = os.path.basename(__file__)[: -3]
        super().__init__(**kwargs)
        self.msg_save_path = os.path.join(kwargs["pwd"], "msg_save_path")
        os.makedirs(self.msg_save_path, exist_ok=True)

    def deal_msg(self, msg_dict):
        path = os.path.join(self.msg_save_path, f'{msg_dict["msgid"]}.json')
        with open(path, 'w', encoding='utf-8') as f:
            f.write(json.dumps(msg_dict))

在main.py中导入并使用自定义插件：

from my_msg_plugin.save_to_file import SaveToFile

# 其他代码保持不变

on_startup = get_on_startup(
    msg_plugins=[
        PrintMsg,
        DownLoadEmotion,
        SaveToFile
    ],
    other_plugins=[
        HttpApi
    ]
)

4. 典型生态项目

WeChat-PyRobot项目周边有许多扩展插件和衍生项目，以下是一些典型的生态项目：

• pywxrobot2.0：新版本的微信机器人项目，使用C++进行hook层面的事务，使用aardio加载Python作为插件语言。
• 各类自定义插件：用户根据自己的需求开发的用于特定场景的插件，如自动回复、消息统计、数据分析等。