在本地编写代码并测试Azure Functions

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

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

本地开发环境

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

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

其中每个本地开发环境允许创建函数应用项目，并使用预定义的函数模板创建新函数。 每个环境都会使用 Core Tools，以便可以在自己的计算机上针对真实的 Functions 运行时进行测试和调试，就像您测试任何其他应用程序一样。 您还可以从任意环境将函数应用项目发布到 Azure。

本地项目文件

Functions 项目目录中包含项目根文件夹中的以下文件，无论使用何种语言：

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

本地设置文件

该文件 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 portal中手动配置应用设置，但以下工具还允许你在项目中将应用设置与本地设置同步：

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

触发器和绑定

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

• 可以使用以实时Azure服务为目标的连接字符串在本地开发期间测试绑定。 在 local.settings.json 文件中的 Values 数组中添加适当的 connection string 设置。 执行此操作时，测试期间的本地执行可能会影响你的生产服务。 相反，请考虑设置单独的实时服务，在开发和测试期间使用，然后在生产期间切换到不同的服务。
• 对于基于存储的触发器，请使用本地存储模拟器。
• 使用特殊管理员终结点手动运行非 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 的.http 文件扩展名，例如 REST Client
• Visual Studio支持从版本 17.8 开始的 .http 文件
• PowerShell Invoke-RestMethod
• Microsoft Edge - 网络控制台工具
• Bruno
• curl

本地存储模拟器

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

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

"AzureWebJobsStorage": "UseDevelopmentStorage=true"

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

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

相关文章

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