如何自定义绑定环境变量到C#/.NET配置类属性

要实现自定义配置键与C#属性的映射，不用修改属性名破坏.NET命名规范，你可以通过以下步骤完成：

1. 创建自定义配置名称特性 #

首先定义一个特性类，用来标记属性对应的目标配置键：

[AttributeUsage(AttributeTargets.Property)]
public class ConfigNameAttribute : Attribute
{
    public string Name { get; }

    public ConfigNameAttribute(string name)
    {
        Name = name;
    }
}

2. 在Options类中应用特性 #

在你的配置类里，给需要自定义映射的属性加上这个特性：

public class PositionOptions
{
    [ConfigName("position_title")]
    public string PositionTitle { get; set; }
}

3. 自定义配置绑定逻辑 #

ASP.NET Core的ConfigurationBinder允许通过BinderOptions自定义属性到配置键的解析规则。你可以在绑定配置时，指定PropertyNameResolver来读取自定义特性的值：

直接绑定实例 #

var config = builder.Configuration;
var positionOptions = new PositionOptions();

config.Bind("Position", positionOptions, options =>
{
    options.PropertyNameResolver = property =>
    {
        // 优先读取自定义特性指定的键名，没有则用默认属性名
        var configAttr = property.GetCustomAttribute<ConfigNameAttribute>();
        return configAttr?.Name ?? property.Name;
    };
});

依赖注入方式配置Options #

如果是通过DI容器注册Options，同样可以指定绑定规则：

builder.Services.Configure<PositionOptions>(
    config.GetSection("Position"),
    options =>
    {
        options.BindOptions.PropertyNameResolver = property =>
        {
            var configAttr = property.GetCustomAttribute<ConfigNameAttribute>();
            return configAttr?.Name ?? property.Name;
        };
    }
);

环境变量的对应关系 #

按照环境变量的命名规则，POSITION__POSITION_TITLE会被解析为配置路径Position:position_title，正好和我们通过[ConfigName("position_title")]指定的键名匹配，这样就能正确将环境变量的值绑定到PositionTitle属性上，完全不需要修改C#属性的命名。

内容的提问来源于stack exchange，提问作者Dr. Strangelove