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

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

摘要

文档介绍了WeRoBot微信公众号开发框架的功能和使用方法，包括消息处理、回复类型（文本、图文、音乐）、会话管理、部署方式（支持多种服务器和反向代理）以及版本更新信息。文档还提供了详细的代码示例和配置说明。

AI总结

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

## 框架概述
WeRoBot 是一个基于 MIT 协议的微信机器人框架，提供多种功能模块，支持消息处理、回复生成、会话管理等。用户可通过 GitHub 提交问题或反馈建议。

---

## 核心功能

### 1. 消息处理
WeRoBot 支持多种消息类型：
- **文本消息（TextMessage）**：处理普通文本内容。
- **图片消息（ImageMessage）**：处理图片相关请求。
- **链接消息（LinkMessage）**：处理链接信息。
- **位置消息（LocationMessage）**：处理用户发送的位置信息。
- **事件消息（EventMessage）**：处理微信公众号事件（如关注、取消关注）。
- **语音消息（VoiceMessage）**：处理语音信息。
- **未知消息（UnknownMessage）**：处理未识别的消息类型。

### 2. 消息回复
WeRoBot 提供三种主要的回复类型：
- **文本回复（TextReply）**：用于简单的文本反馈。
- **图文回复（ArticlesReply）**：支持最多 10 篇文章，每篇文章包含标题、描述、图片链接和跳转链接。
- **音乐回复（MusicReply）**：支持音乐链接和高质量音乐链接。

### 3. 会话管理
WeRoBot 支持会话功能：
- 开启会话后，开发者可通过 `Session` 管理用户状态。
- 提供多种存储方案，如 `werobot.Client`。

---

## 部署与扩展

### 1. 部署方式
- **独立服务器**：支持多种 WSGI 服务器（如 Gunicorn、Gevent）。
- **SAE**：支持在云端部署。
- **反向代理**：推荐使用 Nginx 进行反向代理，确保服务器支持 80 端口。

### 2. 守护进程管理
建议使用 Supervisor 管理 WeRoBot 进程，避免终端关闭后服务中断。

---

## 工具与日志

### 1. 小工具
- **Token 生成器**：通过 `werobot.utils.generate_token()` 生成合法的 Token。

### 2. 日志与配置
- 提供 `werobot.logger` 和 `werobot.config` 模块，便于调试和配置。

---

## 版本更新

### 0.5.0
- 新增 `werobot.client` 和 `werobot.config`。
- 支持位置事件（Location Event）。
- 提供 `@werobot.key_click` 修饰符。
- 默认开启会话功能。
- 优化服务器支持和错误页面显示。

### 0.4.1
- 新增语音消息（VoiceMessage）和原始消息内容（`message.raw`）。
- 修复签名无效的 bug。

### 0.4.0
- 新增会话支持和日志功能。
- 提升 Handler 的优先级管理。

### 0.3.5
- 修复用户地理位置数据包类型问题。

---

## 示例代码

### Hello World

import werobot

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

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

robot.run()

### 图文回复

from werobot.reply import ArticlesReply, Article

reply = ArticlesReply(message=message)
article = Article(
    title="WeRoBot",
    description="WeRoBot 是一个微信机器人框架",
    img="https://github.com/apple-touch-icon-144.png",
    url="https://github.com/whtsky/WeRoBot"
)
reply.add_article(article)

---

## 总结
WeRoBot 是一个功能完善的微信公众号开发框架，支持多种消息类型和回复方式，适合开发者快速构建机器人应用。通过会话管理和部署工具，用户可以轻松实现生产环境的稳定运行。