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

您可以通过设置环境变量轻松实现这一点。

以下是在带有Visual Studio 2017的Windows 10上的步骤。

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();
            }
        }
    }
}

Functions.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);
            }
        }    
}

Then在项目中添加2个.json文件：appsettings.Production.json和appsettings.json。这两个.json文件的结构相同，但是具有不同的存储连接g字符串。

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才能生效。