.NET Aspire Redis ^* 出力キャッシュ統合 ®

[アーティクル]
02/05/2025

.NET Aspire Redis 出力キャッシュ統合を使用する方法について説明します。 Aspire.StackExchange.Redis.OutputCaching クライアント統合は、ASP.NET Core サーバーによってサポートされる Redis プロバイダーを、docker.io/library/redis コンテナーイメージに登録するために使用されます。

.NET Aspire Redis 出力キャッシュ統合を使用する方法について説明します。 Aspire.StackExchange.Redis.OutputCaching クライアント統合は、ASP.NET Core サーバーによってサポートされる出力キャッシュプロバイダーを、ghcr.io/microsoft/garnet コンテナーイメージに登録するために使用されます。

.NET Aspire Redis 出力キャッシュ統合を使用する方法について説明します。 Aspire.StackExchange.Redis.OutputCaching クライアント統合は、ASP.NET Core サーバーによってサポートされる出力キャッシュプロバイダーを、docker.io/valkey/valkey コンテナーイメージに登録するために使用されます。

ホスティング統合

Redis ホスティング統合は、Redis の種類として RedisResource リソースをモデル化します。アプリホストプロジェクト内のリソースとして表現するために、この種類と API にアクセスするには、📦Aspireホスティング.Redis NuGet パッケージを追加します。

.NET コマンドラインインターフェース
PackageReference

dotnet add package Aspire.Hosting.Redis

<PackageReference Include="Aspire.Hosting.Redis"
                  Version="*" />

詳細については、「dotnet パッケージの追加」または「.NET アプリケーションでのパッケージの依存関係の管理」を参照してください。

リソース Redisを追加する

アプリホストプロジェクトで、AddRedis インスタンスの builder を呼び出して、Redis リソースを追加します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddRedis("cache");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

.NET .NET Aspire 前の例で示したように、docker.io/Redis/Redis イメージでコンテナーイメージをアプリホストに追加すると、ローカルコンピューターに新しい Redis インスタンスが作成されます。 Redis リソース (cache 変数) への参照が ExampleProjectに追加されます。

WithReference メソッドは、ExampleProjectという名前の "cache" で接続を構成します。詳細については、「コンテナーリソースのライフサイクルの」を参照してください。

アドバイス

既存の Redis インスタンスに接続する場合は、代わりに AddConnectionString 呼び出します。詳細については、「既存のリソースを参照する」を参照してください。

Redis Insights を使用してリソース Redis 追加する

Redis Insights を Redis リソースに追加するには、WithRedisInsight メソッドを呼び出します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddRedis("cache")
                   .WithRedisInsight();

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

Redis Insights は、AI アシスタントである Copilot Redis の助けを借りて、すべてのオペレーティングシステムと Redis デプロイの Redis データを分析するための無料のグラフィカルインターフェイスです。 .NET .NET Aspire は、コマンダーアプリを実行する別のコンテナーイメージ docker.io/redis/redisinsight をアプリホストに追加します。

手記

RedisInsightResource のホストポートを構成するには、WithHostPort API への呼び出しをチェーンし、目的のポート番号を指定します。

Redis リソースをRedis コマンダーで追加する

Redis リソースにを追加するには、Redis メソッドを呼び出します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddRedis("cache")
                   .WithRedisCommander();

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

Redis Commander は、Node.js データベースの表示、編集、管理に使用される Redis Web アプリケーションです。 .NET .NET Aspire は、コマンダーアプリを実行する別のコンテナーイメージ docker.io/rediscommander/redis-commander をアプリホストに追加します。

アドバイス

RedisCommanderResource のホストポートを構成するには、WithHostPort API への呼び出しをチェーンし、目的のポート番号を指定します。

Redis リソースをデータボリュームとして追加する

Redis リソースにデータボリュームを追加するには、WithDataVolume リソースで Redis メソッドを呼び出します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddRedis("cache")
                   .WithDataVolume(isReadOnly: false);

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

データボリュームは、Redis データをコンテナーのライフサイクル外に保持するために使用されます。データボリュームは、/data コンテナー内の Redis パスにマウントされ、name パラメーターが指定されていない場合、名前はランダムに生成されます。データボリュームとその詳細、およびバインドマウントよりデータボリュームが優先される理由については、「ドキュメント: ボリューム」を参照してください。

データバインドマウントを持つ Redis リソースを追加する

