Azure Function的watchFiles能否用于配置缓存？（C# .NET 6）

方案可行性 #

这个方案完全可以满足你的缓存需求，核心原因如下：

• Azure Functions的watchFiles特性会监控指定文件的变更，当文件更新时，函数主机会触发实例的配置重载，确保所有运行中的实例都能获取到最新配置
• 你的配置每日仅变更数次，低频率的文件更新不会因频繁重载影响函数性能
• 相比Redis缓存，这种基于文件的方案无需额外的缓存服务开销，成本效益更高

实现步骤与示例代码 #

1. 配置host.json #

在host.json中添加watchFiles节点，指定要监控的配置文件路径：

{
  "version": "2.0",
  "logging": {
    "applicationInsights": {
      "samplingSettings": {
        "isEnabled": true,
        "excludedTypes": "Request"
      }
    }
  },
  "watchFiles": [
    "config/appsettings.json"
  ]
}

2. 定义配置模型 #

创建对应配置结构的C#类：

public class AppConfig
{
    public string ApiEndpoint { get; set; }
    public int MaxRetryCount { get; set; }
    public Dictionary<string, string> FeatureFlags { get; set; }
}

3. 队列触发函数的配置读取逻辑 #

通过依赖注入的IConfiguration读取配置，watchFiles触发重载后，每次读取都会获取最新内容：

using Microsoft.Azure.Functions.Worker;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;

public class QueueTriggerFunction
{
    private readonly IConfiguration _configuration;
    private readonly ILogger<QueueTriggerFunction> _logger;

    public QueueTriggerFunction(IConfiguration configuration, ILogger<QueueTriggerFunction> logger)
    {
        _configuration = configuration;
        _logger = logger;
    }

    [Function("QueueTriggerFunction")]
    public void Run([QueueTrigger("my-queue", Connection = "AzureWebJobsStorage")] string myQueueItem)
    {
        // 读取最新配置
        var appConfig = _configuration.GetSection("AppConfig").Get<AppConfig>();
        
        _logger.LogInformation("当前配置API地址: {Endpoint}", appConfig.ApiEndpoint);
        // 此处编写队列消息处理逻辑
    }
}

4. 配置更新逻辑 #

收到配置变更事件时，更新指定路径的配置文件（需与watchFiles中路径一致）：

using System.IO;
using System.Text.Json;

public static void UpdateConfig(AppConfig newConfig)
{
    var configDir = Path.Combine(Environment.CurrentDirectory, "config");
    Directory.CreateDirectory(configDir);
    var configPath = Path.Combine(configDir, "appsettings.json");
    
    var jsonOptions = new JsonSerializerOptions { WriteIndented = true };
    var jsonString = JsonSerializer.Serialize(new { AppConfig = newConfig }, jsonOptions);
    
    File.WriteAllText(configPath, jsonString);
}

注意事项 #

• 确保配置文件存储在函数应用的可写目录内（Azure Functions默认D:\home\site\wwwroot目录可写）
• 配置变更事件的处理逻辑需具备幂等性，避免重复写入导致的无意义重载
• 消耗计划下自动扩容的新实例会直接读取最新配置文件，无需额外处理

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