在本地对 Azure Functions 进行编码和测试

应尽可能在本地开发环境中创建和验证 Azure Functions 代码项目。 Azure Functions Core Tools 提供 Azure Functions 的本地运行时版本，该版本与用于集成开发、调试和部署的常用开发工具集成。 本地函数甚至可以连接到实时 Azure 服务。

本文提供有关本地开发的一些通用指南，例如使用 local.settings.json 文件。 它还链接到特定于开发环境的指南。

本地开发环境

在本地计算机开发函数的方式取决于语言和工具偏好。 请确保选择 文章顶部的首选语言。

可以使用这些开发环境以首选语言在本地编写函数代码：

其中每个本地开发环境允许创建函数应用项目，并使用预定义的函数模板创建新函数。 每个环境使用 Core Tools，使你能够在自己的计算机上针对实际的 Functions 运行时测试和调试函数，就像对其他任何应用执行此操作一样。 还可以将函数应用项目从其中的任何环境发布到 Azure。

本地项目文件

不管语言如何，Functions 项目目录都在项目根文件夹中包含以下文件：

项目中的其他文件取决于语言和具体函数。 有关详细信息，请参阅相应语言的开发人员指南。

本地设置文件

该文件 local.settings.json 存储本地开发工具使用的应用设置和设置。 仅当在本地运行项目时，才会使用 local.settings.json 文件中的设置。 将项目发布到 Azure 时，请务必将任何必需的设置添加到函数应用的应用设置。

该文件 local.settings.json 具有以下结构：

{
  "IsEncrypted": false,
  "Values": {
    "FUNCTIONS_WORKER_RUNTIME": "<language worker>",
    "AzureWebJobsStorage": "<connection-string>",
    "MyBindingConnection": "<binding-connection-string>",
    "AzureWebJobs.HttpExample.Disabled": "true"
  },
  "Host": {
    "LocalHttpPort": 7071,
    "CORS": "*",
    "CORSCredentials": false
  },
  "ConnectionStrings": {
    "SQLConnectionString": "<sqlclient-connection-string>"
  }
}

在本地运行项目时，支持这些设置：

在本地运行时，以下应用程序设置可包括在 Values 数组中：

同步设置

在本地开发函数时，应用所需的任何本地设置也必须存在于部署了代码的函数应用的应用设置中。 可能还需要将当前设置从函数应用下载到本地项目。 虽然可以在 Azure 门户中手动配置应用设置，但也可以使用以下工具将应用设置与项目中的本地设置同步：

• Visual Studio Code
• Visual Studio
• Azure Functions Core Tools

触发器和绑定

在本地开发函数时，你需要考虑触发器和绑定行为。 对于 HTTP 触发器，您可以在本地计算机上调用 HTTP 终结点，使用 http://localhost/。 对于非 HTTP 触发的函数，有几个在本地运行的选项：

• 在本地开发过程中对绑定进行测试的最简单方法是，使用面向实时 Azure 服务的连接字符串。 可以通过在 local.settings.json 文件中的 Values 数组中添加相应的连接字符串设置来将实时服务设置为目标。 执行此操作时，测试期间的本地执行可能会影响你的生产服务。 相反，请考虑设置单独的服务，在开发和测试期间使用，然后在生产期间切换到不同的服务。
• 对于基于存储的触发器，可以使用本地存储仿真器。
• 可以使用特殊的管理员终结点手动运行非 HTTP 触发器函数。 有关详细信息，请参阅 手动运行非 HTTP 触发的函数。

在本地测试期间，必须在本地运行 Core Tools (func.exe) 提供的主机。 有关详细信息，请参阅 Azure Functions Core Tools。

HTTP 测试工具

在开发过程中，当 Web 浏览器支持 HTTP GET 方法时，可以轻松地从 Web 浏览器调用任何函数终结点。 但是，对于支持有效负载的其他 HTTP 方法（例如 POST 或 PUT），需要使用 HTTP 测试工具来创建这些 HTTP 请求并将其发送到函数终结点。

可以选择离线或本地运行的 HTTP 测试工具，它不会将您的数据同步到云端，也不要求登录在线帐户，从而确保数据安全。 某些工具还可以通过实施特定的安全功能来保护数据免受意外泄露。

避免使用集中存储 HTTP 请求历史记录（包括敏感信息）的工具，这些工具不遵循最佳做法，也不尊重数据隐私安全。

请考虑使用以下工具之一，安全地将 HTTP 请求发送到函数终结点：

• Visual Studio Code，具有来自 Visual Studio Marketplace 的扩展，例如 REST Client
• PowerShell Invoke-RestMethod
• Microsoft Edge - 网络控制台工具
• Bruno
• curl

本地存储仿真器

在本地开发期间，当使用 Azure 存储绑定（队列存储、Blob 存储和表存储）测试函数时，你可以使用本地 Azurite 仿真器，而无需连接到远程存储服务。 Azurite 与 Visual Studio Code 和 Visual Studio 集成，你还可以使用 npm 从命令提示符运行它。 有关详细信息，请参阅使用 Azurite 模拟器进行本地 Azure 存储开发。

local.settings.json 文件的 Values 集合中的以下设置指示本地 Functions 主机使用 Azurite 建立默认 AzureWebJobsStorage 连接：

"AzureWebJobsStorage": "UseDevelopmentStorage=true"

通过此设置值，使用 AzureWebJobsStorage 作为其连接的任何 Azure 存储触发器或绑定在本地运行时都会连接到 Azurite。 在本地执行期间使用存储仿真时，请牢记以下注意事项：

• 必须安装并运行 Azurite。
• 在发布到 Azure 之前，应使用与 Azure 服务的实际存储连接进行测试。
• 发布项目时，请勿将 AzureWebJobsStorage 设置发布为 UseDevelopmentStorage=true。 在 Azure 中，AzureWebJobsStorage 设置必须始终是函数应用使用的存储帐户的连接字符串。 有关详细信息，请参阅 AzureWebJobsStorage。

相关文章

• 若要详细了解如何在 Mac、Linux 或 Windows 计算机上使用 Visual Studio Code 本地开发函数，请参阅 使用 Visual Studio Code 开发 Azure Functions。
• 若要详细了解如何通过命令提示符或终端开发函数，请参阅使用 Azure Functions Core Tools。