.net core IConfiguration 读 appsettings.json 数据,举例

发布于:2024-07-22 ⋅ 阅读:(140) ⋅ 点赞:(0)

在.NET Core中,IConfiguration 接口是用来读取配置数据的,包括从 appsettings.json 文件中读取。下面是一个如何在使用.NET Core时通过 IConfiguration 读取 appsettings.json 数据的示例。

首先,假设你的 appsettings.json 文件内容如下:

{  
  "Logging": {  
    "LogLevel": {  
      "Default": "Information",  
      "Microsoft": "Warning",  
      "Microsoft.Hosting.Lifetime": "Information"  
    }  
  },  
  "MyCustomSettings": {  
    "ApiKey": "12345",  
    "BaseUrl": "https://api.example.com"  
  }  
}

接下来,你需要在你的.NET Core项目中定义一个与 MyCustomSettings 部分相对应的C#类。这样,你就可以使用 IConfiguration 的 Get<T>() 方法来读取这些设置了。

public class MyCustomSettings  
{  
    public string ApiKey { get; set; }  
    public string BaseUrl { get; set; }  
}

然后,在你的Startup类或其他需要这些配置的类中,你可以通过构造函数注入 IConfiguration,并使用它来获取 MyCustomSettings 的实例。

这里是一个在Startup类中获取并使用这些配置的示例:

public class Startup  
{  
    public Startup(IConfiguration configuration)  
    {  
        Configuration = configuration;  
  
        // 直接从 IConfiguration 读取单个设置(不推荐,因为不是类型安全的)  
        var apiKeyFromConfig = Configuration["MyCustomSettings:ApiKey"];  
  
        // 使用强类型配置(推荐)  
        var myCustomSettings = Configuration.GetSection("MyCustomSettings").Get<MyCustomSettings>();  
  
        // 现在你可以使用 myCustomSettings.ApiKey 和 myCustomSettings.BaseUrl 了  
    }  
  
    public IConfiguration Configuration { get; }  
  
    // ... 其他Startup类的方法 ...  
}

然而,如果你打算在Startup类之外的其他服务或控制器中使用这些配置,你可能希望将它们作为配置选项注入到你的依赖注入容器中。这可以通过使用 IOptions<T> 接口来实现,该接口是.NET Core提供的用于读取配置选项的强类型方式。

首先,你需要在 Startup.cs 的 ConfigureServices 方法中配置你的选项:

public void ConfigureServices(IServiceCollection services)  
{  
    // ... 其他服务配置 ...  
  
    // 添加MyCustomSettings到DI容器,以便在其他地方通过IOptions<MyCustomSettings>注入  
    services.Configure<MyCustomSettings>(Configuration.GetSection("MyCustomSettings"));  
  
    // ... 其他服务配置 ...  
}

然后,在你的服务或控制器中,你可以通过构造函数注入 IOptions<MyCustomSettings> 来访问这些配置了:

public class MyService  
{  
    private readonly MyCustomSettings _settings;  
  
    public MyService(IOptions<MyCustomSettings> options)  
    {  
        _settings = options.Value;  
  
        // 现在你可以使用 _settings.ApiKey 和 _settings.BaseUrl 了  
    }  
  
    // ... 其他服务方法 ...  
}


网站公告

今日签到

点亮在社区的每一天
去签到