Mit der Web.config bietet .NET eine zentrale Konfigurationsdatei f\u00fcr verschiedene Optionen der jeweiligen Anwendung. So kann beispielsweise die Ziel-Version des .NET Frameworks festgelegt werden. Sp\u00e4testens bei etwas komplexeren Anwendungen wird man den Bedarf feststellen, gewisse Parameter zur Laufzeit ver\u00e4ndern zu wollen. Dies erh\u00f6ht die Flexibilit\u00e4t und Wartbarkeit gegen\u00fcber hart kodierten Werten. Warum die eigenen Konfigurationsparameter nicht gleich in die bereits existierende Web.config einbinden? Damit f\u00e4llt das suchen in verschiedenen Dateien weg, da alles zentral in einer Konfigurationsdatei definiert ist. Dieser Artikel zeigt, wie man eigene Parameter in der Datei unterbringt und auf sie zugreift.<\/p>\n
Am einfachsten funktioniert dies mit Schl\u00fcssel-Wert Paaren oder auch KeyValue-Pair<\/strong> genannt. Man hat in diesem Fall also nur einen einzigen benannten Schl\u00fcssel, dem ein bestimmter Wert zugewiesen wird. Beispielsweise k\u00f6nnte man so einen Debug-Modus aktivieren oder einen Basis-Host definieren, der f\u00fcr bestimmte Abfragen (etwa an eine API) verwendet wird.\u00a0Im <config><\/strong> Knoten suchen wir daf\u00fcr nach <appSettings><\/strong>. Je nach Anwendungstyp ist dieser bereits vorhanden und mit einigen Schl\u00fcsselpaaren gef\u00fcllt, etwa in ASP.NET Webanwendungen. Falls nicht, kann dieser als leerer XML-Tag erstellt werden:<\/p>\n In den\u00a0appSettings<\/strong> k\u00f6nnen wir nun\u00a0mit dem\u00a0add<\/strong> Element ein Schl\u00fcsselpaar hinzuf\u00fcgen:<\/p>\n Schl\u00fcssel (key) und Wert (value) k\u00f6nnen hierbei frei gew\u00e4hlt werden. Im Code der Anwendung lassen sich die Werte \u00fcber die ConfigurationManager-Klasse auslesen, wozu der Namensraum\u00a0System.Configuration<\/strong> importiert werden muss:<\/p>\n Das Umwandeln in den jeweiligen Zieltyp wird auf diese Art jedoch sp\u00e4testens dann l\u00e4stig, wenn man mehrere Integer- bzw. Boolean-Werte auslesen m\u00f6chte. Leider k\u00f6nnen wir die ConfigurationManager-Klasse nicht mit einer Erweiterungsmethode erg\u00e4nzen, da sie statisch ist. Daher ist eine kleine Hilfsklasse n\u00f6tig:<\/p>\n Damit wird der Aufruf schon deutlich \u00fcbersichtlicher:<\/p>\n Um den Scope m\u00f6glichst gering zu halten und die Fehleranf\u00e4lligkeit zu verringern, empfiehlt sich zudem eine Wrapper-Klasse:<\/p>\n Sp\u00e4testens wenn man mehrere zusammengeh\u00f6rende Werte speichern m\u00f6chte, ist die L\u00f6sung \u00fcber Schl\u00fcssel-Wert Paare nicht optimal. Doch daran wurde in .NET ebenfalls gedacht: Man kann \u00e4hnlich einfach benutzerdefinierte Bereiche (sogenannte\u00a0Sections<\/strong>) erstellen, denen sich beliebige Eigenschaften zuweisen lassen. Dazu erstellen wir zun\u00e4chst eine Wrapper-Klasse, die von ConfigurationSection<\/strong> erbt:<\/p>\n In der Web.config muss dieser Wrapper nun in den configSections<\/strong> registriert werden: <\/p>\n Zu beachten ist, dass in der type<\/strong> Eigenschaft der vollqualifizierte Name angegeben werden muss – Also im Format Namespace.Klasse! <\/p>\n Anschlie\u00dfend k\u00f6nnen wir den Bereich selbst definieren und entsprechend unseres Wrappers mit den ben\u00f6tigten Eigenschaften ausstatten:<\/p>\n Zu guter Letzt wollen wir die dort angegebenen Werte nat\u00fcrlich noch codeseitig auslesen. \u00dcber die GetSection<\/strong> Methode des Konfigurationsmanagers erhalten wir eine Instanz dieser Wrapper-Klasse und k\u00f6nnen auf die Attribute zugreifen: <\/p>\n Der Vorteil besteht hierbei in der m\u00f6glichen Verfeinerung der Konfiguration \u00fcber DataAnnotiation-Attribute. Beispielsweise k\u00f6nnen wir im ConfigurationProperty<\/strong> mit der Eigenschaft DefaultValue<\/strong> einen Standardwert festlegen, wodurch wiederholende Pr\u00fcfungen und Zuweisungen vermieden werden:<\/p>\n Auch umfangreichere Validierungen sind m\u00f6glich. So l\u00e4sst sich beispielsweise die L\u00e4nge von Strings begrenzen oder ihr Inhalt mit regul\u00e4ren Ausdr\u00fccken pr\u00fcfen. Dies weiter auszuf\u00fchren w\u00fcrde den Rahmen dieses Artikels jedoch etwas sprengen. Au\u00dferdem gibt es diesbez\u00fcglich bereits einen guten Artikel in der MSDN von Microsoft: Erstellen von benutzerdefinierten Konfigurationsabschnitten mit ConfigurationSection<\/a><\/p>\n","protected":false},"excerpt":{"rendered":" Mit der Web.config bietet .NET eine zentrale Konfigurationsdatei f\u00fcr verschiedene Optionen der jeweiligen Anwendung. So kann beispielsweise die Ziel-Version des .NET Frameworks festgelegt werden. Sp\u00e4testens bei etwas komplexeren Anwendungen wird man den Bedarf feststellen, gewisse Parameter zur Laufzeit ver\u00e4ndern zu wollen. Dies erh\u00f6ht die Flexibilit\u00e4t und Wartbarkeit gegen\u00fcber hart kodierten Werten. Warum die eigenen Konfigurationsparameter …<\/p>\n","protected":false},"author":5,"featured_media":3496,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[61],"tags":[331,336,413,426,330,408],"class_list":["post-3484","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-softwareentwicklung","tag-net","tag-asp-net","tag-asp-net-mvc","tag-asp-net-mvc6","tag-c","tag-web-config"],"_links":{"self":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts\/3484","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/comments?post=3484"}],"version-history":[{"count":14,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts\/3484\/revisions"}],"predecessor-version":[{"id":3930,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts\/3484\/revisions\/3930"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/media\/3496"}],"wp:attachment":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/media?parent=3484"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/categories?post=3484"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/tags?post=3484"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}\r\n<?xml version="1.0" encoding="utf-8"?>\r\n<configuration>\r\n <appSettings>\r\n <\/appSettings>\r\n<\/configuration>\r\n<\/pre>\n
\r\n<appSettings>\r\n <add key="enableDebugOutput" value="true" \/>\r\n<\/appSettings>\r\n<\/pre>\n
\r\nbool debugModeEnabled = Convert.ToBoolean(ConfigurationManager.AppSettings["enableDebugOutput"]);\r\n<\/pre>\n
\r\nusing System.ComponentModel;\r\nusing System.Configuration;\r\n\r\npublic static class AppSettings {\r\n \/\/\/ <summary>\r\n \/\/\/ Gibt den Wert eines Schl\u00fcssels im appSettings-Knoten der Web.config stark typisert zur\u00fcck oder wirft eine Exception, wenn der Wert nicht vorhanden bzw. leer ist. \r\n \/\/\/ <\/summary>\r\n \/\/\/ <typeparam name="T">Typ des R\u00fcckgabewertes<\/typeparam>\r\n \/\/\/ <param name="key">Schl\u00fcssel des KeyValue-Pairs in der Konfigurationsdatei<\/param>\r\n \/\/\/ <returns><\/returns>\r\n public static T Get<T>(string key) {\r\n var appSetting = ConfigurationManager.AppSettings[key];\r\n if (string.IsNullOrWhiteSpace(appSetting)) {\r\n var exceptionMessage = string.Format("Der Schl\u00fcssel '{0}' wurde im appSettings-Abschnitt nicht gefunden oder besitzt einen leeren Wert!", key);\r\n throw new ConfigurationErrorsException(exceptionMessage);\r\n }\r\n\r\n var converter = TypeDescriptor.GetConverter(typeof(T));\r\n return (T)(converter.ConvertFromInvariantString(appSetting));\r\n }\r\n}\r\n<\/pre>\n\r\nbool debugModeEnabled = AppSettings.Get<bool>("enableDebugOutput");\r\n<\/pre>\n\r\npublic static class MySettings {\r\n public static bool DebugModeEnabled {\r\n get {\r\n return AppSettings.Get<bool>("enableDebugOutput");\r\n }\r\n }\r\n}\r\n<\/pre>\nEigene Bereich\u00a0erstellen<\/strong><\/h3>\n
\r\nusing System.Configuration;\r\n\r\npublic class DebugOptionsSection : ConfigurationSection {\r\n\r\n [ConfigurationProperty("enableDebugOutput")]\r\n public bool EnableDebugOutput {\r\n get { return (bool)this["enableDebugOutput"]; }\r\n }\r\n\r\n [ConfigurationProperty("debugLogFile")]\r\n public string DebugLogFile {\r\n get { return (string)this["debugLogFile"]; }\r\n }\r\n}\r\n<\/pre>\n\r\n[csharp]\r\nusing System.Configuration;\r\n\r\npublic class DebugOptionsSection : ConfigurationSection {\r\n\r\n [ConfigurationProperty("enableDebugOutput")]\r\n public bool EnableDebugOutput {\r\n get { return (bool)this["enableDebugOutput"]; }\r\n }\r\n\r\n [ConfigurationProperty("debugLogFile")]\r\n public string DebugLogFile {\r\n get { return (string)this["debugLogFile"]; }\r\n }\r\n}\r\n[\/csharp]\r\n<\/pre>\n\r\n<configuration>\r\n <configSections>\r\n <section name="debugOptionsSection" type="ULabs.DebugOptionSection" \/>\r\n <\/configSections>\r\n<\/configuration>\r\n<\/pre>\n
\r\n<configuration>\r\n <debugOptionsSection enableDebugOutput="true" debugLogFile="debug.log" \/>\r\n<\/configuration>\r\n<\/pre>\n
\r\nvar debugConfig = (DebugOptionsSection)ConfigurationManager.GetSection("debugOptionsSection");\r\nif(debugConfig.EnableDebugOutput) {\r\n \/\/ Debug-Ausgabe aktiviert\r\n}\r\n<\/pre>\n\r\n [ConfigurationProperty("enableDebugOutput", DefaultValue = false)]\r\n public bool EnableDebugOutput {\r\n get { return (bool)this["enableDebugOutput"]; }\r\n }\r\n<\/pre>\n