ASP.NET Core での Razor ファイルのコンパイル

[アーティクル]
11/30/2023

.cshtml 拡張子の Razor ファイルは、Razor SDK を使用してビルド時と公開時にコンパイルされます。ランタイムコンパイルは、必要に応じて、プロジェクトを構成することで有効にできることがあります。

Note

ランタイムコンパイル:

Blazor アプリの Razor コンポーネントではサポートされていません。
global using ディレクティブはサポートされていません。
暗黙的な using ディレクティブはサポートされていません。
.NET ホットリロードを無効にします。
運用環境ではなく、開発に推奨されます。

Razor のコンパイル

Razor ファイルのビルド時および発行時のコンパイルは、既定で Razor SDK によって有効になっています。有効になっていると、ランタイムコンパイルはビルド時のコンパイルを補完し、アプリの実行中に編集された Razor ファイルを更新できます。

アプリの実行中の開発中に Razor ビューと Razor Pages を更新することも、.NET ホットリロードを使用してサポートされます。

Note

有効にすると、ランタイムコンパイルによって .NET ホットリロードが無効になります。開発中に Razor ランタイムコンパイルの代わりにホットリロードを使用することをお勧めします。

すべての環境でランタイムコンパイルを有効にする

すべての環境でランタイムコンパイルを有効にするには:

Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation NuGet パッケージをインストールします。

Program.cs 内で AddRazorRuntimeCompilation を呼び出します:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages()
    .AddRazorRuntimeCompilation();

ランタイムコンパイルを条件付きで有効にする

ランタイムコンパイルは条件付きで有効にできます。これにより、発行された出力が確実に有効になります:

コンパイル済みのビューを使用する。
運用環境のファイル監視を有効にしない。

開発環境でのみランタイムコンパイルを有効にするには:

Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation NuGet パッケージをインストールします。

現在の環境が開発に設定されている場合は、Program.cs で AddRazorRuntimeCompilation を呼び出します:

var builder = WebApplication.CreateBuilder(args);

var mvcBuilder = builder.Services.AddRazorPages();

if (builder.Environment.IsDevelopment())
{
    mvcBuilder.AddRazorRuntimeCompilation();
}

ランタイムコンパイルは、ホスティングスタートアップアセンブリで有効にすることもできます。特定の起動プロファイルに対して開発環境でランタイムコンパイルを有効にするには:

Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation NuGet パッケージをインストールします。

launchSettings.json で起動プロファイルの environmentVariables セクションを変更します:

ASPNETCORE_ENVIRONMENT が "Development" に設定されていることを確認します。

ASPNETCORE_HOSTINGSTARTUPASSEMBLIES を "Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation" に設定します。たとえば、次の launchSettings.json では、ViewCompilationSample および 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"
      }
    }
  }
}

この方法では、Program.cs でコードを変更する必要はありません。実行時に、ASP.NET Core によって Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation でアセンブリレベルの HostingStartup 属性が検索されます。 HostingStartup 属性は、実行するアプリのスタートアップコードを指定し、そのスタートアップコードでランタイムコンパイルを有効にします。

Razor クラスライブラリのランタイムコンパイルを有効にする

Razor Pages プロジェクトが MyClassLib という名前の Razor クラスライブラリ (RCL) を参照するシナリオについて考えてみます。 RCL には、MVC および Razor Pages プロジェクトによって使用される _Layout.cshtml ファイルが含まれています。その RCL 内の _Layout.cshtml ファイルのランタイムコンパイルを有効にするには、Razor Pages プロジェクトで次の変更を行います:

