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

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

摘要

文档详细介绍了WeRoBot微信公众号开发框架的功能和使用方法。内容包括消息处理、自定义菜单创建、部署方法、会话管理、微信API操作等核心功能。文档还列出了多个版本的更新记录，包括新增功能和问题修复。框架支持与Django、Flask等主流Web框架的集成，并提供了详细的API参考。

AI总结

《WeRoBot 1.4.1 微信公众号开发框架文档》总结如下：

### 框架简介
WeRoBot 是一个用于微信公众号开发的框架，提供消息处理、自定义菜单创建、会话管理等功能。支持多种 Web 框架（如 Django、Flask、Bottle）集成，并兼容 Python 3.6+。

---

### 核心功能
1. **消息处理**
- 支持多种消息类型（文本、图片、链接、位置、语音、视频等）。
- 提供事件处理能力，支持用户行为触发的事件（如扫描二维码、地理位置选择等）。

2. **自定义菜单**
- 支持创建和管理自定义菜单，提供菜单点击事件的处理能力。

3. **会话管理**
- 使用 Session 记录用户状态，支持多种存储方式（如 SQLite、MySQL、SAE KVDB）。

4. **微信 API 操作**
- 提供 `WeRoBot.Client` 类，方便调用微信 API（如消息管理、用户管理、素材管理等）。

5. **消息加解密**
- 支持对微信消息的加解密功能，确保通信安全。

6. **日志记录**
- 支持通过 logger 记录处理过程中的错误和信息。

---

### 版本更新
#### V 1.4.1
- **修复**
- 修复 `werobot.client.Client.post()` 中中文文件名的 bug。
- 修复 `werobot.session.filestorage.FileStorage` 在 PyPy 下的兼容性问题。
- 修复 `werobot.client.Client.get media list()` 的调用参数错误。

- **新增**
- 增加多个事件类型（如 `CardPassCheckEvent`、`UserScanProductEvent` 等）。
- 增加 `werobot.session.mysqlstorage.MySQLStorage` 和 `werobot.session.saekvstorage.SaeKVDBStorage` 的测试。
- 完善 `WeRoBot.Client` 的 API 文档。

#### V 1.4.0
- **新增**
- 增加多个与会员卡相关的事件类型（如 `CardPassCheckEvent`、`UserGetCardEvent` 等）。
- 增加 `werobot.messages.events.LocationSelectEvent` 和 `werobot.messages.events.ScanCodePushEvent`。

- **优化**
- 提升消息处理的效率和稳定性。

#### V 1.3.0
- **新增**
- 增加与商品相关事件（如 `UserScanProductEvent`、`UserScanProductAsyncEvent` 等）。
- 增加图片事件（如 `PicSysphotoEvent`、`PicPhotoOrAlbumEvent`）和位置选择事件。

---

### 主要 API
1. **应用对象**
- `werobot.robot.BaseRoBot`：框架的核心对象，负责消息处理和事件分发。
- `werobot.robot.WeRoBot`：继承自 `BaseRoBot`，支持独立运行或与其他 Web 框架集成。

2. **消息与事件**
- 支持多种消息类型（如 `TextMessage`、`ImageMessage` 等）和事件类型（如 `user_scan_product_event`、`user_view_card_event` 等）。

3. **过滤与处理**
- 提供 `@robot.filter` 和 `@robot.handler` 装饰器，支持按消息类型或文本内容进行过滤和处理。

4. **存储与会话**
- 提供多种会话存储方式（如 SQLite、MySQL、SAE KVDB）。

---

### 集成支持
- **Django**
- 支持 Django 1.8+，通过 `werobot.contrib.django.make_view()` 将 WeRoBot 集成到 Django 项目中。

- **Flask**
- 支持 Flask 框架，通过简单的配置即可实现 WeRoBot 的运行。

- **Bottle**
- WeRoBot 本身基于 Bottle 框架开发，支持独立运行。

---

### 总结
WeRoBot 是一个功能强大且灵活的微信公众号开发框架，支持多种消息类型、事件处理、自定义菜单、会话管理以及与其他 Web 框架的集成。1.4.1 版本修复了部分 bug 并新增了多种事件类型，进一步提升了框架的稳定性和扩展性。