如何在Linux容器中运行的.NET Core Worker Service获取环境变量？

我尝试在Linux容器中运行ASP.NET Core Worker Service时，使用自定义方法获取环境变量但未成功，当前实现代码如下：

/// <summary>
/// Get the 
/// </summary>
/// <param name="key"></param>
/// <param name="defaultValueIfNotFound"></param>
public static T GetConfigValue<T>(string key, T defaultValueIfNotFound)
{
    string? variableValue = Environment.GetEnvironmentVariable(key);

    if (!string.IsNullOrEmpty(variableValue))
    {
        Console.WriteLine($"{key}: {variableValue}");
    }
    else
    {
        Console.WriteLine($"Environment variable {key} not set.");
        return defaultValueIfNotFound;
    }

    try
    {
        return (T)Convert.ChangeType(variableValue, typeof(T));
    }
    catch (Exception ex)
    {
        throw new InvalidCastException($"Failed to cast the settings value with key {key}");
    }
}

以下是针对该问题的排查方向和解决方案：

可能的问题原因及解决步骤 #

1. 环境变量未正确注入容器 #

• 检查容器启动配置：
  • 用docker run启动时，确认是否通过-e KEY=VALUE参数传入目标环境变量
  • 用Docker Compose时，检查environment字段配置是否正确，示例：

    services:
      my-worker-service:
        image: your-worker-image:latest
        environment:
          - TARGET_VAR=example_value
    

• 进入容器验证变量是否存在：执行docker exec -it <容器ID> printenv，查看目标变量是否在输出列表中

2. 优先使用ASP.NET Core内置配置系统 #

Environment.GetEnvironmentVariable仅读取系统级环境变量，而ASP.NET Core的IConfiguration会自动整合所有配置源（包括环境变量、appsettings.json、命令行参数等），且处理了跨平台的命名规则（比如分层配置用_替换冒号:，自动兼容大小写），是更可靠的实现方式：

实现示例

在Program.cs中构建主机时，配置已默认包含环境变量源：

var builder = Host.CreateDefaultBuilder(args);
builder.ConfigureServices((hostContext, services) =>
{
    services.AddHostedService<Worker>();
});

var host = builder.Build();
host.Run();

在Worker类中通过构造注入IConfiguration读取配置：

public class Worker : BackgroundService
{
    private readonly IConfiguration _config;

    public Worker(IConfiguration config)
    {
        _config = config;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        // 读取环境变量，指定默认值
        var testVar = _config.GetValue<string>("TEST_VAR", "default_value");
        // 读取分层配置（对应appsettings.json中的MyConfig:Port）
        var port = _config.GetValue<int>("MYCONFIG_PORT", 8080);

        Console.WriteLine($"TEST_VAR: {testVar}");
        Console.WriteLine("Port: {port}");
    }
}

3. 现有自定义方法的潜在问题 #

• Convert.ChangeType对部分类型兼容性差：比如Linux环境下环境变量的布尔值如果是小写的true/false，该方法无法正确转换为bool类型，而IConfiguration.GetValue会自动处理这类场景
• 未处理类型转换时的详细异常信息：当前代码仅抛出通用的InvalidCastException，不利于排查具体转换失败原因

4. 镜像构建阶段的问题检查 #

如果Dockerfile中使用ENV命令设置环境变量，确认命令未被后续步骤覆盖，且语法正确（比如ENV KEY=VALUE没有多余空格）

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