Azure Functions环境变量默认值注入的更优方案咨询

问题背景 #

我在Azure Function里通过%EVENT_HUB_NAME%的方式引用环境变量作为Event Hub的名称，代码示例如下：

public class BasicAzureFunction
{
    [FunctionName("BasicAzureFunction")]
    public async Task Run(
        [EventHubTrigger("%EVENT_HUB_NAME%", Connection = "EVENT_HUB_CONNECTION_STRING")] EventData events)
    {
        // TODO: 业务逻辑
    }
}

如果客户未在Azure控制台配置该环境变量，Function将无法正常加载。目前我通过Environment类实现了一个临时方案：

public class Startup : FunctionsStartup
{
    private const string EVENT_HUB_NAME_DEFAULT = "aas-modeldatachanged-evh";

    public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
    {
        if (Environment.GetEnvironmentVariable("EVENT_HUB_NAME") == null) {
            Environment.SetEnvironmentVariable("EVENT_HUB_NAME", EVENT_HUB_NAME_DEFAULT);
        }
    }
}

想请教有没有更优的方法注入默认值？之前尝试过Azure Functions依赖注入自定义配置源的相关方法，但没能正确实现变量注入。

优化方案 #

方案1：利用配置构建器添加内存兜底配置 #

直接向配置系统添加内存配置源，将默认值作为兜底项，系统会优先读取环境变量，不存在时自动使用默认值，无需修改环境变量本身：

public class Startup : FunctionsStartup
{
    private const string EVENT_HUB_NAME_DEFAULT = "aas-modeldatachanged-evh";

    public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
    {
        builder.ConfigurationBuilder
            // 添加内存默认配置
            .AddInMemoryCollection(new Dictionary<string, string>
            {
                { "EVENT_HUB_NAME", EVENT_HUB_NAME_DEFAULT }
            })
            // 环境变量优先级更高，放在后面覆盖默认值
            .AddEnvironmentVariables();
    }
}

方案2：绑定配置类并设置属性默认值 #

通过配置类+IOptions<T>注入的方式，在类属性上直接定义默认值，更符合依赖注入规范：

1. 定义配置类：

public class EventHubSettings
{
    // 直接设置属性默认值
    public string EventHubName { get; set; } = "aas-modeldatachanged-evh";
    public string EventHubConnectionString { get; set; }
}

2. 在Startup中注册配置：

public class Startup : FunctionsStartup
{
    public override void Configure(IFunctionsHostBuilder builder)
    {
        builder.Services.Configure<EventHubSettings>(builder.GetContext().Configuration);
    }
}

注：如果要保留特性中的%EVENT_HUB_NAME%绑定，结合方案1的配置源即可实现自动读取环境变量或默认值；若想通过配置类直接绑定，需使用IBinder进行动态解析，步骤稍复杂。

方案3：使用绑定表达式原生默认值语法（最简方案） #

如果默认值固定不变，直接在特性中使用Azure Functions绑定表达式的原生语法，格式为%变量名:默认值%，无需编写Startup代码：

[EventHubTrigger("%EVENT_HUB_NAME:aas-modeldatachanged-evh%", Connection = "EVENT_HUB_CONNECTION_STRING")]

环境变量存在时会使用配置值，不存在则自动启用冒号后的默认值。

总结 #

• 固定默认值场景优先选方案3，原生语法最省心；
• 需要灵活配置源时选方案1，通过配置构建器实现兜底逻辑；
• 项目已采用集中配置管理时选方案2，保持代码风格一致。

内容的提问来源于stack exchange，提问作者Oscar