Microsoft.Extensions.Configuration.Binder 8.0.2

Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Microsoft.Extensions.Configuration.Binder --version 8.0.2                
NuGet\Install-Package Microsoft.Extensions.Configuration.Binder -Version 8.0.2                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="8.0.2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.Configuration.Binder --version 8.0.2                
#r "nuget: Microsoft.Extensions.Configuration.Binder, 8.0.2"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Microsoft.Extensions.Configuration.Binder as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.Configuration.Binder&version=8.0.2

// Install Microsoft.Extensions.Configuration.Binder as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.Configuration.Binder&version=8.0.2                

About

Provides the functionality to bind an object to data in configuration providers for Microsoft.Extensions.Configuration. This package enables you to represent the configuration data as strongly-typed classes defined in the application code. To bind a configuration, use the Microsoft.Extensions.Configuration.ConfigurationBinder.Get extension method on the IConfiguration object. To use this package, you also need to install a package for the configuration provider, for example, Microsoft.Extensions.Configuration.Json for the JSON provider.

The types contained in this assembly use Reflection at runtime which is not friendly with linking or AOT. To better support linking and AOT as well as provide more efficient strongly-typed binding methods - this package also provides a source generator. This generator is enabled by default when a project sets PublishAot but can also be enabled using <EnableConfigurationBindingGenerator>true</EnableConfigurationBindingGenerator>.

Key Features

  • Configuring existing type instances from a configuration section (Bind)
  • Constructing new configured type instances from a configuration section (Get & GetValue)
  • Generating source to bind objects from a configuration section without a runtime reflection dependency.

How to Use

The following example shows how to bind a JSON configuration section to .NET objects.

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}");
        }
    }
}

To run this example, include an appsettings.json file with the following content in your project:

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

You can include a configuration file using a code like this in your .csproj file:

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

You can add the following property to enable the source generator. This requires a .NET 8.0 SDK or later.

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

Main Types

The main types provided by this library are:

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

Additional Documentation

Feedback & Contributing

Microsoft.Extensions.Configuration.Binder is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3.8K)

Showing the top 5 NuGet packages that depend on Microsoft.Extensions.Configuration.Binder:

Package Downloads
Microsoft.Extensions.Options.ConfigurationExtensions

Provides additional configuration specific functionality related to Options.

Microsoft.Extensions.Logging.Configuration

Configuration support for Microsoft.Extensions.Logging.

Microsoft.Extensions.Hosting

Hosting and startup infrastructures for applications.

Serilog.Settings.Configuration

Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.

Microsoft.AspNetCore.Server.Kestrel.Core

Core components of ASP.NET Core Kestrel cross-platform web server.

GitHub repositories (362)

Showing the top 5 popular GitHub repositories that depend on Microsoft.Extensions.Configuration.Binder:

