Umgebungstaghilfsprogramm in ASP.NET Core

  • Artikel

Von Peter Kellner und Hisham Bin Ateya

Basierend auf der aktuellen Hostingumgebung rendert das Environment-Taghilfsprogramm den von ihm eingeschlossenen Inhalt unter Vorbehalt. Das einzelne Attribut names des Environment-Taghilfsprogramm ist eine durch Trennzeichen getrennte Liste von Umgebungsnamen. Wenn die Namen der bereitgestellten Umgebung der aktuellen Umgebung entsprechen, wird der eingeschlossene Inhalt gerendert.

Eine Übersicht über Taghilfsprogramme finden Sie unter Taghilfsprogramme in ASP.NET Core.

Attribute von Umgebungstaghilfsprogrammen

Namen

names akzeptiert den Namen einer einzelnen Hostingumgebung oder eine durch Trennzeichen getrennte Liste mit Namen von Hostingumgebungen, die das Rendering des eingeschlossenen Inhalts auslösen.

Umgebungswerte werden mit dem aktuellen Wert verglichen, der durch IWebHostEnvironment.EnvironmentName zurückgegeben wird. Bei dem Vergleich wird die Groß-/Kleinschreibung ignoriert.

Im folgenden Beispiel wird ein Environment-Taghilfsprogramm verwendet: Der Inhalt wird wiedergegeben, wenn es sich bei der Hostumgebung um eine Staging- oder Produktionsumgebung handelt:

<environment names="Staging,Production">
    <strong>IWebHostEnvironment.EnvironmentName is Staging or Production</strong>
</environment>

Die Attribute „include“ und „exclude“

Die Attribute „include“ und „exclude“ steuern das Rendern des eingeschlossenen Inhalts anhand der eingeschlossenen bzw. ausgeschlossenen Namen von Hostingumgebungen.

include

Die include-Eigenschaft zeigt ein ähnliches Verhalten wie das Attribut names. Eine im Attributwert include aufgeführte Umgebung muss der App-Hostingumgebung (IWebHostEnvironment.EnvironmentName) entsprechen, damit der Inhalt des Tags <environment> gerendert werden kann.

<environment include="Staging,Production">
    <strong>IWebHostEnvironment.EnvironmentName is Staging or Production</strong>
</environment>

Ausschließen

Im Gegensatz zum Attribut include wird der Inhalt des <environment>-Tags gerendert, wenn die Hostingumgebung nicht einer Umgebung entspricht, die im Attributwert exclude aufgeführt wird.

<environment exclude="Development">
    <strong>IWebHostEnvironment.EnvironmentName is not Development</strong>
</environment>

Zusätzliche Ressourcen