Durable Functions 是 Azure Functions 的一个扩展,可用于在无服务器环境中编写有状态函数。 该扩展可用于管理状态、检查点和重启。
本文介绍了如何使用 Visual Studio Code Azure Functions 扩展在本地创建并测试“hello world”持久函数。 此函数将协调对其他函数的调用并将其链接在一起。 然后将函数代码发布到 Azure。
在 Azure 中运行持久函数
先决条件
为完成此教程:
-
安装 Azure Functions VS Code 扩展。
-
请确保安装了最新版本的 Azure Functions Core Tools。
-
Durable Functions 需要一个 Azure 存储帐户。 需要一个 Azure 订阅。
-
确保已安装 Python 版本 3.6、3.7 或 3.8。
如果还没有 Azure 订阅,可以在开始前创建一个免费帐户。
创建本地项目
在本部分,你将使用 Visual Studio Code 创建一个本地 Azure Functions 项目。
-
在 Visual Studio Code 中,按 F1(或 <kbd>Ctrl/Cmd+Shift+P</kbd>)打开命令面板。 在命令面板中,搜索并选择
Azure Functions: Create New Project...。创建函数
-
为项目选择一个空文件夹位置,然后选择“选择”。
-
按照提示提供以下信息:
Prompt 值 说明 选择函数应用项目的语言 Python 创建本地 Python Functions 项目。 选择版本 Azure Functions v3 仅当尚未安装 Core Tools 时,才会出现此选项。 在本例中,当你首次运行应用时即已安装 Core Tools。 Python 版本 Python 3.6、3.7 或 3.8 VS Code 将使用所选版本创建虚拟环境。 为项目的第一个函数选择模板 暂时跳过 选择打开项目的方式 在当前窗口中打开 在所选的文件夹中重新打开 VS Code。
Visual Studio Code 会根据需要安装 Azure Functions Core Tools。 它还会在某个文件夹中创建一个函数应用项目。 此项目包含 host.json 和 local.settings.json 配置文件。
此外,还会在根文件夹中创建 requirements.txt 文件。 它指定运行函数应用所需的 Python 包。
更新 Azure Functions 扩展捆绑包版本
Python Azure Functions 需要版本 2.x 的 Azure Functions 扩展捆绑包。 扩展捆绑包是在 host.json 中配置的。
-
在项目中打开 host.json。 将扩展捆绑包
version扩展为[2.*, 3.0.0)。 这将指定一个大于等于 2.0 且小于 3.0 的版本范围。"extensionBundle": { "id": "Microsoft.Azure.Functions.ExtensionBundle", "version": "[2.*, 3.0.0)" } -
必须重新加载 VS Code,然后更新的扩展捆绑包版本才会反映出来。 在命令面板中,搜索“开发人员: 重载窗口”命令并运行它。
从 PyPI 安装 azure-functions-durable
创建项目时,Azure Functions VS Code 扩展会自动使用所选的 Python 版本创建虚拟环境。 你将在终端中激活该虚拟环境,并安装 Azure Functions 和 Durable Functions 所需的某些依赖项。
-
在编辑器中打开 requirements.txt,并更改其内容,如下所示:
azure-functions azure-functions-durable>=1.0.0b12 -
打开当前文件夹中编辑器的集成终端 (<kbd>Ctrl+Shift+`</kbd>)。
-
在集成终端中,激活当前文件夹中的虚拟环境:
Linux 或 macOS
source .venv/bin/activateWindows
.venv\scripts\activate激活虚拟环境
-
在已激活虚拟环境的集成终端中,使用 pip 安装之前定义的包:
python -m pip install -r requirements.txt
创建自己的函数
基本的 Durable Functions 应用包含三个函数:
- 业务流程协调程序函数 - 描述用于协调其他函数的工作流。
- 活动函数 - 由业务流程协调程序函数调用,它会执行工作并选择性地返回一个值。
- 客户端函数 - 用于启动业务流程协调程序函数的常规 Azure 函数。 本示例使用 HTTP 触发的函数。
业务流程协调程序函数
你将使用一个模板在项目中创建持久函数代码。
-
在命令面板中,搜索并选择
Azure Functions: Create Function...。 -
按照提示提供以下信息:
Prompt 值 说明 选择函数的模板 Durable Functions 业务流程协调程序 创建 Durable Functions 业务流程 提供函数名称 HelloOrchestrator 持久函数的名称
现已添加一个业务流程协调程序来协调活动函数。 打开 HelloOrchestrator/__init__.py 查看业务流程协调程序函数。 每次调用 context.call_activity 都会调用名为 Hello 的活动函数。
接下来,添加引用的 Hello 活动函数。
活动函数
-
在命令面板中,搜索并选择
Azure Functions: Create Function...。 -
按照提示提供以下信息:
Prompt 值 说明 选择函数的模板 Durable Functions 活动 创建活动函数 提供函数名称 你好 活动函数的名称
现已添加业务流程协调程序调用的 Hello 活动函数。 打开 Hello/__init__.py,可以看到,该函数采用某个名称作为输入,并返回一句问候语。 将在活动函数中执行操作,例如,发出数据库调用或执行计算。
最后,添加一个启动业务流程的 HTTP 触发的函数。
客户端函数(HTTP 启动器)
-
在命令面板中,搜索并选择
Azure Functions: Create Function...。 -
按照提示提供以下信息:
Prompt 值 说明 选择函数的模板 Durable Functions HTTP 启动器 创建 HTTP 启动器函数 提供函数名称 DurableFunctionsHttpStart 活动函数的名称 授权级别 匿名 出于演示目的,请允许在不进行身份验证的情况下调用函数
现已添加一个启动业务流程的 HTTP 触发的函数。 打开 DurableFunctionsHttpStart/__init__.py,可以看到,该函数使用 client.start_new 启动新的业务流程。 然后,它使用 client.create_check_status_response 返回 HTTP 响应,其中包含可用于监视和管理新业务流程的 URL。
现已创建一个可在本地运行并可部署到 Azure 的 Durable Functions 应用。
在本地测试函数
使用 Azure Functions Core Tools 可以在本地开发计算机上运行 Azure Functions 项目。 首次从 Visual Studio Code 启动某个函数时,系统会提示你安装这些工具(若尚未安装)。
-
若要测试函数,请在
Hello活动函数代码 (Hello/__init__.py) 中设置断点。 按 F5 或者在命令面板中选择Debug: Start Debugging以启动函数应用项目。 来自 Core Tools 的输出会显示在“终端” 面板中。NOTE 有关调试的详细信息,请参阅 Durable Functions 诊断。
-
Durable Functions 需要一个 Azure 存储帐户才能运行。 当 VS Code 提示选择存储帐户时,请选择“选择存储帐户”。
创建存储帐户
-
按照提示提供以下信息,以在 Azure 中创建新的存储帐户。
Prompt 值 说明 选择订阅 订阅的名称 选择 Azure 订阅 选择存储帐户 新建存储帐户 输入新存储帐户的名称 唯一名称 要创建的存储帐户的名称 选择资源组 唯一名称 要创建的资源组名称 选择位置 region 选择离你较近的区域 -
在“终端” 面板中,复制 HTTP 触发的函数的 URL 终结点。
Azure 本地输出
-
使用浏览器或者 Postman 或 cURL 之类的工具向 URL 终结点发送一个 HTTP 请求。 将最后一个段替换为业务流程协调程序函数的名称 (
HelloOrchestrator)。 URL 应类似于http://localhost:7071/api/orchestrators/HelloOrchestrator。响应是来自 HTTP 函数的初始结果,告知持久业务流程已成功启动。 它还不是业务流程的最终结果。 响应中包括了几个有用的 URL。 现在,让我们查询业务流程的状态。
-
复制
statusQueryGetUri的 URL 值,将其粘贴到浏览器的地址栏中并执行请求。 或者也可以继续使用 Postman 发出 GET 请求。请求将查询业务流程实例的状态。 你应该会得到一个最终响应,它显示实例已经完成,并包含持久函数的输出或结果。 输出如下所示:
{ "name": "HelloOrchestrator", "instanceId": "9a528a9e926f4b46b7d3deaa134b7e8a", "runtimeStatus": "Completed", "input": null, "customStatus": null, "output": [ "Hello Tokyo!", "Hello Seattle!", "Hello London!" ], "createdTime": "2020-03-18T21:54:49Z", "lastUpdatedTime": "2020-03-18T21:54:54Z" } -
若要停止调试,请在 VS Code 中按 <kbd>Shift+F5</kbd>。
确认该函数可以在本地计算机上正确运行以后,即可将项目发布到 Azure。
登录 Azure
在发布应用之前,必须先登录到 Azure。
-
如果你尚未登录,请在活动栏中选择“Azure”图标,然后在“Azure: 函数”区域中,选择“登录到 Azure...”。如果没有帐户,可以创建一个免费 Azure 帐户。 学生可以创建一个免费的面向学生的 Azure 帐户。
在 VS Code 中登录到 Azure
如果已登录,请转到下一部分。
-
在浏览器中出现提示时,请选择你的 Azure 帐户,并使用你的 Azure 帐户凭据登录。
-
成功登录后,可以关闭新浏览器窗口。 属于你的 Azure 帐户的订阅显示在边栏中。
将项目发布到 Azure
在本部分,你将在 Azure 订阅中创建一个函数应用和相关资源,然后部署代码。
Important: 发布到现有函数应用将覆盖该应用在 Azure 中的内容。
-
在活动栏中选择“Azure”图标,然后在“Azure:函数”区域中,选择“部署到函数应用...”按钮。
将项目发布到 Azure
-
根据提示提供以下信息:
-
选择文件夹:从工作区中选择一个文件夹,或浏览到包含函数应用的文件夹。 如果已打开有效的函数应用,则不会看到此信息。
-
选择订阅:选择要使用的订阅。 如果只有一个订阅,则不会看到此项。
-
在 Azure 中选择函数应用:选择
- Create new Function App。 (请不要选择本文中未介绍的Advanced选项。) -
输入函数应用的全局唯一名称:键入在 URL 路径中有效的名称。 将对你键入的名称进行验证,以确保其在 Azure Functions 中是唯一的。
-
选择新资源的位置:为了获得更好的性能,请选择你附近的 区域。
在 Azure 中创建单个资源时,扩展会在通知区域显示这些资源的状态。
-
-
完成后,将使用基于函数应用名称的名称在订阅中创建以下 Azure 资源:
-
一个资源组:相关资源的逻辑容器。
-
一个标准 Azure 存储帐户:用于维护项目的状态和其他信息。
-
一个消耗计划:用于定义无服务器函数应用的基础主机。
-
一个函数应用:提供用于执行函数代码的环境。 可以通过函数应用将函数分组为逻辑单元,以便在同一托管计划中更轻松地管理、部署和共享资源。
-
一个连接到函数应用的 Application Insights 实例:用于跟踪无服务器函数的使用情况。
创建函数应用并应用了部署包之后,会显示一个通知。
Tip: 默认情况下,会根据你提供的函数应用名称创建函数应用所需的 Azure 资源。 默认情况下,还会在函数应用所在的新资源组中创建这些资源。 如果要自定义这些资源的名称或重复使用现有资源,则需要使用高级创建选项来发布项目。
-
在此通知中选择“查看输出”以查看创建和部署结果,其中包括你创建的 Azure 资源。 如果错过了通知,请选择右下角的响铃图标以再次查看。
创建完成通知
在 Azure 中测试函数
-
从“输出” 面板复制 HTTP 触发器的 URL。 调用 HTTP 触发的函数的 URL 应采用此格式:
http://<functionappname>.azurewebsites.net/orchestrators/HelloOrchestrator -
将 HTTP 请求的这个新 URL 粘贴到浏览器的地址栏中。 你应当会得到与之前使用已发布的应用时相同的状态响应。
后续步骤
你已使用 Visual Studio Code 创建并发布了一个 Python 持久函数应用。
历史资料。此文对应 2022-08-12 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 anthonychu)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体、发布器占位标签和导航标记。