Repository Stars
jellyfin/jellyfin
The Free Software Media System
microsoft/semantic-kernel
Integrate cutting-edge LLM technology quickly and easily into your apps
abpframework/abp
Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation.
microsoft/garnet
Garnet is a remote cache-store from Microsoft Research that offers strong performance (throughput and latency), scalability, storage, recovery, cluster sharding, key migration, and replication features. Garnet can work with existing Redis clients.
JeffreySu/WeiXinMPSDK
微信全平台 .NET SDK, Senparc.Weixin for C#,支持 .NET Framework 及 .NET Core、.NET 8.0。已支持微信公众号、小程序、小游戏、微信支付、企业微信/企业号、开放平台、JSSDK、微信周边等全平台。 WeChat SDK for C#.
Version Downloads Last updated
9.0.0-preview.6.24327.7 11,458 7/9/2024
9.0.0-preview.5.24306.7 35,363 6/11/2024
9.0.0-preview.4.24266.19 38,854 5/21/2024
9.0.0-preview.3.24172.9 92,087 4/11/2024
9.0.0-preview.2.24128.5 58,054 3/12/2024
9.0.0-preview.1.24080.9 70,986 2/13/2024
8.0.2 423,760 7/9/2024
8.0.1 23,379,719 1/9/2024
8.0.0 70,398,230 11/14/2023
8.0.0-rc.2.23479.6 832,033 10/10/2023
8.0.0-rc.1.23419.4 337,727 9/12/2023
8.0.0-preview.7.23375.6 292,026 8/8/2023
8.0.0-preview.6.23329.7 132,976 7/11/2023
8.0.0-preview.5.23280.8 92,093 6/13/2023
8.0.0-preview.4.23259.5 214,297 5/16/2023
8.0.0-preview.3.23174.8 145,958 4/11/2023
8.0.0-preview.2.23128.3 79,715 3/14/2023
8.0.0-preview.1.23110.8 121,857 2/21/2023
7.0.4 34,470,521 3/14/2023
7.0.3 42,043,197 2/14/2023
7.0.2 5,669,319 1/10/2023
7.0.1 3,328,369 12/13/2022
7.0.0 91,200,642 11/7/2022
7.0.0-rc.2.22472.3 244,254 10/11/2022
7.0.0-rc.1.22426.10 165,409 9/14/2022
7.0.0-preview.7.22375.6 203,505 8/9/2022
7.0.0-preview.6.22324.4 89,900 7/12/2022
7.0.0-preview.5.22301.12 59,248 6/14/2022
7.0.0-preview.4.22229.4 74,058 5/10/2022
7.0.0-preview.3.22175.4 70,365 4/13/2022
7.0.0-preview.2.22152.2 36,697 3/14/2022
7.0.0-preview.1.22076.8 52,010 2/17/2022
6.0.0 292,076,099 11/8/2021
6.0.0-rc.2.21480.5 569,143 10/12/2021
6.0.0-rc.1.21451.13 338,931 9/14/2021
6.0.0-preview.7.21377.19 240,351 8/10/2021
6.0.0-preview.6.21352.12 111,213 7/14/2021
6.0.0-preview.5.21301.5 65,576 6/15/2021
6.0.0-preview.4.21253.7 59,204 5/24/2021
6.0.0-preview.3.21201.4 186,915 4/8/2021
6.0.0-preview.2.21154.6 100,211 3/11/2021
6.0.0-preview.1.21102.12 111,826 2/12/2021
5.0.0 191,229,812 11/9/2020
5.0.0-rc.2.20475.5 255,319 10/13/2020
5.0.0-rc.1.20451.14 330,479 9/14/2020
5.0.0-preview.8.20407.11 297,999 8/25/2020
5.0.0-preview.7.20364.11 69,037 7/21/2020
5.0.0-preview.6.20305.6 53,131 6/25/2020
5.0.0-preview.5.20278.1 27,137 6/10/2020
5.0.0-preview.4.20251.6 54,059 5/18/2020
5.0.0-preview.3.20215.2 227,018 4/23/2020
5.0.0-preview.2.20160.3 223,082 4/2/2020
5.0.0-preview.1.20120.4 87,292 3/16/2020
3.1.32 8,429,903 12/13/2022
3.1.31 1,827,563 11/8/2022
3.1.30 2,059,178 10/11/2022
3.1.29 1,774,140 9/13/2022
3.1.28 2,317,394 8/9/2022
3.1.27 1,732,192 7/12/2022
3.1.26 1,607,972 6/14/2022
3.1.25 2,612,670 5/10/2022
3.1.24 1,822,427 4/11/2022
3.1.23 3,007,467 3/8/2022
3.1.22 14,378,221 12/14/2021
3.1.21 7,456,556 11/7/2021
3.1.20 3,863,787 10/11/2021
3.1.19 4,724,803 9/14/2021
3.1.18 36,690,811 8/10/2021
3.1.17 6,046,161 7/13/2021
3.1.16 9,542,621 6/8/2021
3.1.15 7,826,874 5/11/2021
3.1.14 15,185,347 4/6/2021
3.1.13 12,844,442 3/9/2021
3.1.12 10,225,425 2/9/2021
3.1.11 12,449,334 1/12/2021
3.1.10 22,409,519 11/9/2020
3.1.9 62,660,256 10/13/2020
3.1.8 61,077,976 9/8/2020
3.1.7 31,361,684 8/11/2020
3.1.6 36,174,181 7/14/2020
3.1.5 37,602,167 6/9/2020
3.1.4 39,670,442 5/12/2020
3.1.3 81,087,435 3/24/2020
3.1.2 70,002,036 2/18/2020
3.1.1 39,832,544 1/14/2020
3.1.0 148,700,265 12/3/2019
3.1.0-preview3.19553.2 214,861 11/13/2019
3.1.0-preview2.19525.4 72,015 11/1/2019
3.1.0-preview1.19506.1 1,126,212 10/15/2019
3.0.3 59,401,114 2/18/2020
3.0.2 1,049,048 1/14/2020
3.0.1 5,874,674 11/18/2019
3.0.0 84,161,585 9/23/2019
3.0.0-rc1.19456.10 89,131 9/16/2019
3.0.0-preview9.19423.4 1,429,157 9/4/2019
3.0.0-preview8.19405.4 535,495 8/13/2019
3.0.0-preview7.19362.4 213,124 7/23/2019
3.0.0-preview6.19304.6 328,309 6/12/2019
3.0.0-preview5.19227.9 776,894 5/6/2019
3.0.0-preview4.19216.2 68,484 4/18/2019
3.0.0-preview3.19153.1 328,348 3/6/2019
3.0.0-preview.19074.2 172,154 1/29/2019
3.0.0-preview.18572.1 145,834 12/3/2018
2.2.4 28,136,342 4/9/2019
2.2.0 223,196,690 12/3/2018
2.2.0-preview3-35497 393,080 10/17/2018
2.2.0-preview2-35157 268,958 9/12/2018
2.2.0-preview1-35029 149,596 8/22/2018
2.1.10 59,497,369 4/9/2019
2.1.1 294,433,827 6/18/2018
2.1.0 323,982,731 5/29/2018
2.1.0-rc1-final 531,512 5/6/2018
2.1.0-preview2-final 605,641 4/10/2018
2.1.0-preview1-final 614,689 2/26/2018
2.0.2 7,510,417 5/7/2018
2.0.1 12,384,718 3/13/2018
2.0.0 342,380,578 8/11/2017
2.0.0-preview2-final 145,125 6/28/2017
2.0.0-preview1-final 54,895 5/10/2017
1.1.2 14,594,890 5/9/2017
1.1.1 4,178,765 3/6/2017
1.1.0 2,821,608 11/16/2016
1.1.0-preview1-final 16,873 10/24/2016
1.0.2 2,605,727 3/6/2017
1.0.1 367,458 12/12/2016
1.0.0 3,344,370 6/27/2016
1.0.0-rc2-final 40,555 5/16/2016
1.0.0-rc1-final 815,146 11/18/2015