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核心doc (如果您不熟悉可以参考此webjob)，完成的代码如下：

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

然后在项目中添加两个.json文件：appsettings.Production.json和appsettings.json。这两个.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文件的属性，并将"Copy to Output “设置为"Copy if -> ->”。

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

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

请注意，，如果您设置了环境变量或删除了环境变量，请记住重新启动visual studio以使其生效。