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

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

摘要

文档介绍了WeRoBot 1.4.0微信公众号开发框架的功能与使用方法，包括消息处理、自定义菜单创建、用户状态管理、与Django、Flask等Web框架的集成，以及版本更新内容。框架支持多种消息类型处理，提供Session功能用于记录用户状态，并封装了微信API操作类以实现菜单创建、消息管理等功能。

AI总结

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

### 框架概述
WeRoBot 是一个用于微信公众号开发的框架，支持消息处理、自定义菜单创建、用户状态记录（Session）、消息加解密等功能。框架提供灵活的消息处理机制，支持多种消息类型（文本、图片、链接、位置、语音、视频等），并通过 Handler 进行消息处理。

### 核心功能
1. **消息处理**
- 支持多种消息类型（TextMessage、ImageMessage、LinkMessage、LocationMessage、VoiceMessage、VideoMessage、UnknownMessage）。
- 提供事件处理能力（如关注事件、扫描二维码事件等）。
- 支持通过 @robot.text、@robot.image 等装饰器处理特定类型的消息。

2. **Session 管理**
- 默认开启 Session 功能，使用 SQLite 存储用户状态。
- 可通过 Session 记录用户行为，例如判断用户是否为首次发送消息。

3. **自定义菜单**
- 提供创建和管理自定义菜单的功能，通过 `werobot.client.Client.create_menu()` 实现。
- 需提供 AppID 和 AppSecret，并运行一次即可完成菜单创建。

4. **消息加解密**
- 支持对微信消息的加解密功能，便于处理加密消息。

5. **部署支持**
- 支持在独立服务器、SAE 等环境中部署。
- 提供与 Django、Flask、Bottle、Tornado 等 Web 框架的集成支持。

6. **日志与错误处理**
- 提供日志记录功能，Handler 中的异常会以 Error 级别记录到 logger。
- 修复了直接 GET 访问 Robot 主页返回 500 的问题。

### 版本更新
- **V 1.4.0**
- 修复了直接 GET 访问 Robot 主页返回 500 的问题。
- 完善了 `werobot.client.Client` 的 API 文档。
- 支持通过 `reply.time` 快速读取 Reply 属性。

- **V 1.1.0**
- 增加 `werobot.robot.BaseRoBot.client` 属性，允许传入 Config。
- 修复了打包时 `error.html` 被忽略导致的默认错误页面问题。
- 支持通过 `reply.time` 快速读取 Reply 属性。

- **V 1.0.0**
- 增加对消息加解密的支持。
- 重写 `werobot.messages`，完善对 Event 的支持。
- 增加多种 Reply 类（如 `TextReply`、`ImageReply` 等）。

- **V 0.6.1**
- 修复 `upload_media` 的错误 URL。
- 增加 `VideoMessage` 支持。

### API 文档
- **应用对象 (`werobot.robot.BaseRoBot`)**
- 提供消息处理、Handler 管理的核心功能。
- 支持添加 Filter 和 Handler，灵活处理特定消息或事件。

- **消息处理类 (`werobot.messages`)**
- 提供消息解析和转换功能，支持多种消息类型和事件类型。

- **微信 API 操作类 (`werobot.client.Client`)**
- 封装了微信 API，支持自定义菜单、消息管理、用户管理、素材管理等操作。

### 总结
WeRoBot 是一个功能全面的微信公众号开发框架，支持消息处理、自定义菜单、Session 管理、部署集成等多种功能。框架通过版本更新不断完善，修复了多项问题并增加了新功能，适用于开发微信公众号的各种需求。