WeRoBot 0.5.3 微信公众号开发框架文档

• 语言: 英语
• 格式: .epub
• 来源: werobot.readthedocs.io

摘要

文档介绍了WeRoBot 0.5.3版本，这是一个用于微信公众号开发的机器人框架。主要内容包括消息类型（如文本、图片、链接、位置等）、消息处理方法、三种回复类型（文本、图文、音乐）、会话管理、部署方式（独立服务器和SAE），以及版本更新日志。文档还提供了使用示例和注意事项。

AI总结

# WeRoBot 0.5.3 微信公众号开发框架总结

WeRoBot 是一个基于 MIT 协议的微信机器人框架，支持消息处理、自定义菜单创建、主动发送消息等功能。本文档总结了 WeRoBot 的核心功能、使用方法及更新日志。

---

## 1. 框架概述
- **功能**：WeRoBot 是一个微信公众号开发框架，支持多种消息类型（如文本、图片、链接、位置、语音等）的处理。
- **联系方式**：如需反馈问题或建议，可通过 GitHub 提 Issue 或发送邮件至 `whtsky [at] gmail.com`。

---

## 2. 核心功能
### 2.1 消息处理
- **消息类型**：支持 `TextMessage`、`ImageMessage`、`LinkMessage`、`LocationMessage`、`VoiceMessage` 和 `UnknownMessage` 等。
- **消息处理**：通过 `Handlers` 进行类型过滤和处理，支持 `robot.key` 和 `click` 修饰符。

### 2.2 回复类型
- **文本回复**：`TextReply` 支持简单的文本消息。
- **图文回复**：`ArticlesReply` 支持图文消息，每个回复最多可添加 10 篇文章。
- **音乐回复**：`MusicReply` 支持音乐消息。

### 2.3 Session 管理
- **开启 Session**：通过 `Session` 可以实现会话管理。
- **存储方式**：支持 `WeRoBot.Client` 和 Redis 存储，Redis 的默认 `prefix` 为 `ws_`。

### 2.4 微信 API 操作
- **类名**：`werobot.client.Client`，通过 `appid` 和 `appsecret` 初始化。
- **功能**：支持创建分组、自定义菜单、主动发送消息等操作。

---

## 3. 部署与优化
- **独立服务器**：支持在独立服务器上部署，推荐使用 `auto` 模式自动选择服务器。
- **SAE 部署**：提供 SAE 部署示例，参考 GitHub 仓库 `https://github.com/whtsky/WeRoBot-SAE-demo`。
- **进程管理**：建议使用 Supervisor 管理进程，避免终端关闭后进程退出。
- **反向代理**：推荐使用 Nginx 进行反向代理，配置示例如下：

  server {
      server_name example.com;
      listen 80;
      location / {
          proxy_pass http://127.0.0.1:8888;
      }
  }

---

## 4. 工具与扩展
- **Token 生成器**：WeRoBot 提供 `werobot.utils.generate_token()` 方法生成 Token，方便快速获取。

---

## 5. 更新日志
### 5.1 主要版本更新
- **v0.5.3**：修复根路径请求处理问题。
- **v0.5.2**：新增 Python 3 支持。
- **v0.5.0**：新增 `werobot.client` 和 `werobot.config`，支持会话默认开启。
- **v0.4.1**：新增 `VoiceMessage` 和 `message.raw` 属性。

---

## 6. 快速上手
- **创建机器人**：通过 `werobot.WeRoBot(token='tokenhere')` 初始化机器人。
- **消息处理**：使用 `@robot.text` 等装饰器定义消息处理函数。
- **自定义菜单**：通过 `Client.create_menu()` 创建自定义菜单，支持 `click` 和 `view` 类型按钮。

---

## 7. 注意事项
- 消息处理需注意 MsgID 的缺失问题（截至 2013.03.16）。
- 图文消息需符合微信公众平台对图片链接的要求。

---

WeRoBot 是一个功能强大且灵活的微信公众号开发框架，适合开发者快速搭建和维护微信机器人。