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

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

摘要

文档详细介绍了WeRoBot 1.10.0版本的功能与使用方法，包括消息处理机制、Session管理、自定义菜单创建、消息加解密、部署方式以及与其他Web框架（如Django、Flask、Bottle）的集成。WeRoBot是一个基于Bottle框架的微信公众号开发框架，支持通过Handler处理各种消息和事件类型，并提供了丰富的API操作类和配置选项。此外，文档还列出了各个版本的更新日志，展示了新增功能和问题修复情况。

AI总结

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

## 框架概述
WeRoBot 是一个用于开发微信公众号的开发框架，支持消息处理、自定义菜单、消息加解密、Session配置等功能。框架基于Bottle，且支持与Django、Flask等主流Web框架集成。

### 核心功能
1. **消息处理**：
- 支持文本、图片、链接、地理位置、语音、视频等消息类型。
- 通过`@robot.handler`装饰器定义消息处理逻辑，支持根据消息类型（如`@robot.text`、`@robot.image`）或关键词（`@robot.filter`）过滤处理。
- 支持事件处理（如关注事件、扫描二维码事件、进入会员卡事件等），通过特定装饰器（如`@robot.key_click`）定义事件处理逻辑。

2. **Session配置**：
- 提供两种存储方式，`SQLiteStorage`和`FileStorage`，用于记录用户状态。
- 支持通过`session_storage`参数配置Session存储对象。

3. **部署**：
- 支持在独立服务器、SAE、Django、Flask、Bottle等环境中部署。
- 提供`run`方法运行WeRoBot，即可挂载到指定地址。

4. **Client功能**：
- 提供`werobot.Client`类，支持微信官方API操作，如发送消息、管理素材、用户管理、用户标签管理等。
- 新增功能：支持上传图文消息素材和群发接口。

5. **与其他框架集成**：
- **Django**：通过`werobot.contrib.django.make_view`生成Django视图。
- **Flask**：通过`werobot.contrib.flask.make_view`生成Flask视图。
- **Bottle**：直接在Bottle应用中使用。

6. **日志与配置**：
- 支持日志格式化输出，通过`werobot.logger.enable_pretty_logging`开启优化日志记录。
- 支持从Python对象或文件中读取配置，通过`werobot.config.Config`进行配置管理。

7. **版本更新**：
- **1.10.0**：新增上传图文素材和群发接口支持。
- **1.9.0**：新增用户标签管理支持。
- **1.8.0**：新增PostgreSQL存储支持，并修复Python 3兼容性问题。

## 消息与事件处理
- **消息类型**：
- `TextMessage`：处理文本消息。
- `ImageMessage`：处理图片消息。
- `LinkMessage`：处理链接消息。
- `LocationMessage`：处理地理位置消息。
- `VoiceMessage`：处理语音消息。
- `VideoMessage`：处理视频消息。

- **事件类型**：
- 关注事件、扫码事件、进入会员卡事件等，通过特定装饰器定义处理逻辑。

## 开发示例

from werobot import WeRoBot
from werobot.session.sqlitestorage import SQLiteStorage

# 初始化WeRoBot
session_storage = SQLiteStorage()
robot = WeRoBot(token="token", enable_session=True, session_storage=session_storage)

# 定义消息处理逻辑
@robot.handler
def hello(message):
    return "Hello World!"

## 总结
WeRoBot 是一个功能全面的微信公众号开发框架，支持丰富的消息处理、Session管理、微信API操作以及与主流Web框架的集成，适合快速开发微信公众号应用。框架提供清晰的配置和扩展接口，满足不同开发需求。