.NET Standard类库中如何读取appsettings.json配置文件

阿华AIGC实验室

2026-5-29

在.NET Standard类库中实现可复用的appsettings读取逻辑

嘿，这个需求我太熟悉了！.NET Standard类库本身并不直接提供读取appsettings.json的能力——毕竟它是一个跨平台的抽象标准库，没有绑定到ASP.NET Core这类特定的宿主环境。不过我们可以通过依赖注入传递配置实例或者抽象配置读取接口的方式，实现可复用的配置类，完美满足你Framework类库供多个项目使用的需求。

方案一：依赖注入`IConfiguration`（推荐，符合ASP.NET Core设计理念）

这种方式直接复用ASP.NET Core的配置系统，是最简洁也最符合生态的方案。

1. 在Framework类库中创建配置服务类

创建一个包含泛型方法的配置类，通过构造函数注入ASP.NET Core的IConfiguration实例：

using Microsoft.Extensions.Configuration;

namespace YourFrameworkNamespace
{
    public class AppSettingsProvider
    {
        private readonly IConfiguration _configuration;

        // 通过构造注入获取配置实例
        public AppSettingsProvider(IConfiguration configuration)
        {
            _configuration = configuration;
        }

        // 实现泛型读取方法
        public T GetAppSetting<T>(string key)
        {
            // 基础类型直接用GetValue
            return _configuration.GetValue<T>(key);
            
            // 如果需要读取复杂对象（比如嵌套配置），可以改用：
            // return _configuration.GetSection(key).Get<T>();
        }
    }
}

2. 在Web项目中注册服务到DI容器

在Web项目的Program.cs（.NET 6+）或者Startup.cs（旧版本）中，把这个配置类注册到依赖注入容器：

var builder = WebApplication.CreateBuilder(args);

// 注册配置服务（可以根据需求选择AddScoped/AddSingleton/AddTransient）
builder.Services.AddScoped<AppSettingsProvider>();

// 其他服务注册...

var app = builder.Build();
// ...后续中间件配置

3. 在Web项目或类库的其他服务中使用

不管是Web项目的控制器，还是Framework类库中的其他业务服务，都可以通过构造注入来使用这个配置类：

// 示例：Web项目中的控制器
using YourFrameworkNamespace;

public class DemoController : ControllerBase
{
    private readonly AppSettingsProvider _settingsProvider;

    public DemoController(AppSettingsProvider settingsProvider)
    {
        _settingsProvider = settingsProvider;
    }

    [HttpGet("settings")]
    public IActionResult GetSettings()
    {
        // 读取字符串类型配置
        var dbConn = _settingsProvider.GetAppSetting<string>("ConnectionStrings:Default");
        // 读取数值类型配置
        var maxRetry = _settingsProvider.GetAppSetting<int>("AppSettings:MaxRetryCount");
        
        return Ok(new { DbConnection = dbConn, MaxRetryCount = maxRetry });
    }
}

方案二：抽象配置读取接口（更高的解耦，适配多宿主场景）

如果希望你的Framework类库完全不依赖ASP.NET Core的IConfiguration，可以通过定义抽象接口的方式，让不同的宿主项目（比如Web、控制台、WPF）自己实现配置读取逻辑。

1. 在Framework类库中定义抽象接口

namespace YourFrameworkNamespace
{
    public interface IAppSettingsProvider
    {
        T GetAppSetting<T>(string key);
    }
}

2. 在Framework类库中依赖这个接口

比如你的业务逻辑类可以直接依赖IAppSettingsProvider，不需要关心配置来自哪里：

namespace YourFrameworkNamespace
{
    public class OrderService
    {
        private readonly IAppSettingsProvider _settingsProvider;

        public OrderService(IAppSettingsProvider settingsProvider)
        {
            _settingsProvider = settingsProvider;
        }

        public void ProcessOrder()
        {
            var timeout = _settingsProvider.GetAppSetting<int>("OrderSettings:ProcessTimeout");
            // 业务逻辑处理...
        }
    }
}

3. 在Web项目中实现接口

在Web项目中，基于ASP.NET Core的IConfiguration实现这个接口：

using Microsoft.Extensions.Configuration;
using YourFrameworkNamespace;

namespace YourWebNamespace
{
    public class AspNetCoreAppSettingsProvider : IAppSettingsProvider
    {
        private readonly IConfiguration _configuration;

        public AspNetCoreAppSettingsProvider(IConfiguration configuration)
        {
            _configuration = configuration;
        }

        public T GetAppSetting<T>(string key)
        {
            return _configuration.GetValue<T>(key);
        }
    }
}

4. 注册接口与实现到DI容器

var builder = WebApplication.CreateBuilder(args);

// 注册接口和对应的实现
builder.Services.AddScoped<IAppSettingsProvider, AspNetCoreAppSettingsProvider>();
// 注册依赖该接口的业务服务
builder.Services.AddScoped<OrderService>();

// ...其他配置