Sie sind hier: Wissen
Werbung Werbung

Was ist Microsoft.Extensions.Configuration ?

Microsoft.Extensions.Configuration ist der Namensraum für die .NET-Klassen für den Zugriff auf Konfigurationsinformationen in .NET Core 1.x, 2.x und 3.x sowie .NET ab Version 5.0.

Konfigurationsdateien hat der Webentwickler im alten ASP.NET in der XML-Datei web.config gespeichert und mit Hilfe der Bibliothek System.Configuration gelesen. System.Configuration gehört zu den Bibliotheken, die in .NET Core entfallen sind. An diese Stelle tritt nun eine Sammlung von Nuget-Paketen unter dem Oberbegriff "Microsoft.Extensions.Configuration", mit denen der Entwickler Name-Wert-Paare aus unterschiedlichen Speicherarten lesen und kombinieren kann. Unterstützt werden z.B. JSON-, XML- und INI-Dateien sowie Umgebungsvariablen und Kommandozeilenparameter.

Dazu sind folgende Nuget-Pakete verfügbar:
JSON: Microsoft.Extensions.Configuration.Json
 INI: Microsoft.Extensions.Configuration.Ini
XML: Microsoft.Extensions.Configuration.Xml
 Umgebungsvariablen: Microsoft.Extensions.Configuration.EnvironmentVariables
 Kommandozeilenargumente: Microsoft.Extensions.Configuration.CommandLine
Microsoft Azure Key Vault: Microsoft.Extensions.Configuration.AzureKeyVault

Informationen können dabei verschlüsselt sein [docs.microsoft.com/en-us/aspnet/core/security/data-protection/introduction]. Listing 3 zeigt Fragmente, wie man die gleiche Information in XML-, INI- und JSON-Format ausdrückt. Listing 4 zeigt das Laden dieser drei Konfigurationsdateien aus dem Ordner „Config“, relativ zum Wurzelverzeichnis der Webanwendung (wwwroot-Ordner) sowie das Hinzufügen eines Eintrags im RAM. Der Parameter „true“ bei AddIniFile() bedeutet, dass die Datei optional ist, es also keinen Laufzeitfehler („FileNotFoundException“) gibt, wenn sie fehlt. Im RAM geänderte oder hinzugefügte Einträge können nicht persistiert werden.

Danach kann der Entwickler über das von build() gelieferte Objekt einzelne Einstellungen über den Indexer des Configuration-Objekts abrufen, z.B. configuration["Impressum:Autor"] oder über configuration.GetSection("Impressum") alle Einträge einer Sektion erhalten. Wenn, wie im Fall von Listing 3, mehrere identische Einträge in einer Sektion vorliegen, gewinnt der zuletzt hinzugefügte Eintrag. In Listing 4 kommen Autor und Version aus der XML-Datei!

<Config>
<Impressum>
<Autor>Dr. Schwichtenberg</Autor>
<Version>1.0</Version>


[Impressum]
Autor=Dr. H. Schwichtenberg
Version=v1.1


