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

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

摘要

WeRoBot 是一个用于微信公众号开发的机器人框架，支持创建自定义菜单、处理多种类型的消息（如文本、图片、链接、地理位置等），并提供微信支付接口操作类。文档详细介绍了框架的核心功能，包括消息处理、回复类型、会话管理、部署方式以及版本更新日志。框架支持多种服务器环境，并提供Token生成器和使用指南。

AI总结

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

## 1. 框架概述
- **WeRoBot** 是一个基于 MIT 协议开源的微信机器人框架。
- 提供多种功能模块，包括消息处理、自定义菜单创建、支付支持等。
- 开发者可以通过 GitHub 提交问题或反馈建议：[https://github.com/whtsky/WeRoBot/issues](https://github.com/whtsky/WeRoBot/issues)。

---

## 2. 入门示例
- **Hello World**：最简单的机器人实现，回复每条消息为 "Hello World!"。
- 示例代码：

  import werobot
  robot = werobot.WeRoBot(token='tokenhere')
  @robot.handler
  def echo(message):
      return 'Hello World!'
  robot.run()

---

## 3. 消息类型
WeRoBot 支持多种消息类型，包括：
- **TextMessage**：文本消息
- **ImageMessage**：图片消息
- **LinkMessage**：链接消息
- **LocationMessage**：地理位置消息
- **VoiceMessage**：语音消息
- **UnknownMessage**：未知消息类型

---

## 4. 回复类型
WeRoBot 提供四种回复类型：
- **TextReply**：简单文本回复
- **ArticlesReply**：图文消息回复
- **MusicReply**：音乐消息回复
- **TransferCustomerServiceReply**：客服转移回复

---

## 5. Session 支持
- 开启 Session 后，开发者可以使用会话功能。
- 提供多种 Session 存储方式：
- **FileStorage**：基于文件的存储
- **MongoDBStorage**：基于 MongoDB 的存储
- **SAE KVDB Storage**：基于 SAE KVDB 的存储

---

## 6. 微信 API 操作
- **WeRoBot.Client**：用于操作微信 API，例如创建自定义菜单、发送消息等。
- 示例代码：

  client = werobot.client.Client(appid, appsecret)
  client.create_menu({
      "button": [
          {
              "type": "click",
              "name": "今日歌曲",
              "key": "V1001_TODAY_MUSIC"
          },
          {
              "type": "view",
              "name": "视频",
              "url": "http://v.qq.com/"
          }
      ]
  })

---

## 7. 支付支持
- **WeRoBot.pay.WeixinPayClient**：微信支付 API 操作类。
- 提供生成支付链接、处理支付回调等功能。

---

## 8. 部署与运行
- **独立服务器**：支持部署在任何独立服务器上。
- **SAE**：支持部署在 SAE（百度云服务）上。
- **反向代理**：推荐使用 Nginx 进行反向代理，支持 HTTPS 和端口转发。

---

## 9. 版本更新（Changelog）
### v0.6.0
- 新增 `@werobot.filter` 和 `werobot.session.saekvstorage`。
- 支持微信支付 (`werobot.pay.WeixinPayClient`)。
- 新增 `TransferCustomerServiceReply` 回复类型。
- 修复 `FileStorage` 的部分 bug。

### v0.5.3
- 修复无法处理根路径请求的问题。

### v0.5.2
- 改善对 Python 3 的支持。

### v0.5.1
- 修复文档中的拼写错误。

### v0.5.0
- 新增 `werobot.client` 和 `werobot.config`。
- 支持会话功能，默认开启 Session。

---

## 10. 其他工具
- **Token 生成器**：通过 `werobot.utils.generate_token()` 生成合法的 Token。
- **日志支持**：支持日志记录，便于调试和监控。

---

## 11. 总结
WeRoBot 是一个功能丰富且灵活的微信公众号开发框架，支持消息处理、自定义菜单、支付功能、会话管理等核心功能。开发者可以通过简单的代码快速实现微信机器人，并通过文档提供的 API 和工具进行功能扩展和优化。