Claudia 机器人构建工具

Claudia 机器人构建工具 帮助开发者在几分钟内为各种平台创建并部署聊天机器人到 AWS Lambda。它简化了消息传递流程，自动设置正确的 Webhook，并引导您完成配置步骤，使您可以专注于重要的业务问题，而无需担心基础设施代码。

🚀 入门指南	🛠 API 文档	🤖 示例项目	🤔 常见问题解答	💬 在 Gitter 上交流

观看这段两分钟的视频，了解如何快速创建和部署机器人：

以下是一个简单的示例：

const botBuilder = require('claudia-bot-builder');
const excuse = require('huh');

module.exports = botBuilder(function (message) {
  return '感谢您发送了 ' + message.text +
    '您的消息对我们非常重要，但 ' +
    excuse.get();
});

这段代码足以支持所有受支持的平台上的机器人运行。Claudia 机器人构建工具会自动将传入的消息解析为通用格式，方便您处理。它还会自动将响应打包成请求方机器人的正确消息模板，因此您无需关心各个机器人的协议细节。

支持的平台

• Facebook Messenger
• Slack（频道 Slash 命令及带有 Slash 命令的应用）
• Skype
• Viber
• Telegram
• Twilio（短信服务）
• Amazon Alexa
• Line
• Kik
• GroupMe

创建机器人

请参阅入门指南，了解如何在几分钟内设置一个简单的机器人；以及API 文档，获取关于 API 的详细信息。

示例

请查看 Claudia.js 示例项目列表中的聊天机器人部分。

常见问题解答

1. 如何在本地运行？

   目前还无法轻松实现。Claudia 机器人构建工具本身并不包含独立的 HTTP 服务器（如 Express、Hapi 等），而是依赖于 API Gateway，因此在本地模拟类似环境并不简单。您可以使用 --version test 参数将其部署到 AWS Lambda 中，以创建一个独立的测试环境。

2. 如何测试我的机器人？

   您的聊天机器人本质上就是一个 Lambda 函数，也就是一个简单的 JavaScript 函数，理论上您应该能够在本地将其作为自动化测试来运行。

   最重要的是设计可测试的 Lambda 函数，这篇指南 将帮助您做到这一点。

   如果涉及与外部或 AWS 服务的集成，集成测试可能会稍微复杂一些。请参考这篇指南，了解如何编写集成测试并在本地运行自动化测试。

3. 我的 Facebook Messenger 机器人只回复我的消息，为什么不回复所有人？

   Facebook 对聊天机器人有审核流程。请确保您的机器人已通过审核。

4. 我能否发送延迟的 Slack Slash 命令响应？

   是的，您可以参考这篇教程。

5. v2 版本有哪些新功能？

   这是一个重大版本更新，主要是因为依赖项的变化——Claudia API 构建工具和 Claudia 本身都有显著改进，因此 v1.x 版本的 Claudia 机器人构建工具不再兼容这些工具。此外，v2.x 还新增了对许多新平台的支持。

6. 如何加快部署速度？

   您可以使用 claudia update 命令，并加上 --cache-api-config 标志来缓存 API Gateway 配置。更多信息请参阅 claudia update 的文档页面。

   另外，从 2.7.0 版本开始，您可以禁用暂时不使用的平台。具体说明请参阅 API 文档。

如果您有未在此列出的问题，请随时在 Claudia 的 Gitter 聊天室 中提问。

请注意：请勿使用 GitHub Issues 来提问或寻求帮助和支持，仅用于报告 bug。

贡献

我们非常欢迎贡献！请参阅贡献者指南，了解如何运行和测试代码。

自上次发布以来的新变化？

请查看发布历史

使用 Claudia bot Builder 打造的酷炫项目