Redis リソースにデータバインドマウントを追加するには、WithDataBindMount メソッドを呼び出します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddRedis("cache")
                   .WithDataBindMount(
                       source: @"C:\Redis\Data",
                       isReadOnly: false);

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

大事な

データバインドマウント、パフォーマンス、移植性、およびセキュリティが向上し、運用環境に適したボリュームと比較して機能が制限されています。ただし、バインドマウントを使用すると、ホストシステム上のファイルに直接アクセスして変更できるため、リアルタイムの変更が必要な開発とテストに最適です。

データバインドマウントは、ホストマシンのファイルシステムに依存して、コンテナーの再起動間に Redis データを保持します。データバインドマウントは、C:\Redis\Data コンテナー内のホストコンピューター上の Windows 上の /Redis/Data (または Unixの Redis) パスにマウントされます。データバインドマウントの詳細については、「Docker ドキュメント: バインドマウント」を参照してください。

Redis リソースを永続的に追加する

Redis リソースに永続化を追加するには、データボリュームまたはデータバインドマウントを使用して WithPersistence メソッドを呼び出します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddRedis("cache")
                   .WithDataVolume()
                   .WithPersistence(
                       interval: TimeSpan.FromMinutes(5),
                       keysChangedThreshold: 100);

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

上記のコードでは、指定した間隔としきい値で Redis データのスナップショットを取得することで、Redis リソースに永続化を追加します。 interval はスナップショットのエクスポートから keysChangedThreshold までの時間であり、スナップショットのトリガーに必要なキー変更操作の数です。永続化の詳細については、「Redis ドキュメント: 永続化の」を参照してください。

Garnet ホスティング統合では、Garnet リソースが GarnetResource の種類としてモデル化されます。この型および API にアクセスし、それを 📦Aspireに追加するには、アプリホストプロジェクトに Hosting.Garnet NuGet パッケージを含めます。

.NET コマンドラインインターフェース
PackageReference

dotnet add package Aspire.Hosting.Garnet

<PackageReference Include="Aspire.Hosting.Garnet"
                  Version="*" />

詳細については、「dotnet パッケージの追加」または「.NET アプリケーションでのパッケージの依存関係の管理」を参照してください。

Garnet リソースの追加

アプリホストプロジェクトで、AddGarnet インスタンスの builder を呼び出して、Garnet リソースを追加します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddGarnet("cache");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

.NET .NET Aspire 前の例で示したように、ghcr.io/microsoft/garnet イメージを使用してコンテナーイメージをアプリホストに追加すると、ローカルコンピューターに新しい Garnet インスタンスが作成されます。 Garnet リソース (cache 変数) への参照が ExampleProjectに追加されます。

アドバイス

既存の Garnet インスタンスに接続する場合は、代わりに AddConnectionString 呼び出します。詳細については、「既存のリソースを参照する」を参照してください。

データボリュームを使用して Garnet リソースを追加する

Garnet リソースにデータボリュームを追加するには、Garnet リソースで AddGarnet メソッドを呼び出します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddGarnet("cache")
                   .WithDataVolume(isReadOnly: false);

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

データボリュームは、コンテナーのライフサイクル外に Garnet データを保持するために使用されます。データボリュームは Garnet コンテナーの /data パスにマウントされ、name パラメーターが指定されていない場合、名前はランダムに生成されます。データボリュームとその詳細、およびバインドマウントよりデータボリュームが優先される理由については、「ドキュメント: ボリューム」を参照してください。

データバインドマウントを使用して Garnet リソースを追加する

Garnet リソースにデータバインドマウントを追加するには、WithDataBindMount メソッドを呼び出します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddGarnet("cache")
                   .WithDataBindMount(
                       source: @"C:\Garnet\Data",
                       isReadOnly: false);

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

大事な

データバインドマウントは、コンテナーの再起動の間に Garnet データを保持するために、ホストマシンのファイルシステムに依存します。データバインドマウントは、Garnet コンテナー内のホストコンピューター上の Windows 上の C:\Garnet\Data (または /Garnet/Dataの Unix) パスにマウントされます。データバインドマウントの詳細については、「Docker ドキュメント: バインドマウント」を参照してください。

永続化を使用して Garnet リソースを追加する

