Azure WebJobs QueueTrigger 在读取配置时忽略环境

Question

我有一个带有 QueueTrigger 的 Azure WebJobs:

public void ProcessTestQueueByTrigger(
    [QueueTrigger("test-queue", Connection = "MyCustomStorageConnection")] string queueMessage,
    int dequeueCount,
    TextWriter log)
    {
        var message = $"ProcessTestQueueByTrigger executed: {queueMessage}, dequeue: {dequeueCount}";
        log.WriteLine(message);
    }
}

哪里MyCustomStorageConnection与默认作业连接不同(这就是我在 QueueTrigger 属性中定义它的原因)。我还有两个定义开发和生产环境设置的本地文件:appsettings.json和appsettings.Production.json .

当我启动 WebJobs 时，我正在读取 config 的有效配置和设置。对象

var configuration = new JobHostConfiguration
{
    DashboardConnectionString = config.GetConnectionString("AzureWebJobsDashboard"),
    StorageConnectionString = config.GetConnectionString("AzureWebJobsStorage"),
};

以及存储在 config.GetConnectionString("MyCustomStorageConnection") 中的有效连接但没有地方可以和主机一起设置。每当主机启动时，QueueTrigger正在从 appsettings.json 读取值并完全忽略 appsettings.Production.json .

如何强制 QueueTrigger 使用正确的配置或仅定义 QueueTrigger 连接字符串的值？

Answer 1

您可以通过设置环境变量轻松实现此目的。

以下是在 Windows 10 上使用 Visual Studio 2017 的步骤。

1.创建一个.NET core webjob(不熟悉的可以引用这个doc)，完成的代码如下:

Program.cs:

using System;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;

namespace MySampleWebjob
{
    class Program
    {
        static void Main(string[] args)
        {

            //since we have 2 .json files, we can control which .json file is to be used by setting a Environment variable. And then read the value here.
            var environment = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT");
            Console.WriteLine($"the environment is: "+ environment);

            var builder = new HostBuilder();
            builder.ConfigureWebJobs(b =>
            {
                b.AddAzureStorageCoreServices();
                b.AddAzureStorage();
            })
            .ConfigureAppConfiguration((hostContext, configApp) => {
                configApp.AddJsonFile("appsettings.json", optional: true,reloadOnChange:true);
                configApp.AddJsonFile($"appsettings.{environment}.json", optional: true, reloadOnChange: true);
                configApp.AddEnvironmentVariables();
            })
            .ConfigureLogging((context, b) =>
            {
                b.AddConsole();
            })
            ;
            var host = builder.Build();
            using (host)
            {
                host.Run();
            }
        }
    }
}

函数.cs:

using Microsoft.Azure.WebJobs;
using Microsoft.Extensions.Logging;

namespace MySampleWebjob
{
        public class Functions
        {
            public static void ProcessQueueMessage([QueueTrigger("myqueue-items")] string message, ILogger logger)
            {
                logger.LogInformation(message);
            }
        }    
}

然后在项目中添加 2 个 .json 文件:appsettings.Production.json 和 appsettings.json。 2个.json文件的结构相同，但存储连接字符串不同。

appsettings.json:

{
  "AzureWebJobsStorage": "DefaultEndpointsProtocol=https;AccountName=xxx;AccountKey=xx;EndpointSuffix=core.windows.net"
}

appsettings.Production.json:

  {
      "AzureWebJobsStorage": "Another azure storage connection string"
    }

请注意在 Visual Studio 中，右键单击每个 json 文件 -> 属性 -> 将“复制到输出目录”设置为“如果较新则复制”。

最后，通过cmd或UI设置环境变量。 cmd命令为setx ASPNETCORE_ENVIRONMENT "Production"，如果要使用环境变量则重新启动Visual Studio。

因此，如果您想使用 appsettings.json 中的存储连接字符串，则无需设置环境变量。如果要使用appsettings.Production.json中的连接字符串，需要设置环境变量。

注意，如果您设置了环境变量或删除了环境变量，请记得重新启动 Visual Studio 才能生效。