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

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

摘要

文档主要介绍了WeRoBot微信公众号开发框架的功能和使用方法，包括消息处理、自定义菜单创建、Session管理、部署方式以及与其他Web框架（如Django、Flask、Bottle）的集成。文档详细列出了各个版本的更新内容，包括功能新增和问题修复。版本更新主要集中在完善API功能、修复兼容性问题以及增强安全性。

AI总结

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

## 概述
WeRoBot 是一个用于微信公众号开发的框架，支持消息处理、自定义菜单、用户状态管理、消息加解密等功能，并提供与常见 Web 框架（如 Django、Flask、Bottle）的集成支持。

---

## 核心功能

### 1. 消息处理
- **消息类型**：支持文本消息、图片消息、链接消息、位置消息、语音消息、视频消息和未知消息。
- **事件处理**：支持用户触发的事件，如关注、扫描二维码等。
- **Handler**：通过修饰器（如 `@robot.text`、`@robot.image`）实现对特定消息类型的处理。

### 2. Session 管理
- **功能**：记录用户状态，支持判断用户是否为首次交互。
- **默认存储**：使用 SQLite 存储会话数据。
- **使用场景**：例如判断用户是否是第一次发送消息。

### 3. 自定义菜单
- **创建菜单**：通过 `werobot.client.Client` 调用微信 API 创建自定义菜单。
- **事件响应**：通过 `robot.key_click` 装饰器处理菜单点击事件。

### 4. 消息加解密
- **支持安全模式**：通过配置 `ENCODING_AES_KEY` 开启消息加解密功能。
- **依赖**：需要安装 `cryptography` 库。

### 5. 部署
- **独立服务器**：支持在独立服务器上部署。
- **SAE**：支持在 SAE（Server App Engine）上部署。

### 6. 与其他框架集成
- **Django**：通过 `werobot.contrib.django.make_view()` 集成。
- **Flask**：通过 `werobot.contrib.flask.make_view()` 集成。
- **Bottle**：支持直接使用 WeRoBot 的 Handler。

---

## 版本更新

### 1.1.1
- 修复 `werobot.client.Client.create_menu()` 的文档错误。
- 提示 `send_music_message()` 中可能的缩略图不显示问题。

### 1.1.0
- 新增 `BaseRoBot.client` 属性，支持通过 `Config` 传递参数。
- **Session 管理**：惰性加载 Session，关闭 Session 可通过 `Config.SESSION_STORAGE = False`。
- 修复默认错误页面问题。
- 支持 `reply.time` 快速读取回复属性。
- 完善 `Client` 类的 API 文档。

### 1.0.0
- 新增消息加解密支持。
- 重写 `messages` 模块，完善对 `Event` 的支持。
- 新增 `SuccessReply`、`ImageReply`、`VoiceReply`、`VideoReply`。
- 删除 `create_reply()` 方法，优化 `WeChatReply` 的 `process_args` 方法。
- 支持 Python 3.5+，取消对 Python 2.6 和 3.3 的支持。
- 新增对 Django 1.6+、Flask、Bottle 的集成支持。

### 0.6.1
- 修复上传媒体文件的 URL 错误。
- 新增 `VideoMessage` 支持。

### 0.6.0
- 新增 `@werobot.filter` 装饰器。
- 支持 `saekvstorage` 会话存储。
- 新增微信支付支持 `werobot.pay.WeixinPayClient`。
- 新增 `TransferCustomerServiceReply` 回复类型。

### 0.5.3
- 修复根路径请求问题。

### 0.5.2
- 修复 Python 3 支持问题。

### 0.5.1
- 修复文档中的拼写错误。

### 0.5.0
- 新增 `werobot.client` 和 `werobot.config` 模块。

---

## 入门示例

### Hello World

import werobot

robot = werobot.WeRoBot(token='tokenhere')

@robot.handler
def hello(message):
    return 'Hello World!'

robot.config['HOST'] = '0.0.0.0'
robot.config['PORT'] = 80
robot.run()

### 消息处理

@robot.text
def echo(message):
    return message.content

@robot.image
def img(message):
    return message.img

---

## 总结
WeRoBot 是一个功能全面的微信公众号开发框架，支持消息处理、自定义菜单、用户状态管理、消息加解密等功能，并提供多种部署方式和与其他 Web 框架的集成支持。开发者可以根据需求灵活使用其功能模块，快速开发高效的微信公众号应用。