Garnet リソースに永続化を追加するには、データボリュームまたはデータバインドマウントを使用して WithPersistence メソッドを呼び出します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddGarnet("cache")
                   .WithDataVolume()
                   .WithPersistence(
                       interval: TimeSpan.FromMinutes(5),
                       keysChangedThreshold: 100);

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

上記のコードでは、指定された間隔としきい値で Garnet データのスナップショットを取得することで、Redis リソースに永続化を追加します。 interval はスナップショットのエクスポートから keysChangedThreshold までの時間であり、スナップショットのトリガーに必要なキー変更操作の数です。永続化の詳細については、「Redis ドキュメント: 永続化の」を参照してください。

Valkey ホスティング統合では、Valkey リソースが ValkeyResource の種類としてモデル化されます。この型と、APIを追加できる📦Aspireにアクセスするには、アプリホストプロジェクト内のHosting.Valkey NuGetパッケージを使用します。

.NET コマンドラインインターフェース
PackageReference

dotnet add package Aspire.Hosting.Valkey

<PackageReference Include="Aspire.Hosting.Valkey"
                  Version="*" />

詳細については、「dotnet パッケージの追加」または「.NET アプリケーションでのパッケージの依存関係の管理」を参照してください。

Valkey リソースの追加

アプリホストプロジェクトで、AddValkey インスタンスの builder を呼び出して Valkey リソースを追加します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddValkey("cache");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

.NET .NET Aspire 前の例で示したように、docker.io/valkey/valkey イメージを使用してコンテナーイメージをアプリホストに追加すると、ローカルコンピューターに新しい Valkey インスタンスが作成されます。 Valkey リソース (cache 変数) への参照が ExampleProjectに追加されます。

アドバイス

既存の Valkey インスタンスに接続する場合は、代わりに AddConnectionString を呼び出します。詳細については、「既存のリソースを参照する」を参照してください。

データボリュームを使用して Valkey リソースを追加する

Valkey リソースにデータボリュームを追加するには、Valkey リソースで AddValkey メソッドを呼び出します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddValkey("cache")
                   .WithDataVolume(isReadOnly: false);

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

データボリュームは、コンテナーのライフサイクル外に Valkey データを保持するために使用されます。データボリュームは Valkey コンテナーの /data パスにマウントされ、name パラメーターが指定されていない場合、名前はランダムに生成されます。データボリュームとその詳細、およびバインドマウントよりデータボリュームが優先される理由については、「ドキュメント: ボリューム」を参照してください。

データバインドマウントを使用して Valkey リソースを追加する

Valkey リソースにデータバインドマウントを追加するには、WithDataBindMount メソッドを呼び出します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddValkey("cache")
                   .WithDataBindMount(
                       source: @"C:\Valkey\Data",
                       isReadOnly: false);

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

大事な

データバインドマウントは、コンテナーの再起動の間に Valkey データを保持するために、ホストマシンのファイルシステムに依存します。データバインドマウントは、Valkey コンテナー内のホストコンピューター上の Windows 上の C:\Valkey\Data (または /Valkey/Data上の Unix) パスにマウントされます。データバインドマウントの詳細については、「Docker ドキュメント: バインドマウント」を参照してください。

永続化を伴う Valkey リソースを追加する

Valkey リソースに永続化を追加するには、データボリュームまたはデータバインドマウントを使用して WithPersistence メソッドを呼び出します。

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddValkey("cache")
                   .WithDataVolume()
                   .WithPersistence(
                       interval: TimeSpan.FromMinutes(5),
                       keysChangedThreshold: 100);

builder.AddProject<Projects.ExampleProject>()
       .WithReference(cache);

// After adding all resources, run the app...

上記のコードでは、指定した間隔としきい値で Valkey データのスナップショットを取得することで、Redis リソースに永続化を追加します。 interval はスナップショットのエクスポートから keysChangedThreshold までの時間であり、スナップショットのトリガーに必要なキー変更操作の数です。永続化の詳細については、「Redis ドキュメント: 永続化の」を参照してください。

ホスティング統合の正常性チェック

Redis ホスティング統合により、適切なリソースの種類の正常性チェックが自動的に追加されます。正常性チェックでは、サーバーが実行中であり、サーバーへの接続を確立できることを確認します。

ホスティング統合は、📦 AspNetCore.HealthChecks NuGetパッケージRedis に依存します。

Client 統合

