Razor-Dateikompilierung in ASP.NET Core

Razor-Dateien mit der Erweiterung .cshtml werden sowohl zur Build- als auch zur Veröffentlichungszeit mit dem Razor SDK kompiliert. Die Kompilierung zur Laufzeit kann durch Konfigurieren des Projekts optional aktiviert werden.

Hinweis

Für die Laufzeitkompilierung gilt Folgendes:

• Sie wird für Razor-Komponenten von Blazor-Apps nicht unterstützt.
• Sie unterstützt keine globalen using-Anweisungen.
• Sie unterstützt keine impliziten using-Anweisungen.
• Sie deaktiviert .NET Hot Reload.
• Sie wird für die Entwicklung empfohlen, nicht für die Produktion.

Razor-Kompilierung

Die Kompilierung von Razor-Dateien zur Build- und Veröffentlichungszeit wird vom Razor SDK standardmäßig aktiviert. Wenn die Laufzeitkompilierung aktiviert ist, ergänzt sie die Buildzeitkompilierung, sodass Razor-Dateien aktualisiert werden können, wenn sie während der Ausführung der App bearbeitet werden.

Das Aktualisieren von Razor-Ansichten und Razor in der Entwicklung und während der Ausführung der App wird mithilfe von .NET Hot Reload ebenfalls unterstützt.

Hinweis

Wenn die Laufzeitkompilierung aktiviert ist, deaktiviert sie .NET Hot Reload. Es wird empfohlen, während der Entwicklung anstelle der Razor-Laufzeitkompilierung Hot Reload zu verwenden.

Aktivieren der Laufzeitkompilierung für alle Umgebungen

So aktivieren Sie die Laufzeitkompilierung für alle Umgebungen:

1. Installieren Sie das NuGet-Paket Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation.

2. Rufen Sie AddRazorRuntimeCompilation in Program.cs auf:

   var builder = WebApplication.CreateBuilder(args);
   
   builder.Services.AddRazorPages()
       .AddRazorRuntimeCompilation();
   

Bedingte Aktivierung der Laufzeitkompilierung

Die Laufzeitkompilierung kann bedingt aktiviert werden, wodurch sichergestellt wird, dass für die veröffentlichte Ausgabe Folgendes gilt:

• Es werden kompilierte Ansichten verwendet.
• Dateiüberwachungselemente in der Produktionsumgebung werden nicht aktiviert.

So aktivieren Sie die Laufzeitkompilierung nur für die Entwicklungsumgebung:

1. Installieren Sie das NuGet-Paket Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation.

2. Rufen Sie AddRazorRuntimeCompilation in Program.cs auf, wenn die aktuelle Umgebung auf „Entwicklung“ festgelegt ist:

   var builder = WebApplication.CreateBuilder(args);
   
   var mvcBuilder = builder.Services.AddRazorPages();
   
   if (builder.Environment.IsDevelopment())
   {
       mvcBuilder.AddRazorRuntimeCompilation();
   }
   

Die Kompilierung zur Laufzeit kann auch mit einer Hostingstartassembly aktiviert werden. So aktivieren Sie die Laufzeitkompilierung in der Entwicklungsumgebung für bestimmte Startprofile:

1. Installieren Sie das NuGet-Paket Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation.
2. Ändern Sie den Abschnitt environmentVariables des Startprofils in launchSettings.json:

   • Überprüfen Sie, ob ASPNETCORE_ENVIRONMENT auf "Development" festgelegt ist.

   • Legen Sie ASPNETCORE_HOSTINGSTARTUPASSEMBLIES auf "Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation" fest. Beispielsweise aktiviert die folgende launchSettings.json die Laufzeitkompilierung für die Startprofile ViewCompilationSample und IIS Express:

     {
       "iisSettings": {
         "windowsAuthentication": false,
         "anonymousAuthentication": true,
         "iisExpress": {
           "applicationUrl": "http://localhost:7098",
           "sslPort": 44332
         }
       },
       "profiles": {
         "ViewCompilationSample": {
           "commandName": "Project",
           "dotnetRunMessages": true,
           "launchBrowser": true,
           "applicationUrl": "https://localhost:7173;http://localhost:5251",
           "environmentVariables": {
             "ASPNETCORE_ENVIRONMENT": "Development",
             "ASPNETCORE_HOSTINGSTARTUPASSEMBLIES": "Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation"
           }
         },
         "IIS Express": {
           "commandName": "IISExpress",
           "launchBrowser": true,
           "environmentVariables": {
             "ASPNETCORE_ENVIRONMENT": "Development",
             "ASPNETCORE_HOSTINGSTARTUPASSEMBLIES": "Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation"
           }
         }
       }
     }
     

Bei dieser Vorgehensweise sind keine Codeänderungen in Program.cs erforderlich. Zur Laufzeit sucht ASP.NET Core nach einem HostingStartup-Attribut auf Assemblyebene in Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation. Das HostingStartup-Attribut gibt den Code an, der zum Starten der App ausgeführt werden soll, und dieser Startcode aktiviert die Laufzeitkompilierung.

Aktivieren der Laufzeitkompilierung für eine Razor-Klassenbibliothek

Stellen Sie sich ein Szenario vor, in dem ein Razor Pages-Projekt auf eine Razor-Klassenbibliothek (Razor Class Library, RCL) namens MyClassLib verweist. Die RCL enthält eine _Layout.cshtml-Datei, die von MVC und Razor Pages-Projekten genutzt wird. Um die Laufzeitkompilierung für die _Layout.cshtml-Datei in dieser RCL zu aktivieren, ändern Sie das Razor Pages-Projekt folgendermaßen:

1. Aktivieren Sie die Laufzeitkompilierung mithilfe der Anweisungen unter Bedingte Aktivierung der Laufzeitkompilierung.

2. Konfigurieren Sie MvcRazorRuntimeCompilationOptions in Program.cs:

   var builder = WebApplication.CreateBuilder(args);
   
   builder.Services.AddRazorPages();
   
   builder.Services.Configure<MvcRazorRuntimeCompilationOptions>(options =>
   {
       var libraryPath = Path.GetFullPath(
           Path.Combine(builder.Environment.ContentRootPath, "..", "MyClassLib"));
   
       options.FileProviders.Add(new PhysicalFileProvider(libraryPath));
   });
   

   Der obige Code erstellt einen absoluten Pfad zur RCL MyClassLib. Die PhysicalFileProvider-API wird verwendet, um Verzeichnisse und Dateien in diesem absoluten Pfad zu finden. Schließlich wird die PhysicalFileProvider-Instanz zur Sammlung eines Dateianbieters hinzugefügt, was Zugriff auf die .cshtml-Dateien der RCL ermöglicht.

Zusätzliche Ressourcen

• RazorCompileOnBuild und RazorCompileOnPublish – Eigenschaften
• Einführung in Razor Pages in ASP.NET Core
• Ansichten in ASP.NET Core MVC
• ASP.NET Core Razor SDK