如何为Azure Functions TimerTrigger的CRON表达式设置默认值？

我有一个Azure Functions Timer作业，本地开发时从local.settings.json获取CRON表达式，生产环境则从Function App的应用设置中获取，代码如下：

public static void MyTimerJob([TimerTrigger("%MyTimerCRON%")] TimerInfo Timer, ILogger Log) {    
    // Function code 
}

我希望在部署环境的应用设置未配置MyTimerCRON时为其设置默认值，于是按照微软文档指导添加自定义配置源：

1. 在ConfigureAppConfiguration中添加配置提供程序：

public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
{
    FunctionsHostBuilderContext context = builder.GetContext();

    builder.ConfigurationBuilder
        .AddJsonFile(Path.Combine(context.ApplicationRootPath, "appsettings.json"), optional: true, reloadOnChange: false)
        .AddEnvironmentVariables();
}

2. 在.csproj中配置将appsettings.json复制到输出目录：

<None Update="appsettings.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>      
</None>

3. 添加appsettings.json文件并设置默认值：

{
    "MyTimerCRON": "* * * * *",
}

但运行应用时出现以下警告：

[2024-11-06T18:33:25.565Z] The Functions scale controller may not scale the following functions correctly because some configuration values were modified in an external startup class.
[2024-11-06T18:33:25.566Z]   Function 'MyTimerJob' uses the modified key(s): %MyTimerCRON%

且虽然Timer作业能执行，但调用Environment.GetEnvironmentVariable("MyTimerCRON")返回null，请问正确的默认值设置方式是什么？

方法1：直接在TimerTrigger属性中指定默认值（推荐） #

Azure Functions支持在配置占位符中直接定义默认值，格式为%配置键:默认值%，无需修改配置源即可实现需求：

public static void MyTimerJob([TimerTrigger("%MyTimerCRON:* * * * *%")] TimerInfo Timer, ILogger Log) {    
    // Function code 
}

这种方式不会触发缩放控制器警告，同时遵循优先级规则：本地local.settings.json或生产环境应用设置中的值会覆盖默认值，未配置时自动使用占位符后的默认表达式。

方法2：通过依赖注入读取配置（复杂场景适用） #

如果需要在函数代码中主动读取配置值，不要使用Environment.GetEnvironmentVariable，而是通过依赖注入获取IConfiguration实例：

1. 将静态函数改为非静态类，注入IConfiguration：

public class MyTimerFunction
{
    private readonly IConfiguration _configuration;

    public MyTimerFunction(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    [FunctionName("MyTimerJob")]
    public void Run([TimerTrigger("%MyTimerCRON:* * * * *%")] TimerInfo timer, ILogger log)
    {
        // 读取配置，默认值会生效
        string cronExpression = _configuration["MyTimerCRON"] ?? "* * * * *";
        log.LogInformation($"当前CRON表达式：{cronExpression}");
        // Function code
    }
}

2. 若必须使用自定义配置源（如多环境配置），需保证配置源顺序正确，且不覆盖默认环境变量优先级：

public override void ConfigureAppConfiguration(IFunctionsConfigurationBuilder builder)
{
    FunctionsHostBuilderContext context = builder.GetContext();

    builder.ConfigurationBuilder
        .AddJsonFile(Path.Combine(context.ApplicationRootPath, "appsettings.json"), optional: true, reloadOnChange: false)
        // 确保环境变量优先级高于自定义JSON，符合Azure Functions默认逻辑
        .AddEnvironmentVariables();
}

注意：这种方式仍可能触发缩放控制器警告，因此优先选择方法1。

关键注意事项 #

• Environment.GetEnvironmentVariable无法读取自定义配置源中的值，因为Azure Functions的配置系统基于IConfiguration构建，自定义配置源内容不会同步到系统环境变量，必须通过IConfiguration读取。
• 修改配置源会干扰Azure Functions缩放控制器的逻辑，控制器依赖默认配置系统获取触发器配置，因此尽量避免自定义配置源。

内容的提问来源于stack exchange，提问作者Francisco Teotônio