.NET Aspire Stack Exchange Redis 出力キャッシュクライアントの統合を開始するには、📦Aspire.StackExchange.Redis.OutputCaching. NuGet パッケージを、出力キャッシュクライアントを利用するアプリケーションのプロジェクトにインストールします。 Redis 出力キャッシュクライアント統合では、CacheOutput メソッド呼び出しを有効にするのに必要なサービスを登録し、[OutputCache] Redis。

.NET コマンドラインインターフェース
PackageReference

dotnet add package Aspire.StackExchange.Redis.OutputCaching

<PackageReference Include="Aspire.StackExchange.Redis.OutputCache"
                  Version="*" />

出力キャッシュを追加する

クライアントを使用するプロジェクトの Program.cs ファイルで、任意の AddRedisOutputCache で IHostApplicationBuilder 拡張メソッドを呼び出して、出力キャッシュに必要なサービスを登録します。

builder.AddRedisOutputCache(connectionName: "cache");

アドバイス

connectionName パラメーターは、アプリホストプロジェクトに Redis リソースを追加するときに使用する名前と一致する必要があります。詳細については、「リソースをに追加する」を参照してください。

アドバイス

connectionName パラメーターは、アプリホストプロジェクトで Garnet リソースを追加するときに使用する名前と一致する必要があります。詳細については、「Garnet リソースの追加」を参照してください。

アドバイス

connectionName パラメーターは、アプリホストプロジェクトで Valkey リソースを追加するときに使用する名前と一致する必要があります。詳細については、「Valkey リソースの追加」を参照してください。

UseOutputCache(IApplicationBuilder)を呼び出して、ミドルウェアを要求処理パイプラインに追加します。

var app = builder.Build();

app.UseOutputCache();

最小限 API アプリの場合は、次の例に示すように、CacheOutputを呼び出すか、OutputCacheAttributeを適用してキャッシュを実行するようにエンドポイントを構成します。

app.MapGet("/cached", () => "Hello world!")
   .CacheOutput();

app.MapGet(
    "/attribute",
    [OutputCache] () => "Hello world!");

コントローラーがあるアプリの場合は、アクションメソッドに [OutputCache] 属性を適用します。 Razor Pages アプリの場合は、Razor ページクラスに属性を適用します。

構成

.NET Aspire Stack Exchange Redis 出力キャッシュ統合には、プロジェクトの要件と規則に基づいて Redis 接続を構成するための複数のオプションが用意されています。

接続文字列を使用する

ConnectionStrings 構成セクションの接続文字列を使用する場合は、AddRedisOutputCacheを呼び出すときに接続文字列の名前を指定できます。

builder.AddRedisOutputCache(connectionName: "cache");

その後、接続文字列は ConnectionStrings 構成セクションから取得されます。

{
  "ConnectionStrings": {
    "cache": "localhost:6379"
  }
}

この接続文字列の書式を設定する方法の詳細については、Stack Exchange Redis 構成ドキュメントを参照してください。

構成プロバイダーを使用する

.NET Aspire Stack Exchange Redis 出力キャッシュ統合では、Microsoft.Extensions.Configurationがサポートされます。 StackExchangeRedisSettings キーを使用して、構成から Aspire:StackExchange:Redis を読み込みます。いくつかのオプションを構成する appsettings.json の例:

{
  "Aspire": {
    "StackExchange": {
      "Redis": {
        "ConfigurationOptions": {
          "ConnectTimeout": 3000,
          "ConnectRetry": 2
        },
        "DisableHealthChecks": true,
        "DisableTracing": false
      }
    }
  }
}

完全な Redis 出力キャッシュクライアント統合 JSON スキーマについては、AspireStackExchangeRedisOutputCaching/ConfigurationSchema.jsonを参照してください。

インラインデリゲートを使用する

Action<StackExchangeRedisSettings> configurationSettings デリゲートを渡して、コードから正常性チェックを無効にするなど、一部またはすべてのオプションをインラインで設定することもできます。

builder.AddRedisOutputCache(
    "cache",
    static settings => settings.DisableHealthChecks  = true);

メソッドの Action<ConfigurationOptions> configureOptions デリゲートパラメーターを使用して、AddRedisOutputCache を設定することもできます。たとえば、接続タイムアウトを設定するには、次のようにします。

builder.AddRedisOutputCache(
    "cache",
    static settings => settings.ConnectTimeout = 3_000);

Client 統合ヘルスチェック

