Microsoft.Extensions.Configuration.Binder 8.0.2

关于

为Microsoft.Extensions.Configuration提供了将对象绑定到配置提供者中的数据的功能。此包允许您将配置数据表示为在应用程序代码中定义的强类型类。要绑定配置，请在IConfiguration对象上使用Microsoft.Extensions.Configuration.ConfigurationBinder.Get扩展方法。为了使用此包，您还需要安装一个配置提供者的包，例如，用于JSON提供者的Microsoft.Extensions.Configuration.Json。

该程序集中的类型在运行时使用反射，不利于链接或AOT。为了更好地支持链接和AOT以及提供更有效的强类型绑定方法，此包还提供了一个源生成器。当项目设置PublishAot时，此生成器默认启用，也可以使用<EnableConfigurationBindingGenerator>true</EnableConfigurationBindingGenerator>来启用。

主要特性

• 从配置部分配置现有的类型实例（绑定）
• 从配置部分构造新的配置类型实例（获取 & 获取值）
• 生成用于从配置部分绑定对象而不依赖运行时反射的源。

使用方法

以下示例展示了如何将JSON配置部分绑定到.NET对象。

using System;
using Microsoft.Extensions.Configuration;

class Settings
{
    public string Server { get; set; }
    public string Database { get; set; }
    public Endpoint[] Endpoints { get; set; }
}

class Endpoint
{
    public string IPAddress { get; set; }
    public int Port { get; set; }
}

class Program
{
    static void Main()
    {
        // Build a configuration object from JSON file
        IConfiguration config = new ConfigurationBuilder()
            .AddJsonFile("appsettings.json")
            .Build();

        // Bind a configuration section to an instance of Settings class
        Settings settings = config.GetSection("Settings").Get<Settings>();

        // Read simple values
        Console.WriteLine($"Server: {settings.Server}");
        Console.WriteLine($"Database: {settings.Database}");

        // Read nested objects
        Console.WriteLine("Endpoints: ");

        foreach (Endpoint endpoint in settings.Endpoints)
        {
            Console.WriteLine($"{endpoint.IPAddress}:{endpoint.Port}");
        }
    }
}

要运行此示例，请确保您的项目包含具有以下内容的appsettings.json文件

{
  "Settings": {
    "Server": "example.com",
    "Database": "Northwind",
    "Endpoints": [
      {
        "IPAddress": "192.168.0.1",
        "Port": "80"
      },
      {
        "IPAddress": "192.168.10.1",
        "Port": "8080"
      }
    ]
  }
}

您可以使用如下代码在.csproj文件中包含配置文件

<ItemGroup>
  <Content Include="appsettings.json">
    <CopyToOutputDirectory>Always</CopyToOutputDirectory>
  </Content>
</ItemGroup>

您可以将以下属性添加以启用源生成器。此要求.NET 8.0 SDK或更高版本。

<PropertyGroup>
  <EnableConfigurationBindingGenerator>true</EnableConfigurationBindingGenerator>
</PropertyGroup>

主要类型

此库提供的主要类型包括

• Microsoft.Extensions.Configuration.ConfigurationBinder
• Microsoft.Extensions.Configuration.BinderOptions

其他文档

• .NET中的配置
• API文档

相关包

• Microsoft.Extensions.Configuration
• Microsoft.Extensions.Configuration.Abstractions
• Microsoft.Extensions.Configuration.CommandLine
• Microsoft.Extensions.Configuration.EnvironmentVariables
• Microsoft.Extensions.Configuration.FileExtensions
• Microsoft.Extensions.Configuration.Ini
• Microsoft.Extensions.Configuration.Json
• Microsoft.Extensions.Configuration.UserSecrets
• Microsoft.Extensions.Configuration.Xml

反馈 & 贡献

Microsoft.Extensions.Configuration.Binder在MIT许可下作为开源发布。欢迎提交bug报告和贡献至GitHub仓库。