• AWS Bot for Slack - 一个 Slack 机器人，用于停止和启动指定的 AWS EC2 实例，并总体监控你的 AWS 资产。
• Comic Book Bot - 一个简单的 Viber 聊天机器人，提供漫威角色的相关信息。
• DotCom Bot - 在 Slack 和 Facebook Messenger 上快速搜索并购买域名，同时检查用户名是否可用！
• Eksplorer - 一个 Facebook 聊天机器人，帮助你发现周边的精彩事物。
• Fact Bot - 这个机器人会查询 WikiData，为你提供任何输入内容的事实信息。
• Food Recommendation Bot - 基于 Google Places API，向你展示附近的营业餐厅。
• JS Belgrade bot - 在一次 meetup 活动中创建的简单 Telegram 讨论组聊天机器人。
• LaptopFriendly Bot - 为 LaptopFriendly.co 开发的 Viber 机器人。
• MrRoadboto - 一款低带宽、易用的 Facebook 聊天机器人，用于发布科罗拉多州交通部 (CDOT) 关于 I70 高速公路关闭的通知，该路段影响多个主要滑雪胜地。你可以在此处了解开发动机：这里。
• PingdomBot - 一个 Slack 机器人，用于查看 Pingdom 网站监控的状态。
• Pokemon Lookup bot - 一个简单的宝可梦查询机器人，源代码。
• QRCode Bot - 一个艺术感十足的二维码生成器，源代码。
• Quote bot - 一个非常简单的机器人，会从 Forismatic API 获取一句励志名言并回复给你。
• Robbert - 一个通用聊天机器人。
• slackslash-radar - 一个 Claudiajs 机器人，用于获取 Wunderground 的雷达动画 GIF 并发布到 Slack。
• Space Explorer Bot - 一个简单的 Messenger 聊天机器人，利用 NASA 的 API 获取太空相关的数据和图片。
• Space Explorer Bot for Viber - Space Explorer Bot 的 Viber 版本。
• Vacation tracker bot - 一个简单的 Slack 机器人，帮助你管理团队成员的假期、病假和休息日。
• MDNBot - 一个 Slack 机器人，让开发者无需离开 Slack 频道即可搜索 MDN 文档。
• Ver.bot - 订阅 GitHub、npm、PyPI 项目，及时获取新版本发布通知！

使用 Claudia Bot Builder 打造了什么酷炫项目吗？欢迎告诉我们，或提交 PR 来更新此列表！

作者

• Gojko Adžić
• Aleksandar Simović
• Slobodan Stojanović

许可证

MIT -- 参见 LICENSE

Claudia Bot Builder 快速上手指南

Claudia Bot Builder 帮助开发者在几分钟内将聊天机器人创建并部署到 AWS Lambda。它支持 Facebook Messenger、Slack、Telegram 等多个平台，自动处理消息解析和响应格式化，让你专注于业务逻辑而非基础设施代码。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统: macOS, Linux 或 Windows (需配置 Node.js 环境)
• Node.js: 建议安装 LTS 版本 (v14 或更高)
• AWS 账号: 需要拥有有效的 AWS 账号
• AWS CLI: 已安装并配置好凭证 (aws configure)
  • 确保配置的账号具有创建 Lambda 函数和 API Gateway 的权限
• Claudia.js: 全局安装 Claudia 命令行工具

国内加速建议： 如果你在中国大陆，建议使用淘宝镜像源加速 npm 包的安装：

npm config set registry https://registry.npmmirror.com

安装步骤

1. 初始化新项目 创建一个新目录并初始化 npm 项目：

   mkdir my-chatbot
   cd my-chatbot
   npm init -y
   

2. 安装依赖 安装 claudia 和 claudia-bot-builder：

   npm install claudia claudia-bot-builder
   

3. 验证 AWS 配置 确保 AWS CLI 已正确配置（如果未配置，运行 aws configure）：

   aws sts get-caller-identity
   

基本使用

以下是一个最简单的示例，展示如何创建一个能回复任意消息的机器人。

1. 创建入口文件 在项目根目录下创建 bot.js 文件，并填入以下代码：

   const botBuilder = require('claudia-bot-builder');
   const excuse = require('huh'); // 用于生成随机借口的小库
   
   module.exports = botBuilder(function (message) {
     return 'Thanks for sending ' + message.text +
       '. Your message is very important to us, but ' +
       excuse.get();
   });
   

   (注：如果需要 huh 库，请运行 npm install huh)

2. 部署到 AWS 使用 Claudia 命令行工具将机器人部署到 AWS Lambda。首次部署时，Claudia 会自动创建 Lambda 函数、API Gateway 以及对应的 Webhook 配置。

   npx claudia create --region us-east-1 --api-module bot
   

   注意：请将 --region 替换为你希望的 AWS 区域（例如 ap-northeast-1）。

3. 启用平台支持 部署成功后，根据你的目标平台运行相应的设置命令。例如，若要启用 Facebook Messenger 支持：

   npx claudia enable-facebook-messenger-bot
   

   (系统会引导你输入 Facebook Page ID 和 Token 等信息)

   若需启用 Slack：

   npx claudia enable-slack-slash-command
   

4. 测试机器人 部署完成后，通过你配置的平台（如 Facebook Messenger 或 Slack）发送消息，即可看到机器人的自动回复。

   提示：Claudia Bot Builder 会自动将不同平台的传入消息解析为统一格式（如示例中的 message.text），并将你的返回字符串自动包装成对应平台所需的消息模板。