使用 Bot Framework SDK 创建机器人

• .NET 6.0 SDK
• Bot Framework Emulator
• 了解 ASP.NET Core 和 C# 中的异步编程

C# 模版

当前机器人示例使用 .NET Core 3.1 模板。

• Java 1.8 或更高版本
• Bot Framework Emulator
• Visual Studio Code 或你喜欢用的 IDE（如果要编辑机器人代码）。
• 安装 Maven
• 安装 node.js 12.10 或更高版本。
• 一个 Azure 帐户（如果要部署到 Azure）。

Java 模板

使用 Yeoman 生成器，利用 Bot Framework v4 中的核心 AI 功能快速创建会话式 AI 机器人。 有关详细信息，请参阅 yeoman.io。

生成器支持三种不同的模板选项，如下所示。

安装 Yeoman

1. 确保已安装 12.10 node.js 12.10 或更高版本。

2. 安装最新的 npm。

   npm install -g npm
   

3. 安装 Yeoman。 请确保全局安装。

   npm install -g yo
   

4. 安装 generator-botbuilder-java。 请确保全局安装。

   npm install -g generator-botbuilder-java
   

5. 验证 Yeoman 和 generator-botbuilder-java 是否正确安装。

   yo botbuilder-java --help
   

• Node.js
• Bot Framework Emulator
• 了解 restify 和 JavaScript 中的异步编程
• Visual Studio Code 或你喜欢用的 IDE（如果要编辑机器人代码）。

JavaScript 和 TypeScript 模板

要为 Bot Framework v4 安装 Yeoman 和 Yeoman 生成器，请执行以下操作：

1. 打开终端或权限提升的命令提示符。

2. 切换到 JavaScript 机器人的目录。 如果还没有目录，请先创建它。

   mkdir myJsBots
   cd myJsBots
   

3. 确保你拥有最新版本的 npm 和 Yeoman。

   npm install -g npm
   npm install -g yo
   

4. 安装 Yeoman 生成器。 Yeoman 是用于创建应用程序的工具。 有关详细信息，请参阅 yeoman.io。

   npm install -g generator-botbuilder
   

   注意

   仅当使用 Windows 作为开发操作系统时，才需要安装下面列出的 Windows 生成工具。 对某些安装，restify 安装步骤将显示与 node-gyp 相关的错误。 如果存在这种情况，可以尝试使用提升的权限运行此命令。 如果系统上已安装 Python，此调用也可能会挂起而不会退出：

   仅当你在 Windows 上时运行此命令。

   npm install -g windows-build-tools
   

• Python 3.8.3
• Bot Framework Emulator
• 了解通过 Python 进行的异步编程

创建和启用虚拟环境

虚拟环境是特定 Python 解释器和区别于全局设置的库的组合。 虚拟环境特定于项目，但保留在项目文件夹中。 使用虚拟环境的一项优势是，随着项目的开发，虚拟环境始终反映出项目的确切依赖项。 若要了解有关虚拟环境的详细信息，请参阅创建虚拟环境。

导航到要在其中创建机器人的目录。 然后针对首选平台运行以下命令。 激活虚拟环境后，命令行/终端应以 (venv) 开头。 这让你了解虚拟环境处于活动状态。 可以通过键入 deactivate 随时停用虚拟环境。

macOS/Linux

python3 -m venv venv
source venv/bin/activate

Windows

python -m venv venv
venv\Scripts\activate.bat

Python 模板

运行以下 pip install 命令来安装需要的包：

pip install botbuilder-core
pip install asyncio
pip install aiohttp
pip install cookiecutter==1.7.0

得益于该模板，项目包含在此快速入门中创建机器人所需的所有代码。 无需任何其他代码即可测试机器人。

运行以下命令以通过模板创建回显机器人。 该命令对其参数使用默认选项。

yo botbuilder-java -T "echo"

Yeoman 会提示你输入用来创建机器人的一些信息。 对于本教程，请使用默认值。

? What's the name of your bot? (echo)
? What's the fully qualified package name of your bot? (com.mycompany.echo)
? Which template would you like to start with? (Use arrow keys) Select "Echo Bot"
? Looking good.  Shall I go ahead and create your new bot? (Y/n) Enter "y"

生成器支持许多命令行选项，这些选项可用于更改生成器的默认值或预先设定提示。 选项区分大小写。

得益于该模板，项目包含在此快速入门中创建机器人所需的所有代码。 无需任何其他代码即可测试机器人。

1. 使用生成器创建回显机器人。

   yo botbuilder
   

   Yeoman 会提示你输入用来创建机器人的一些信息。 对于本教程，请使用默认值。

   ? What's the name of your bot? my-chat-bot
   ? What will your bot do? Demonstrate the core capabilities of the Microsoft Bot Framework
   ? What programming language do you want to use? JavaScript
   ? Which template would you like to start with? Echo Bot - https://aka.ms/bot-template-echo
   ? Looking good.  Shall I go ahead and create your new bot? Yes
   

得益于该模板，项目包含在此快速入门中创建机器人所需的所有代码。 无需任何其他代码即可测试机器人。

1. 从工作目录中，运行以下命令下载回显机器人模板及其依赖项：

   cookiecutter https://github.com/microsoft/BotBuilder-Samples/releases/download/Templates/echo.zip
   

2. 系统会提示你提供机器人的名称和描述。 输入以下值：

   • bot_name：echo_bot
   • bot_description：回显用户响应的机器人。

   

1. 从终端导航到保存机器人的目录，然后执行下面列出的命令。

2. 生成 Maven 项目并将其打包为 .jar 文件（存档）。

   mvn package
   

3. 在本地运行机器人。 将 archive-name 替换为上一命令中的实际名称。

   java -jar .\target\<archive-name>.jar
   

现在，你已准备好启动模拟器。

在终端或命令提示符中，将目录切换到为机器人创建的目录，并使用 npm start 启动机器人。

cd my-chat-bot
npm start

此时，机器人正在本地端口 3978 上运行。

1. 从命令行/终端将目录切换到 echo_bot。

   cd echo_bot
   

2. 安装回显机器人模板的依赖项。

   pip install -r requirements.txt 
   

3. 安装依赖项后，运行以下命令以启动机器人：

   python app.py
   

   如果看到以下屏幕截图中显示的最后一行，则表示机器人已准备就绪，可以开始进行测试：

   

4. 复制最后一行中的 http 地址。 使用 Emulator 与机器人交互时，需要用到它。