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

【问题标题】：Azure WebJobs QueueTrigger ignores environment when reading configurationAzure WebJobs QueueTrigger 在读取配置时忽略环境
【发布时间】：2019-12-13 08:47:38
【问题描述】：

我有一个带有 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 属性中定义它的原因）。我还有两个本地文件，它们定义了 dev 和 prod 环境的设置：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 连接字符串的值？

【问题讨论】：

你好，我想看看你是否解决了这个问题。

标签： azure azure-webjobs azure-storage-queues queuetrigger

【解决方案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);
            }
        }    
}

然后在项目中添加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才能生效。

【讨论】：