既定では、.NET.NET Aspireクライアント統合すべてのサービスで正常性チェック有効になっています。同様に、多くの .NET.NET Aspireホスティング統合もヘルスチェックエンドポイントを有効にします。詳細については、以下を参照してください。

C#でのアプリ正常性チェック .NET
ASP.NET Core での正常性チェック

.NET Aspire Stack Exchange Redis 出力キャッシュ統合では、次の処理が行われます。

StackExchangeRedisSettings.DisableHealthChecks が falseされたときに正常性チェックを追加します。これは、コンテナーインスタンスへの接続を試みます。
/health HTTP エンドポイントと統合されます。このエンドポイントは、アプリがトラフィックを受け入れる準備ができていると見なされるために、登録されているすべての正常性チェックに合格する必要があります。

可観測性とテレメトリ

統合により、ログ記録、トレース、メトリックの構成が自動的に設定されます。これは、監視の柱とも呼ばれます。統合の可観測性とテレメトリの詳細については、統合の概要参照してください。バッキングサービスによっては、一部の統合でこれらの機能の一部のみがサポートされる場合があります。たとえば、一部の統合ではログ記録とトレースがサポートされますが、メトリックはサポートされません。テレメトリ機能は、「構成」セクションに記載されている手法を使用して無効にすることもできます。

伐採

.NET Aspire Stack Exchange Redis 出力キャッシュ統合では、次のログカテゴリが使用されます。

Aspire.StackExchange.Redis
Microsoft.AspNetCore.OutputCaching.StackExchangeRedis

トレーシング

.NET Aspire Stack Exchange Redis 出力キャッシュ統合では、OpenTelemetryを使用して次のトレースアクティビティが出力されます。

OpenTelemetry.Instrumentation.StackExchangeRedis

メトリック

.NET Aspire Stack Exchange Redis 出力キャッシュ統合では、現在、StackExchange.Redis ライブラリの制限により、メトリックが既定でサポートされていません。

次の方法で共有

.NET Aspire Redis ^* 出力キャッシュ統合 ®

ホスティング統合

リソース Redisを追加する

Redis Insights を使用してリソース Redis 追加する

Redis リソースをRedis コマンダーで追加する

Redis リソースをデータボリュームとして追加する

データバインドマウントを持つ Redis リソースを追加する

Redis リソースを永続的に追加する

Garnet リソースの追加

データボリュームを使用して Garnet リソースを追加する

データバインドマウントを使用して Garnet リソースを追加する

永続化を使用して Garnet リソースを追加する

Valkey リソースの追加

データボリュームを使用して Valkey リソースを追加する

データバインドマウントを使用して Valkey リソースを追加する

永続化を伴う Valkey リソースを追加する

ホスティング統合の正常性チェック

Client 統合

出力キャッシュを追加する

構成

接続文字列を使用する

構成プロバイダーを使用する

インラインデリゲートを使用する

Client 統合ヘルスチェック

可観測性とテレメトリ

伐採

トレーシング

メトリック

関連項目

その他のリソース

次の方法で共有

.NET Aspire Redis * 出力キャッシュ統合 ®

ホスティング統合

リソース Redisを追加する

Redis Insights を使用してリソース Redis 追加する

Redis リソースをRedis コマンダーで追加する

Redis リソースをデータ ボリュームとして追加する

データバインドマウントを持つ Redis リソースを追加する

Redis リソースを永続的に追加する

Garnet リソースの追加

データ ボリュームを使用して Garnet リソースを追加する

データ バインド マウントを使用して Garnet リソースを追加する

永続化を使用して Garnet リソースを追加する

Valkey リソースの追加

データ ボリュームを使用して Valkey リソースを追加する

データ バインド マウントを使用して Valkey リソースを追加する

永続化を伴う Valkey リソースを追加する

ホスティング統合の正常性チェック

Client 統合

出力キャッシュを追加する

構成

接続文字列を使用する

構成プロバイダーを使用する

インライン デリゲートを使用する

Client 統合ヘルスチェック

可観測性とテレメトリ

伐採

トレーシング

メトリック

関連項目

その他のリソース

.NET Aspire Redis ^* 出力キャッシュ統合 ®

Redis リソースをデータボリュームとして追加する

データボリュームを使用して Garnet リソースを追加する

データバインドマウントを使用して Garnet リソースを追加する

データボリュームを使用して Valkey リソースを追加する

データバインドマウントを使用して Valkey リソースを追加する

インラインデリゲートを使用する