{
"Impressum": {
"Autor": "Dr. Holger Schwichtenberg",
"Version": "1.2",


Listing 3: Konfigurationsinformationen im XML-, INI- und JSON-Format

// mehrere Konfigurationsdateien festlegen
var builder = new ConfigurationBuilder()
.SetBasePath(_env.WebRootPath)
.AddJsonFile(@"Config\Config.json")
.AddIniFile(@"Config\Config.ini", true)
.AddXmlFile(@"Config\Config.xml")
.AddInMemoryCollection()
.AddEnvironmentVariables();

// Gesamtliste erzeugen
IConfigurationRoot configuration = builder.Build();

// noch einen Eintrag im RAM hinzufügen
configuration["Impressum:Stand"] = DateTime.Now.ToString();

Listing 4: Konfigurationsdateien laden und Eintrag im RAM hinzufügen

Alle Einträge einer Sektion liest man mit GetSection() und GetChildren():

IConfigurationSection section1 = configuration.GetSection("Impressum");
e += "<h3>Alle Einträge der Konfigurationssektion 'Impressum':</h3>";
foreach (var s in section1.GetChildren())
{
e += s.Key + "=" + s.Value + "<br>";
}

Wenn es in der Konfigurationsdatei eine Liste von Einträgen gibt, z.B.

"Versionsgeschichte": [
{
"Version": "1.0",
"Datum": "1.1.2017"
},
{
"Version": "1.1",
"Datum": "10.2.2017"
}, …
]

kann man in dem Indexer des Configuration-Objekts wieder einen Index (der bei 0 beginnt) verwenden, z.B. für den ersten Eintrag in „Versionsgeschichte“:
configuration["Versionsgeschichte:0:Version"];

Mit dem folgenden Programmcode listet man dann alle Versionseinträge auf:
IConfigurationSection section2 = configuration.GetSection("Versionsgeschichte");
foreach (var geschichte in section2.GetChildren())
{
foreach (var geschichtseintrag in geschichte.GetChildren())
{
e += geschichtseintrag.Key + "=" + geschichtseintrag.Value + "<br>";
}
}

Beratung & Support

Schulungen zu diesem Thema

 Anfrage für eine individuelle Schulung zum Thema Microsoft.Extensions.Configuration  Gesamter Schulungsthemenkatalog

Bücher zu diesem Thema

  .NET 9.0 Update: Die Neuerungen in .NET 9.0 gegenüber .NET 8.0
  PowerShell 7 und Windows PowerShell 5 – das Praxishandbuch
  .NET 8.0 Update: Die Neuerungen in .NET 8.0 gegenüber .NET 7.0
  Blazor 8.0: Moderne Webanwendungen und hybride Cross-Platform-Apps mit .NET 8.0, C# 12.0 und Visual Studio 2022
  Moderne Datenzugriffslösungen mit Entity Framework Core 8.0
  C# 12.0 Crashkurs
  Cross-Plattform-Apps mit .NET MAUI entwickeln
  Blazor 7.0: Blazor WebAssembly, Blazor Server und Blazor Hybrid
  C# 11.0 Crashkurs
  Moderne Datenzugriffslösungen mit Entity Framework Core 7.0
  PowerShell 7 und Windows PowerShell 5 – das Praxishandbuch
  App Engineering: SwiftUI, Jetpack Compose, .NET MAUI und Flutter
  Vue.js 3 Crashkurs
  Moderne Datenzugriffslösungen mit Entity Framework Core 6.0
  Blazor 6.0: Blazor WebAssembly, Blazor Server und Blazor Desktop
  C# 10.0 Crashkurs
  Cross-Plattform-Apps mit Xamarin.Forms entwickeln
  Developing Web Components with TypeScript: Native Web Development Using Thin Libraries
  PowerShell – kurz & gut
  C# 9.0 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET 5.0, .NET Core und Xamarin
  ASP.NET Core Blazor 5.0: Blazor WebAssembly und Blazor Server - Moderne Single-Page-Web-Applications
  Windows PowerShell 5 und PowerShell 7: Das Praxisbuch
  Moderne Datenzugriffslösungen mit Entity Framework Core 5.0
  ASP.NET Core Blazor 3.1/3.2: Blazor Server und Blazor Webassembly - Moderne Single-Page-Web-Applications mit .NET, C# und Visual Studio
  ASP.NET Core Blazor 3.0/3.1: Blazor Server und Blazor Webassembly - Moderne Single-Page-Web-Applications mit .NET, C# und Visual Studio
  Moderne Datenzugriffslösungen mit Entity Framework Core 3.1
  C# 8.0 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
  Moderne Datenzugriffslösungen mit Entity Framework Core 3.0
  Windows PowerShell 5.1 und PowerShell Core 6.1 - Das Praxishandbuch
  Moderne Datenzugriffslösungen mit Entity Framework Core 2.1/2.2
  Moderne Webanwendungen für .NET-Entwickler: Server-Anwendungen, Web APIs, SPAs & HTML-Cross-Platform-Anwendungen mit ASP.NET, ASP.NET Core, JavaScript
  C# 7.3 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
  Modern Data Access with Entity Framework Core: Database Programming Using .NET, .NET Core, UWP, and Xamarin with C#
  Windows PowerShell und PowerShell Core - Der schnelle Einstieg: Skriptbasierte Systemadministration für Windows, Linux und macOS
  Programmierung in Python
  C# 7.2 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
  Moderne Datenzugriffslösungen mit Entity Framework Core 2.0/2.1
  Effizienter Datenzugriff mit Entity Framework Core: Datenbankprogrammierung mit C# für .NET Framework, .NET Core und Xamarin
  Moderne Datenzugriffslösungen mit Entity Framework Core 2.0
  Windows PowerShell 5 und PowerShell Core 6 - Das Praxishandbuch
  Angular - Das Praxisbuch zu Grundlagen und Best Practices
  Moderne Datenzugriffslösungen mit Entity Framework Core 1.0, 1,1 und 2.0
  Moderne Datenzugriffslösungen mit Entity Framework Core 1.0, 1,1 und 2.0
  Moderne Datenzugriffslösungen mit Entity Framework Core 1.1 und 2.0-Preview2
  Moderne Datenzugriffslösungen mit Entity Framework Core 1.x und 2.0
  Moderne Datenzugriffslösungen mit Entity Framework Core 1.x und 2.0
  Introducing Regular Expressions: JavaScript and TypeScript
  Introducing Web Development
  Introducing Bootstrap 4
  Programming Web Applications with Node, Express and Pug
  Einführung in TypeScript: Grundlagen der Sprache TypeScript 2
  Pug – Die Template-Engine für node.js
  Web-Programmierung mit Node, Express und Pug
  Windows PowerShell 5 – kurz & gut
  Moderne Datenzugriffslösungen mit Entity Framework Core 1.1
  Windows PowerShell 5.0 - Das Praxishandbuch
  PHP 7 und MySQL: Von den Grundlagen bis zur professionellen Programmierung
  Windows Scripting Lernen
  .NET Praxis - Tipps und Tricks für .NET und Visual Studio
  Grundlagen für Web-Entwickler: Protokolle, HTML und CSS
  Bootstrap 3 - Stile und Komponenten
  Bootstrap 4 - Stile und Komponenten
  Einführung in JavaScript: ECMAScript 5
  Einführung in node.js
  express – Middleware für node.js
  JADE – Die Template Engine für node.js
  Reguläre Ausdrücke in JavaScript
  Moderne Datenzugriffslösungen mit Entity Framework 6
  C++ Standardbibliothek
  AngularJS: Moderne Webanwendungen und Single Page Applications mit JavaScript
  Microsoft SharePoint Server 2013 und SharePoint Foundation: Das umfassende Handbuch
  SQL Server 2014 für Professionals: Hochverfügbarkeit, Cloud-Szenarien, Backup/Restore, Monitoring & Performance
  Moderne Webanwendungen mit ASP.NET MVC und JavaScript
  Windows PowerShell 4.0 - Das Praxishandbuch
  JavaScript: Das umfassende Handbuch, inkl. HTML5, JavaScript-Frameworks, jQuery, OOP
  C++11 für Programmierer
  C++ kurz und gut
  Microsoft ASP.NET 4.5 - Entwicklerbuch
  Moderne Webanwendungen mit ASP.NET MVC
  Verteilte Systeme und Services mit .NET 4.5
  Scripting mit Windows PowerShell 3.0 - Der Workshop: Skript-Programmierung mit Windows PowerShell 3.0 vom Einsteiger bis zum Profi
  Windows 8 für Administratoren
  Windows 8.1 - Das Handbuch (27. November 2013)
  Windows Store Apps entwickeln mit C# und XAML - Crashkurs
  .NET 4.5 Update
  Windows Scripting Lernen
  WPF 4.5 und XAML
  Datenbankprogrammierung mit .NET 4.5
  C++11: Der Leitfaden für Programmierer zum neuen Standard
  Verteilte Systeme und Services mit .NET 4.0
  Microsoft ASP.NET 4.0 mit C# 2010 - Entwicklerbuch
  Agile Software Engineering with Visual Studio
  Datenbankprogrammierung mit .NET 4.0. Mit Visual Studio 2010 und SQL Server 2008 R2
  Microsoft SharePoint Server 2010 und SharePoint Foundation 2010
  Microsoft SQL Server 2008 R2 - Das Entwicklerbuch
  Microsoft Viusal C# 2010
  Office 2010 Programmierung mit VSTO und .NET 4.0: Word, Excel und Outlook erweitern und anpassen
  Programmieren mit dem ADO.NET Entity Framework
  .NET 4.0 Crashkurs
  Visual Basic 2010: Grundlagen, ADO.NET, Windows Presentation Foundation
  .NET 4.0 Update
  Windows PowerShell 2.0 - Das Praxishandbuch
  Windows 7 im Unternehmen
  Agile Muster und Methoden
  Ajax
  ASP.NET 4.0
  ASP.NET 4.0 mit Visual C# 2010
  JavaScript
  PHP 5-Migration
  Scripting mit Windows PowerShell 2.0 - Der Einsteiger-Workshop
  SQL Server 2008 R2: Das Programmierhandbuch. Inkl. ADO.NET 3.5, LINQ to Entities und LINQ to SQL
  Visual Basic 2010
  Windows PowerShell 2.0 - Crashkurs
  Windows Server 2008 R2
  Windows Scripting
  Windows Scripting Lernen
  Data Mining mit Microsoft SQL Server
  Windows 7 für Administratoren
  Microsoft ASP.NET 3.5 mit Visual Basic 2008 - Entwicklerbuch
  .NET 3.5
  Essential PowerShell
  .NET 3.5 Crashkurs
  Webanwendungen mit ASP.NET 3.5 und AJAX Crashkurs
 Alle unsere aktuellen Fachbücher  E-Book-Abo für ab 99 Euro im Jahr