.NET Core中如何为IConfiguration实例添加扩展方法？（非扩展方法实现）

嘿，我懂你的感受——每次读个配置还要写GetSection("XXX")["YYY"]确实有点繁琐，要是能像GetConnectionString那样直接调用方法就爽多了对吧？下面给你几种实用的扩展方案，按需选就行：

一、针对特定配置节的“专属”扩展（比如Smtp） #

如果某个配置节（比如你的Smtp）是高频使用的，直接写针对性的扩展方法，调用起来和GetConnectionString一样丝滑：

public static class ConfigurationExtensions
{
    // 直接获取Smtp服务器地址
    public static string GetSmtpServer(this IConfiguration config)
    {
        return config.GetSection("Smtp")["server"] ?? string.Empty;
    }

    // 获取端口，附带容错和默认值
    public static int GetSmtpPort(this IConfiguration config)
    {
        // 避免配置缺失导致报错
        if (int.TryParse(config.GetSection("Smtp")["port"], out var port))
        {
            return port;
        }
        // 默认给常用的587端口
        return 587;
    }

    // 可继续添加用户名、密码等常用参数的方法
    public static string GetSmtpUsername(this IConfiguration config)
    {
        return config.GetSection("Smtp")["username"] ?? string.Empty;
    }
}

用的时候就这么简单：

// 和GetConnectionString的调用逻辑完全一致！
string smtpServer = Configuration.GetSmtpServer();
int smtpPort = Configuration.GetSmtpPort();

二、通用型扩展，适用于任何配置节 #

要是不想给每个配置节都写专属方法，那就整个通用版，不管什么节什么键都能读，还支持自定义默认值：

public static class ConfigurationExtensions
{
    // 读取字符串类型的通用方法
    public static string GetSectionValue(this IConfiguration config, string sectionName, string key, string defaultValue = "")
    {
        return config.GetSection(sectionName)[key] ?? defaultValue;
    }

    // 重载int类型，避免手动转换的麻烦
    public static int GetSectionValue(this IConfiguration config, string sectionName, string key, int defaultValue = 0)
    {
        if (int.TryParse(config.GetSection(sectionName)[key], out var result))
        {
            return result;
        }
        return defaultValue;
    }

    // 可按需添加bool、double等常用类型的重载
    public static bool GetSectionValue(this IConfiguration config, string sectionName, string key, bool defaultValue = false)
    {
        if (bool.TryParse(config.GetSection(sectionName)[key], out var result))
        {
            return result;
        }
        return defaultValue;
    }
}

调用示例：

// 读Smtp服务器，未配置则返回空字符串
string smtpServer = Configuration.GetSectionValue("Smtp", "server");
// 读端口，未配置则用默认值587
int smtpPort = Configuration.GetSectionValue("Smtp", "port", 587);
// 读是否启用SSL，默认启用
bool enableSsl = Configuration.GetSectionValue("Smtp", "enableSsl", true);

三、进阶玩法：直接绑定到实体类 #

如果你的配置节参数特别多（比如Smtp包含服务器、端口、用户名、密码等），不如直接把整个配置节绑定到实体类，类型安全还省心：

先定义对应配置的实体类：

public class SmtpSettings
{
    public string Server { get; set; } = string.Empty;
    public int Port { get; set; } = 587;
    public string Username { get; set; } = string.Empty;
    public string Password { get; set; } = string.Empty;
    public bool EnableSsl { get; set; } = true;
}

然后写个扩展方法直接获取实体：

public static class ConfigurationExtensions
{
    public static SmtpSettings GetSmtpSettings(this IConfiguration config)
    {
        // 用Get<T>直接绑定，未读取到则返回默认实例
        return config.GetSection("Smtp").Get<SmtpSettings>() ?? new SmtpSettings();
    }
}

调用时直接拿到完整配置实体，想用哪个属性就用哪个：

SmtpSettings smtpConfig = Configuration.GetSmtpSettings();
// 直接访问属性，无需重复读取配置
string server = smtpConfig.Server;
int port = smtpConfig.Port;

这种方式是.NET官方推荐的方案，配置项越多越能体现优势，代码整洁还不容易出错。

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