Azure Functions Host 开发环境搭建与贡献指南

Azure Functions Host 开发环境搭建与贡献指南

azure-functions-host The host/runtime that powers Azure Functions 项目地址: https://gitcode.com/gh_mirrors/az/azure-functions-host

项目背景

Azure Functions Host 是微软 Azure Functions 服务的核心运行时组件，负责处理函数触发、绑定执行、扩展管理等功能。当前项目正在进行 v2 版本的架构重构，主要方向是将运行时迁移到 .NET Core 平台，并将各语言支持拆分为独立仓库。

开发环境准备

操作系统要求

• 推荐配置：Windows 10 系统
• 可选配置：macOS/Linux（目前支持度有限）
  • 注意：在非 Windows 系统上开发时，部分单元测试可能无法通过

开发工具链

1. 语言运行时：

   • Java 8（需同时安装 JDK 和 JRE）
   • Node.js 8.4 或更高版本
   • .NET Core 2.2 SDK

2. 开发工具：

   • 推荐使用 Visual Studio 2019
   • 也可使用 VS Code（但测试运行可能存在问题）

3. 辅助工具：

   • Git 版本控制工具
   • Node 版本管理工具（如 nvm/nvm-windows）
   • 终端增强工具（如 ConEmu/iTerm）
   • Azure Functions Core Tools（用于创建示例项目）

本地运行配置（Visual Studio）

基础配置步骤

1. 设置 WebJobs.Script.WebHost 为启动项目

2. 将调试配置改为 "WebJobs.Script.WebHost.Core"

3. 添加 AzureWebJobsScriptRoot 环境变量，指向测试项目目录

   • 可通过以下方式添加：
     • 全局环境变量（需重启VS）
     • 项目 appsettings.json 文件（注意不要提交）
     • 项目调试配置中的环境变量（注意不要提交）

4. 使用 Core Tools 创建测试函数：

   func init
   func new -l javascript -t httptrigger -n hello
   

5. 启动调试，访问 /api/hello 端点验证功能

非HTTP触发器配置

如需测试非HTTP触发器，需要额外配置：

• AzureWebJobsStorage：Azure存储账户连接字符串
• AzureWebJobsDashboard：Azure存储账户连接字符串
• 其他服务特定的连接设置

测试环境配置

项目包含两个主要测试工程：

1. WebJobs.Script.Tests：单元测试
2. WebJobs.Script.Test.Integration：集成测试

集成测试准备

1. 为集成测试项目配置存储账户：

   • 设置 AzureWebJobsStorage 和 AzureWebJobsDashboard
   • 推荐使用 appsettings.json 方式配置
   • 确保设置 "CopyToOutput" 为 true 并重新生成项目

2. 通过测试资源管理器运行所有测试

开发工作流程

代码修改流程

1. 创建特性分支（基于 dev 分支）
2. 实现功能修改
3. 本地测试验证
4. 推送变更到个人仓库
5. 创建 Pull Request 到 dev 分支
6. 根据反馈进行修改
7. 使用交互式变基整理提交记录
8. 等待合并（无直接提交权限时）

测试要求

所有变更必须通过现有测试套件，包括：

• 单元测试
• 集成测试
• 端到端测试（如适用）

技术注意事项

1. 架构变化：v2 版本正在将语言支持拆分为独立仓库
2. Azure 依赖：完整测试需要 Azure 资源支持
3. 跨平台支持：当前 Linux/macOS 支持仍在完善中
4. 多语言测试：当前需要 Java 和 Node.js 环境，未来计划解耦

常见问题处理

1. 测试失败：首先检查存储账户配置是否正确
2. 环境问题：确保所有运行时版本符合要求
3. 调试问题：验证 AzureWebJobsScriptRoot 路径是否正确

通过本文介绍的环境配置和开发流程，开发者可以顺利参与 Azure Functions Host 项目的开发和测试工作。建议在开始实质开发前，先确保基础环境配置正确并通过所有测试。

azure-functions-host The host/runtime that powers Azure Functions 项目地址: https://gitcode.com/gh_mirrors/az/azure-functions-host