「既存のプロジェクトでランタイムコンパイルを条件付きで有効にする」の手順に従って、ランタイムコンパイルを有効にします。
Program.cs で MvcRazorRuntimeCompilationOptions を構成します。
```
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 ファイルにアクセスできるようになります。

その他のリソース

.cshtml 拡張子の Razor ファイルは、Razor SDK を使用してビルド時と公開時にコンパイルされます。実行時コンパイルは、プロジェクトを構成することで必要に応じて有効にできることがあります。

Razor のコンパイル

Razor ファイルのビルド時および発行時のコンパイルは、既定で Razor SDK によって有効になっています。有効になっていると、実行時コンパイルはビルド時のコンパイルを補完し、編集された Razor ファイルを更新できます。

プロジェクト作成時に実行時コンパイルを有効にする

Razor Pages および MVC プロジェクトテンプレートには、プロジェクトの作成時に実行時コンパイルを有効にするオプションが含まれています。このオプションは、ASP.NET Core 3.1 以降でのみサポートされます。

Visual Studio
.NET CLI

[新しい ASP.NET Core Web アプリケーションの作成] ダイアログで:

Web アプリケーションまたは Web アプリケーション (Model-View-Controller) のいずれかのプロジェクトテンプレートを選択します。
[Enable Razor runtime compilation]\(Razor の実行時コンパイルを有効にする\) チェックボックスをオンにします。

-rrc または --razor-runtime-compilation のテンプレートオプションを使用します。たとえば、次のコマンドは、実行時コンパイルを有効にした新しい Razor Pages プロジェクトを作成します。

dotnet new webapp --razor-runtime-compilation

既存のプロジェクトで実行時コンパイルを有効にする

既存のプロジェクト内のすべての環境で実行時コンパイルを有効にするには:

Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation NuGet パッケージをインストールします。

プロジェクトの Startup.ConfigureServices メソッドを更新して、AddRazorRuntimeCompilation の呼び出しを含めます。次に例を示します。

public void ConfigureServices(IServiceCollection services)
{
    services.AddRazorPages()
        .AddRazorRuntimeCompilation();

    // code omitted for brevity
}

既存のプロジェクトで実行時コンパイルを条件付きで有効にする

実行時コンパイルをローカル開発でのみ有効にできます。このようにして条件付きで有効にすることにより、次のような出力が発行されるようにできます。

コンパイル済みのビューを使用する。
運用環境のファイル監視を有効にしない。

開発環境でのみ実行時コンパイルを有効にするには:

Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation NuGet パッケージをインストールします。
launchSettings.json で起動プロファイルの environmentVariables セクションを変更します。
- ASPNETCORE_ENVIRONMENT が "Development" に設定されていることを確認します。
- ASPNETCORE_HOSTINGSTARTUPASSEMBLIES を "Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation" に設定します。

次の例では、IIS Express および RazorPagesApp 起動プロファイルの開発環境で実行時コンパイルが有効になっています。

{
    "iisSettings": {
      "windowsAuthentication": false,
      "anonymousAuthentication": true,
      "iisExpress": {
        "applicationUrl": "http://localhost:57676",
        "sslPort": 44364
      }
    },
    "profiles": {
      "IIS Express": {
        "commandName": "IISExpress",
        "launchBrowser": true,
        "environmentVariables": {
          "ASPNETCORE_ENVIRONMENT": "Development",
          "ASPNETCORE_HOSTINGSTARTUPASSEMBLIES": "Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation"
        }
      },
      "RazorPagesApp": {
        "commandName": "Project",
        "launchBrowser": true,
        "applicationUrl": "https://localhost:5001;http://localhost:5000",
        "environmentVariables": {
          "ASPNETCORE_ENVIRONMENT": "Development",
          "ASPNETCORE_HOSTINGSTARTUPASSEMBLIES": "Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation"
        }
      }
    }
  }

プロジェクトの Startup クラスでコードを変更する必要はありません。実行時に、ASP.NET Core によって Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation でアセンブリレベルの HostingStartup 属性が検索されます。 HostingStartup 属性は、実行するアプリのスタートアップコードを指定します。そのスタートアップコードによって実行時コンパイルが可能になります。

Razor クラスライブラリのランタイムコンパイルを有効にする

Razor Pages プロジェクトが MyClassLib という名前の Razor クラスライブラリ (RCL) を参照するシナリオについて考えてみます。 RCL には、チームのすべての MVC および Razor Pages プロジェクトで使用される _Layout.cshtml ファイルが含まれています。その RCL 内の _Layout.cshtml ファイルの実行時コンパイルを有効にする必要があります。 Razor Pages プロジェクトに、次の変更を加えます。

「既存のプロジェクトで実行時コンパイルを条件付きで有効にする」の手順に従って、実行時コンパイルを有効にします。
Startup.ConfigureServices で実行時コンパイルオプションを構成します。
```
public void ConfigureServices(IServiceCollection services)
{
    services.AddRazorPages();

    services.Configure<MvcRazorRuntimeCompilationOptions>(options =>
    {
        var libraryPath = Path.GetFullPath(
            Path.Combine(HostEnvironment.ContentRootPath, "..", "MyClassLib"));
        options.FileProviders.Add(new PhysicalFileProvider(libraryPath));
    });
}
```
前のコードでは、MyClassLib RCL への絶対パスが構築されます。 PhysicalFileProvider API は、その絶対パスにあるディレクトリとファイルを検索するために使用されます。最後に、PhysicalFileProvider インスタンスがファイルプロバイダーコレクションに追加されます。これにより、RCL の .cshtml ファイルにアクセスできるようになります。

次の方法で共有

ASP.NET Core での Razor ファイルのコンパイル

Razor のコンパイル

すべての環境でランタイム コンパイルを有効にする

ランタイム コンパイルを条件付きで有効にする

Razor クラス ライブラリのランタイム コンパイルを有効にする

その他のリソース

Razor のコンパイル

プロジェクト作成時に実行時コンパイルを有効にする

既存のプロジェクトで実行時コンパイルを有効にする

既存のプロジェクトで実行時コンパイルを条件付きで有効にする

Razor クラス ライブラリのランタイム コンパイルを有効にする

その他のリソース

その他のリソース

すべての環境でランタイムコンパイルを有効にする

ランタイムコンパイルを条件付きで有効にする

Razor クラスライブラリのランタイムコンパイルを有効にする

Razor クラスライブラリのランタイムコンパイルを有効にする