Compilación de archivos de Razor en ASP.NET Core

Los archivos de Razor con una extensión .cshtml se compilan en tiempo de compilación y publicación mediante el SDK de Razor. La compilación en tiempo de ejecución se puede habilitar opcionalmente mediante la configuración del proyecto.

Nota:

Compilación en tiempo de ejecución:

• No se admite para los componentes Razor de las aplicaciones Blazor.
• No admite directivas using globales.
• No admite directivas using implícitas.
• Deshabilita la Recarga activa de .NET.
• Se recomienda para el desarrollo, no para la producción.

Compilación Razor

El SDK de Razor habilita de forma predeterminada la compilación en tiempo de compilación y la compilación en tiempo de publicación de los archivos Razor. Cuando se habilita, la compilación en tiempo de ejecución complementa la compilación en tiempo de compilación, lo que permite actualizar los archivos Razor si se editan mientras se ejecuta la aplicación.

La actualización de vistas Razor y Razor Pages durante el desarrollo mientras se ejecuta la aplicación también se admite mediante Recarga activa .NET.

Nota:

Cuando está habilitada, la compilación en tiempo de ejecución deshabilita la Recarga activa de .NET. Se recomienda usar la Recarga activa en lugar de la compilación en tiempo de ejecución Razor durante el desarrollo.

Habilitación de la compilación en tiempo de ejecución para todos los entornos

Para habilitar la compilación en tiempo de ejecución para todos los entornos:

1. Instala el paquete NuGet Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation.

2. Llama a AddRazorRuntimeCompilation en Program.cs:

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

Habilitación condicional de la compilación en tiempo de ejecución

La compilación en tiempo de ejecución se puede habilitar condicionalmente, lo que garantiza que la salida publicada:

• Usa vistas precompiladas.
• No habilita monitores de archivos en producción.

Para habilitar la compilación en tiempo de ejecución solo para el entorno de Desarrollo:

1. Instala el paquete NuGet Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation.

2. Llama a AddRazorRuntimeCompilation en Program.cs cuando el entorno actual esté establecido en Desarrollo:

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

La compilación en tiempo de ejecución también se puede habilitar con un ensamblado de inicio de hospedaje. Para habilitar la compilación en tiempo de ejecución en el entorno de Desarrollo para perfiles de inicio específicos:

1. Instala el paquete NuGet Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation.
2. Modifica la sección environmentVariables del perfil de inicio en launchSettings.json:

   • Comprobar que ASPNETCORE_ENVIRONMENT está establecido en "Development".

   • Establece ASPNETCORE_HOSTINGSTARTUPASSEMBLIES en "Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation". Por ejemplo, el siguiente launchSettings.json habilita la compilación en tiempo de ejecución para los perfiles de inicio ViewCompilationSample y 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"
           }
         }
       }
     }
     

Con este enfoque, no se necesitan cambios de código en Program.cs. En tiempo de ejecución, ASP.NET Core busca un atributo HostingStartup de nivel de ensamblado en Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation. El atributo HostingStartup especifica el código de inicio de la aplicación que se va a ejecutar y ese código de inicio permite la compilación en tiempo de ejecución.

Habilitación de la compilación en tiempo de ejecución para una biblioteca de clases de Razor

Considera un escenario en el que un proyecto de Razor Pages hace referencia a una biblioteca de clases de Razor (RCL) denominada MyClassLib. La RCL contiene un archivo _Layout.cshtml consumido por los proyectos de MVC y Razor Pages. Para habilitar la compilación en tiempo de ejecución para el archivo _Layout.cshtml en esa RCL, realice los siguientes cambios en el proyecto Razor Pages:

1. Habilita la compilación en tiempo de ejecución con las instrucciones de Habilitación condicional de la compilación en tiempo de ejecución.

2. Configura MvcRazorRuntimeCompilationOptions en 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));
   });
   

   El código anterior crea una ruta de acceso absoluta a la RLC MyClassLib. La API PhysicalFileProvider se usa para buscar directorios y archivos en esa ruta de acceso absoluta. Por último, la instancia PhysicalFileProvider se agrega a una colección de proveedores de archivos, que permite el acceso a los archivos .cshtml de la RCL.

Recursos adicionales

• Propiedades RazorCompileOnBuild y RazorCompileOnPublish
• Introducción a Razor Pages en ASP.NET Core
• Vistas de ASP.NET Core MVC
• SDK de Razor de ASP.NET Core