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

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

摘要

文档详细描述了WeRoBot 1.6.0版本的功能和使用方法，包括消息处理、会话管理、自定义菜单创建以及API配置等。该框架支持与多种Web框架如Django、Flask、Bottle的集成，并提供了丰富的API接口和事件处理机制，方便开发者快速搭建微信公众号服务。新版本增加了对发送小程序卡片的支持，并修复了多项功能性问题。

AI总结

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

一、概述
1. WeRoBot 是一个开源的微信公众号开发框架，支持快速开发和部署微信公众号应用。
2. 主要功能包括消息处理、自定义菜单、Session 管理、微信 API 操作等。
3. 支持多种 Web 框架（如 Django、Flask、Bottle）集成，并提供部署指南。

二、核心功能
1. 消息处理：
- 支持文本、图片、链接、地理位置、语音、视频等多种消息类型
- 提供多种 Handler 修饰器（@robot.text、@robot.image 等）方便开发者处理不同类型的消息
- 支持事件处理（如关注事件、扫描二维码事件等）

2. Session 功能：
- 提供用户会话管理，方便记录用户状态
- 支持 SQLite 和文件存储 Session 数据
- 示例代码：

@robot.text
def first(message, session):
    if 'first' in session:
        return '你之前给我发过消息'
    session['first'] = True
    return '你之前没给我发过消息'

3. 自定义菜单：
- 使用 werobot.client.Client.create_menu() 接口创建自定义菜单。示例：

client.create_menu({
    "button":[{
        "type": "click",
        "name": "今日歌曲",
        "key": "music"
    }]
})

4. 微信 API 操作：
- 提供 Client 类来封装微信 API 接口，支持发送模板消息、管理用户、素材、账户等功能。

三、部署指南
1. 独立服务器部署：
- 使用 robot.run() 方法启动服务
- 配置项包括 host、port、enable_pretty_logging 等
- 示例代码：

robot = werobot.WeRoBot(token='tokenhere')
robot.config['HOST'] = '0.0.0.0'
robot.config['PORT'] = 80
robot.run()

2. SAE 部署：
- 支持直接部署到淘宝云进行测试和生产环境部署

3. 与其他 Web 框架集成：
- Django：通过 werobot.contrib.django.make_view() 集成
- Flask：通过 werobot.contrib.flask.make_view() 集成
- Bottle：直接在 Bottle 应用中配置路由。示例代码：

from werobot.contrib.flask import make_view
app.add_url_rule(rule='/robot/', ... , view_func=make_view(myrobot), ...)

四、版本更新
1. 最新版本 1.6.0 更新内容：
- 增加发送小程序卡片的支持
- 通过 werobot.client.Client.send_miniprogrampage_message() 接口实现

2. 其他版本更新：
- 1.5.0：正则匹配 Handler 支持匹配后的 Match Object 作为参数
- 1.4.0：增加多种卡片相关的事件处理
- 1.3.0：支持为 BaseRoBot 生成 Django view

五、配置说明
1. 重要配置参数：
- token：微信公众号设置的 token
- app_id 和 app_secret：微信公众号的 app_id 和 app_secret
- encoding_aes_key：消息加解密的 aes 密钥

2. 配置对象：
- 支持通过 Config 对象设置
- 可以从 Python 对象或文件中读取配置

六、日志配置
- 支持启用 pretty_logging，优化日志输出格式
- 示例代码：

werobot.logger.enable_pretty_logging(logger, level='info')

七、API 返回码
- 返回码列表：
- 48001: API 未授权

八、开发者指南
1. 命名规范：
- 遵循 GitHub 开源规范
- 提交代码需通过代码审查（Code Review）
- 代码提交需通过自动化测试（CI）

2. 提交代码说明：
- 通过 develop 分支提交代码
- 确保代码符合 PEP8 规范
- 提交代码时请附带详细说明

九、常见问题
- API 返回码说明
- 消息加解密说明
- Handler 和 Filter 的区别和使用场景