Microsoft BotFramework-Hubot 项目教程

Microsoft BotFramework-Hubot 项目教程

BotFramework-HubotHubot adapter for botframework项目地址:https://gitcode.com/gh_mirrors/bo/BotFramework-Hubot

1. 项目的目录结构及介绍

BotFramework-Hubot/
├── bin/
│   └── hubot
├── docs/
│   └── README.md
├── scripts/
│   └── example.coffee
├── src/
│   └── botframework.coffee
├── test/
│   └── botframework_test.coffee
├── .gitignore
├── LICENSE
├── package.json
├── README.md
└── yarn.lock

目录结构介绍

• bin/: 包含启动脚本 hubot，用于启动 Hubot 实例。
• docs/: 包含项目的文档文件，如 README.md。
• scripts/: 包含示例脚本 example.coffee，用于展示如何编写 Hubot 脚本。
• src/: 包含核心代码文件 botframework.coffee，定义了 BotFramework 适配器的逻辑。
• test/: 包含测试文件 botframework_test.coffee，用于测试 BotFramework 适配器的功能。
• .gitignore: Git 忽略文件，定义了哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件。
• package.json: 项目的依赖管理文件，定义了项目的依赖包和脚本命令。
• README.md: 项目的说明文档，包含了项目的概述、安装和使用说明。
• yarn.lock: 锁定依赖包版本的文件，确保在不同环境下安装相同的依赖包版本。

2. 项目的启动文件介绍

bin/hubot

bin/hubot 是项目的启动脚本，用于启动 Hubot 实例。该脚本会加载项目的配置文件和脚本，并通过 BotFramework 适配器与外部服务进行通信。

启动命令

./bin/hubot -a botframework

启动文件介绍

• bin/hubot: 该脚本会读取环境变量和配置文件，初始化 Hubot 实例，并启动 BotFramework 适配器。
• -a botframework: 指定使用 BotFramework 适配器，确保 Hubot 能够通过 BotFramework 与外部服务进行通信。

3. 项目的配置文件介绍

package.json

package.json 是项目的依赖管理文件，定义了项目的依赖包和脚本命令。

{
  "name": "botframework-hubot",
  "version": "1.0.0",
  "description": "Hubot adapter for BotFramework",
  "main": "src/botframework.coffee",
  "scripts": {
    "start": "./bin/hubot -a botframework",
    "test": "mocha --compilers coffee:coffee-script/register"
  },
  "dependencies": {
    "hubot": "^3.3.2",
    "botbuilder": "^4.0.0"
  },
  "devDependencies": {
    "mocha": "^6.2.0",
    "coffee-script": "^1.12.7"
  }
}

配置文件介绍

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的描述。
• main: 项目的入口文件，通常是 src/botframework.coffee。
• scripts: 定义了项目的脚本命令，如 start 用于启动项目，test 用于运行测试。
• dependencies: 定义了项目运行时所需的依赖包，如 hubot 和 botbuilder。
• devDependencies: 定义了开发时所需的依赖包，如 mocha 和 coffee-script。

环境变量配置

为了使 Hubot 能够通过 BotFramework 适配器正常工作，需要配置以下环境变量：

• BOTBUILDER_APP_ID: 从 BotFramework 门户获取的 Bot 的 ID。
• BOTBUILDER_APP_PASSWORD: 从 BotFramework 门户获取的 Bot 的密码。
• BOTBUILDER_ENDPOINT: 可选，设置自定义的 HTTP 端点，默认是 /api/messages。
• HUBOT_TEAMS_ENABLE_AUTH: 可选，当设置为 true 时，限制发送命令给 Hubot 的用户范围。

配置示例

export BOTBUILDER_APP_ID="your-bot-app-id"
export BOTBUILDER_APP_PASSWORD="your-bot-app-password"
export BOTBUILDER_ENDPOINT="/api/messages"
export HUBOT_TEAMS_ENABLE_AUTH="true"

通过以上配置，Hubot 将能够通过 BotFramework 适配器与外部服务进行通信，并根据配置的环境变量进行相应的处理。

BotFramework-HubotHubot adapter for botframework项目地址:https://gitcode.com/gh_mirrors/bo/BotFramework-Hubot