ASP.NET Core 中的 Razor 文件编译

扩展名为 .cshtml 的 Razor 文件是在生成和发布时使用 Razor SDK 编译的。 通过配置项目，可以选择启用运行时编译。

备注

运行时编译：

• 不受 Blazor 应用的 Razor 组件支持。
• 不支持全局使用指令。
• 不支持隐式使用指令。
• 禁用 .NET 热重载。
• 建议用于开发，而不是生产。

Razor 编译

Razor SDK 默认启用 Razor 文件的生成时和发布时编译。 启用后，运行时编译将会对生成时编译进行补充，从而允许更新 Razor 文件（如果在应用运行时对其进行编辑）。

使用 .NET 热重载还支持在应用程序运行的同时在开发过程中更新 Razor 视图和 Razor 页面。

备注

启用后，运行时编译将禁用 .NET 热重载。 建议在开发期间使用热重载而不是 Razor 运行时编译。

为所有环境启用运行时编译

要为所有环境启用运行时编译，请：

1. 安装 Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation NuGet 包。

2. 在 Program.cs 中调用 AddRazorRuntimeCompilation：

   C#

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

有条件地启用运行时编译

运行时编译可以有条件地启用，这可确保发布的输出：

• 使用编译视图。
• 不会在生产环境中启用文件观察程序。

如果要仅在开发环境中启用运行时编译：

1. 安装 Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation NuGet 包。

2. 在当前环境设置为开发时，代用 Program.cs 中的 AddRazorRuntimeCompilation：

   C#

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

还可以使用托管启动程序集来启用运行时编译。 要在开发环境中为特定启动配置文件启用运行时编译，请执行以下操作：

1. 安装 Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation NuGet 包。
2. 在 launchSettings.json 中修改启动配置文件的environmentVariables 部分：

   • 验证 ASPNETCORE_ENVIRONMENT 是否设置为 "Development"。

   • 将 ASPNETCORE_HOSTINGSTARTUPASSEMBLIES 设置为 "Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation"。 例如，以下 launchSettings.json 可为 ViewCompilationSample 和 IIS Express 启动配置文件启用运行时编译：

     JSON

     {
       "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"
           }
         }
       }
     }
     

使用此方法时，无需在 Program.cs 中更改代码。 在运行时，ASP.NET Core 在 Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation 中搜索 assembly-level HostingStartup attribute 属性。 属性 HostingStartup 指定了要执行的应用启动代码，并且该启动代码会启用运行时编译。

为 Razor 类库启用运行时编译

考虑一个方案，其中 Razor Pages 项目将会引用名为 MyClassLib 的 Razor 类库 (RCL)。 该 RCL 包含由 MVC 和 Razor Pages 项目使用的 _Layout.cshtml 文件。 要对该 RCL 中的 _Layout.cshtml 文件启用运行时编译，请在 Razor Pages 项目中进行以下更改：

1. 按照有条件地启用运行时编译中的说明启用运行时编译。

2. 在 Program.cs 中配置 MvcRazorRuntimeCompilationOptions：

   C#

   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));
   });
   

   前面的代码生成了指向 MyClassLib RCL 的绝对路径。 PhysicalFileProvider API 用于查找该绝对路径中的目录和文件。 最后，将 PhysicalFileProvider 实例添加到文件提供程序集合，该集合支持访问 RCL 的 .cshtml 文件。

其他资源

• RazorCompileOnBuild 和 RazorCompileOnPublish 属性
• ASP.NET Core 中的 Razor Pages 简介
• ASP.NET Core MVC 中的视图
• ASP.NET Core Razor SDK